Amazon Web Services, Inc.

Auto Scaling

Amazon EC2 Auto Scaling The DescribeAutoScalingGroups API operation might be throttled when retrieving details for an Auto Scaling group that contains many…

Developer tools#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon EC2 Auto Scaling
The DescribeAutoScalingGroups API operation might be throttled when retrieving details for an Auto Scaling group that contains many instances. By default, this operation returns details for all instances in the group.
To help prevent throttling, you can set the IncludeInstances parameter to false to exclude instance details from the response.
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances
based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference .

Endpoints 68

  • POSTAttach instances/#Action=AttachInstances?Action=AttachInstances&Version=2011-01-01Attaches one or more EC2 instances to the specified Auto Scaling group. When you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of…
  • POSTAttach load balancer target groups/#Action=AttachLoadBalancerTargetGroups?Action=AttachLoadBalancerTargetGroups&Version=2011-01-01This API operation is superseded by AttachTrafficSources , which can attach multiple traffic sources types. We recommend using AttachTrafficSources to…
  • POSTAttach load balancers/#Action=AttachLoadBalancers?Action=AttachLoadBalancers&Version=2011-01-01This API operation is superseded by AttachTrafficSources , which can attach multiple traffic sources types. We recommend using AttachTrafficSources to…
  • POSTAttach traffic sources/#Action=AttachTrafficSources?Action=AttachTrafficSources&Version=2011-01-01Attaches one or more traffic sources to the specified Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group:…
  • POSTBatch delete scheduled action/#Action=BatchDeleteScheduledAction?Action=BatchDeleteScheduledAction&Version=2011-01-01Deletes one or more scheduled actions for the specified Auto Scaling group.
  • POSTBatch put scheduled update group action/#Action=BatchPutScheduledUpdateGroupAction?Action=BatchPutScheduledUpdateGroupAction&Version=2011-01-01Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
  • POSTCancel instance refresh/#Action=CancelInstanceRefresh?Action=CancelInstanceRefresh&Version=2011-01-01Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound error…
  • POSTComplete lifecycle action/#Action=CompleteLifecycleAction?Action=CompleteLifecycleAction&Version=2011-01-01Completes the lifecycle action for the specified token or instance with the specified result. This step is a part of the procedure for adding a lifecycle hook…
  • POSTCreate auto scaling group/#Action=CreateAutoScalingGroup?Action=CreateAutoScalingGroup&Version=2011-01-01We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Creates an…
  • POSTCreate launch configuration/#Action=CreateLaunchConfiguration?Action=CreateLaunchConfiguration&Version=2011-01-01Creates a launch configuration. If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits…
  • POSTCreate or update tags/#Action=CreateOrUpdateTags?Action=CreateOrUpdateTags&Version=2011-01-01Creates or updates tags for the specified Auto Scaling group. When you specify a tag with a key that already exists, the operation overwrites the previous tag…
  • POSTDelete auto scaling group/#Action=DeleteAutoScalingGroup?Action=DeleteAutoScalingGroup&Version=2011-01-01Deletes the specified Auto Scaling group. If the group has instances or scaling activities in progress, you must specify the option to force the deletion in…
  • POSTDelete launch configuration/#Action=DeleteLaunchConfiguration?Action=DeleteLaunchConfiguration&Version=2011-01-01Deletes the specified launch configuration. The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch…
  • POSTDelete lifecycle hook/#Action=DeleteLifecycleHook?Action=DeleteLifecycleHook&Version=2011-01-01Deletes the specified lifecycle hook. If there are any outstanding lifecycle actions, they are completed first ( ABANDON for launching instances, CONTINUE for…
  • POSTDelete notification configuration/#Action=DeleteNotificationConfiguration?Action=DeleteNotificationConfiguration&Version=2011-01-01Deletes the specified notification.
  • POSTDelete policy/#Action=DeletePolicy?Action=DeletePolicy&Version=2011-01-01Deletes the specified scaling policy. Deleting either a step scaling policy or a simple scaling policy deletes the underlying alarm action, but does not…
  • POSTDelete scheduled action/#Action=DeleteScheduledAction?Action=DeleteScheduledAction&Version=2011-01-01Deletes the specified scheduled action.
  • POSTDelete tags/#Action=DeleteTags?Action=DeleteTags&Version=2011-01-01Deletes the specified tags.
  • POSTDelete warm pool/#Action=DeleteWarmPool?Action=DeleteWarmPool&Version=2011-01-01Deletes the warm pool for the specified Auto Scaling group. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling…
  • POSTDescribe account limits/#Action=DescribeAccountLimits?Action=DescribeAccountLimits&Version=2011-01-01Describes the current Amazon EC2 Auto Scaling resource quotas for your account. When you establish an Amazon Web Services account, the account has initial…
  • POSTDescribe account settings/#Action=DescribeAccountSettings?Action=DescribeAccountSettings&Version=2011-01-01Describes the current Amazon EC2 Auto Scaling account settings for your account. Account settings are a framework that allows you to enable or disable…
  • POSTDescribe adjustment types/#Action=DescribeAdjustmentTypes?Action=DescribeAdjustmentTypes&Version=2011-01-01Describes the available adjustment types for step scaling and simple scaling policies. The following adjustment types are supported: ChangeInCapacity…
  • POSTDescribe auto scaling groups/#Action=DescribeAutoScalingGroups?Action=DescribeAutoScalingGroups&Version=2011-01-01Gets information about the Auto Scaling groups in the account and Region. If you specify Auto Scaling group names, the output includes information for only…
  • POSTDescribe auto scaling instances/#Action=DescribeAutoScalingInstances?Action=DescribeAutoScalingInstances&Version=2011-01-01Gets information about the Auto Scaling instances in the account and Region.
  • POSTDescribe auto scaling notification types/#Action=DescribeAutoScalingNotificationTypes?Action=DescribeAutoScalingNotificationTypes&Version=2011-01-01Describes the notification types that are supported by Amazon EC2 Auto Scaling.
  • POSTDescribe instance refreshes/#Action=DescribeInstanceRefreshes?Action=DescribeInstanceRefreshes&Version=2011-01-01Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks. This operation is part of the instance refresh…
  • POSTDescribe launch configurations/#Action=DescribeLaunchConfigurations?Action=DescribeLaunchConfigurations&Version=2011-01-01Gets information about the launch configurations in the account and Region.
  • POSTDescribe lifecycle hook types/#Action=DescribeLifecycleHookTypes?Action=DescribeLifecycleHookTypes&Version=2011-01-01Describes the available types of lifecycle hooks. The following hook types are supported: autoscaling:EC2_INSTANCE_LAUNCHING…
  • POSTDescribe lifecycle hooks/#Action=DescribeLifecycleHooks?Action=DescribeLifecycleHooks&Version=2011-01-01Gets information about the lifecycle hooks for the specified Auto Scaling group.
  • POSTDescribe load balancer target groups/#Action=DescribeLoadBalancerTargetGroups?Action=DescribeLoadBalancerTargetGroups&Version=2011-01-01This API operation is superseded by DescribeTrafficSources , which can describe multiple traffic sources types. We recommend using DetachTrafficSources to…
  • POSTDescribe load balancers/#Action=DescribeLoadBalancers?Action=DescribeLoadBalancers&Version=2011-01-01This API operation is superseded by DescribeTrafficSources , which can describe multiple traffic sources types. We recommend using DescribeTrafficSources to…
  • POSTDescribe metric collection types/#Action=DescribeMetricCollectionTypes?Action=DescribeMetricCollectionTypes&Version=2011-01-01Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
  • POSTDescribe notification configurations/#Action=DescribeNotificationConfigurations?Action=DescribeNotificationConfigurations&Version=2011-01-01Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
  • POSTDescribe policies/#Action=DescribePolicies?Action=DescribePolicies&Version=2011-01-01Gets information about the scaling policies in the account and Region.
  • POSTDescribe scaling activities/#Action=DescribeScalingActivities?Action=DescribeScalingActivities&Version=2011-01-01Gets information about the scaling activities in the account and Region. When scaling events occur, you see a record of the scaling activity in the scaling…
  • POSTDescribe scaling process types/#Action=DescribeScalingProcessTypes?Action=DescribeScalingProcessTypes&Version=2011-01-01Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
  • POSTDescribe scheduled actions/#Action=DescribeScheduledActions?Action=DescribeScheduledActions&Version=2011-01-01Gets information about the scheduled actions that haven't run or that have not reached their end time. To describe the scaling activities for scheduled…
  • POSTDescribe tags/#Action=DescribeTags?Action=DescribeTags&Version=2011-01-01Describes the specified tags. You can use filters to limit the results. For example, you can query for the tags for a specific Auto Scaling group. You can…
  • POSTDescribe termination policy types/#Action=DescribeTerminationPolicyTypes?Action=DescribeTerminationPolicyTypes&Version=2011-01-01Describes the termination policies supported by Amazon EC2 Auto Scaling. For more information, see Configure termination policies for Amazon EC2 Auto Scaling…
  • POSTDescribe traffic sources/#Action=DescribeTrafficSources?Action=DescribeTrafficSources&Version=2011-01-01Gets information about the traffic sources for the specified Auto Scaling group. You can optionally provide a traffic source type. If you provide a traffic…
  • POSTDescribe warm pool/#Action=DescribeWarmPool?Action=DescribeWarmPool&Version=2011-01-01Gets information about a warm pool and its instances. For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User…
  • POSTDetach instances/#Action=DetachInstances?Action=DetachInstances&Version=2011-01-01Removes one or more instances from the specified Auto Scaling group. After the instances are detached, you can manage them independent of the Auto Scaling…
  • POSTDetach load balancer target groups/#Action=DetachLoadBalancerTargetGroups?Action=DetachLoadBalancerTargetGroups&Version=2011-01-01This API operation is superseded by DetachTrafficSources , which can detach multiple traffic sources types. We recommend using DetachTrafficSources to…
  • POSTDetach load balancers/#Action=DetachLoadBalancers?Action=DetachLoadBalancers&Version=2011-01-01This API operation is superseded by DetachTrafficSources , which can detach multiple traffic sources types. We recommend using DetachTrafficSources to…
  • POSTDetach traffic sources/#Action=DetachTrafficSources?Action=DetachTrafficSources&Version=2011-01-01Detaches one or more traffic sources from the specified Auto Scaling group. When you detach a traffic source, it enters the Removing state while deregistering…
  • POSTDisable metrics collection/#Action=DisableMetricsCollection?Action=DisableMetricsCollection&Version=2011-01-01Disables group metrics collection for the specified Auto Scaling group.
  • POSTEnable metrics collection/#Action=EnableMetricsCollection?Action=EnableMetricsCollection&Version=2011-01-01Enables group metrics collection for the specified Auto Scaling group. You can use these metrics to track changes in an Auto Scaling group and to set alarms…
  • POSTEnter standby/#Action=EnterStandby?Action=EnterStandby&Version=2011-01-01Moves the specified instances into the standby state. If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter…
  • POSTExecute policy/#Action=ExecutePolicy?Action=ExecutePolicy&Version=2011-01-01Executes the specified policy. This can be useful for testing the design of your scaling policy.
  • POSTExit standby/#Action=ExitStandby?Action=ExitStandby&Version=2011-01-01Moves the specified instances out of the standby state. After you put the instances back in service, the desired capacity is incremented. For more…
  • POSTGet predictive scaling forecast/#Action=GetPredictiveScalingForecast?Action=GetPredictiveScalingForecast&Version=2011-01-01Retrieves the forecast data for a predictive scaling policy. Load forecasts are predictions of the hourly load values using historical load data from…
  • POSTLaunch instances/#Action=LaunchInstances?Action=LaunchInstances&Version=2011-01-01Launches a specified number of instances in an Auto Scaling group. Returns instance IDs and other details if launch is successful or error details if launch…
  • POSTPut account setting/#Action=PutAccountSetting?Action=PutAccountSetting&Version=2011-01-01Modifies an account setting for your account. You can use this operation to opt in or opt out of features provided through account settings when permitted.…
  • POSTPut lifecycle hook/#Action=PutLifecycleHook?Action=PutLifecycleHook&Version=2011-01-01Creates or updates a lifecycle hook for the specified Auto Scaling group. Lifecycle hooks let you create solutions that are aware of events in the Auto…
  • POSTPut notification configuration/#Action=PutNotificationConfiguration?Action=PutNotificationConfiguration&Version=2011-01-01Configures an Auto Scaling group to send notifications when specified events take place. Subscribers to the specified topic can have messages delivered to an…
  • POSTPut scaling policy/#Action=PutScalingPolicy?Action=PutScalingPolicy&Version=2011-01-01Creates or updates a scaling policy for an Auto Scaling group. Scaling policies are used to scale an Auto Scaling group based on configurable metrics. If no…
  • POSTPut scheduled update group action/#Action=PutScheduledUpdateGroupAction?Action=PutScheduledUpdateGroupAction&Version=2011-01-01Creates or updates a scheduled scaling action for an Auto Scaling group. For more information, see Scheduled scaling in the Amazon EC2 Auto Scaling User Guide…
  • POSTPut warm pool/#Action=PutWarmPool?Action=PutWarmPool&Version=2011-01-01Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto…
  • POSTRecord lifecycle action heartbeat/#Action=RecordLifecycleActionHeartbeat?Action=RecordLifecycleActionHeartbeat&Version=2011-01-01Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the…
  • POSTResume processes/#Action=ResumeProcesses?Action=ResumeProcesses&Version=2011-01-01Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group. For more information, see Suspend and…
  • POSTRollback instance refresh/#Action=RollbackInstanceRefresh?Action=RollbackInstanceRefresh&Version=2011-01-01Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced…
  • POSTSet desired capacity/#Action=SetDesiredCapacity?Action=SetDesiredCapacity&Version=2011-01-01Sets the size of the specified Auto Scaling group. If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current…
  • POSTSet instance health/#Action=SetInstanceHealth?Action=SetInstanceHealth&Version=2011-01-01Sets the health status of the specified instance. For more information, see Set up a custom health check for your Auto Scaling group in the Amazon EC2 Auto…
  • POSTSet instance protection/#Action=SetInstanceProtection?Action=SetInstanceProtection&Version=2011-01-01Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool. For more information, see…
  • POSTStart instance refresh/#Action=StartInstanceRefresh?Action=StartInstanceRefresh&Version=2011-01-01Starts an instance refresh. This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto…
  • POSTSuspend processes/#Action=SuspendProcesses?Action=SuspendProcesses&Version=2011-01-01Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group. If you suspend either the Launch or Terminate process…
  • POSTTerminate instance in auto scaling group/#Action=TerminateInstanceInAutoScalingGroup?Action=TerminateInstanceInAutoScalingGroup&Version=2011-01-01Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool. This call simply…
  • POSTUpdate auto scaling group/#Action=UpdateAutoScalingGroup?Action=UpdateAutoScalingGroup&Version=2011-01-01We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Updates the…

API details

Base URL
https://autoscaling.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
68 operations on 68 pathsPOST 68
Description format
AWS Smithy model, API version 2011-01-01

How to test the Auto Scaling in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Auto Scaling collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Attach instances” (POST /#Action=AttachInstances?Action=AttachInstances&Version=2011-01-01), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Auto Scaling?

Amazon EC2 Auto Scaling The DescribeAutoScalingGroups API operation might be throttled when retrieving details for an Auto Scaling group that contains many… It is listed under Developer tools and has 68 endpoints.

Who publishes the Auto Scaling?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Auto Scaling?

Requests go to https://autoscaling.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Auto Scaling?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Auto Scaling have?

68 operations on 68 paths (68 POST).

Is forking the Auto Scaling free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.