API Reference API Version 2016-02-06 - AWS …

1 Application Auto ScalingAPI ReferenceAPI Version 2016-02-06 Application Auto Scaling API ReferenceApplication Auto Scaling: API ReferenceCopyright 2019 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is notAmazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages ordiscredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who mayor may not be affiliated with, connected to, or sponsored by Auto Scaling API ReferenceTable of ContentsWelcome .. 1 Actions .. 2 DeleteScalingPolicy .. 3 Request Syntax .. 3 Request Parameters .. 3 Response Elements .. 5 Errors .. 5 Example.. 5 See Also.. 6 DeleteScheduledAction .. 7 Request Syntax .. 7 Request Parameters.

2 7 Response Elements .. 9 Errors .. 9 See Also.. 9 DeregisterScalableTarget .. 10 Request Syntax .. 10 Request Parameters .. 10 Response Elements .. 11 Errors .. 11 Example.. 12 See Also.. 12 DescribeScalableTargets .. 14 Request Syntax .. 14 Request Parameters .. 14 Response Syntax .. 16 Response Elements .. 16 Errors .. 17 Example.. 17 See Also.. 18 DescribeScalingActivities .. 19 Request Syntax .. 19 Request Parameters .. 19 Response Syntax .. 21 Response Elements .. 21 Errors .. 22 Examples.. 22 See Also.. 25 DescribeScalingPolicies .. 26 Request Syntax .. 26 Request Parameters .. 26 Response Syntax .. 28 Response Elements .. 29 Errors .. 29 Example.. 30 See Also.. 32 DescribeScheduledActions .. 33 Request Syntax .. 33 Request Parameters .. 33 Response Syntax .. 35 Response Elements.

3 35 Errors .. 36 See Also.. 36 PutScalingPolicy .. 38 API Version 2016-02-06iiiApplication Auto Scaling API ReferenceRequest Syntax .. 38 Request Parameters .. 39 Response Syntax .. 41 Response Elements .. 41 Errors .. 42 Examples.. 42 See Also.. 45 PutScheduledAction .. 47 Request Syntax .. 47 Request Parameters .. 47 Response Elements .. 50 Errors .. 50 See Also.. 50 RegisterScalableTarget .. 52 Request Syntax .. 52 Request Parameters .. 52 Response Elements .. 55 Errors .. 55 Example.. 55 See Also.. 56 Data Types .. 57 Alarm.. 58 Contents.. 58 See Also.. 58 CustomizedMetricSpecification .. 59 Contents.. 59 See Also.. 60 MetricDimension.. 61 Contents.. 61 See Also.. 61 PredefinedMetricSpecification .. 62 Contents.. 62 See Also.. 62 ScalableTarget .. 63 Contents.. 63 See Also.. 65 ScalableTargetAction.

4 66 Contents.. 66 See Also.. 66 ScalingActivity .. 67 Contents.. 67 See Also.. 69 ScalingPolicy .. 70 Contents.. 70 See Also.. 72 ScheduledAction .. 73 Contents.. 73 See Also.. 75 StepAdjustment .. 76 Contents.. 76 See Also.. 77 StepScalingPolicyConfiguration .. 78 Contents.. 78 See Also.. 79 SuspendedState.. 80 Contents.. 80 See Also.. 80 API Version 2016-02-06ivApplication Auto Scaling API ReferenceTargetTrackingScalingPolicyConf iguration .. 81 Contents.. 81 See Also.. 82 Common Parameters .. 83 Common Errors .. 85 Logging API Calls with CloudTrail .. 87 Application Auto Scaling Information in CloudTrail .. 87 Understanding Application Auto Scaling Log File Entries.. 88.. 88 API Version 2016-02-06vApplication Auto Scaling API ReferenceWelcomeThis is the Application Auto Scaling API Reference . With Application Auto Scaling, you can configureautomatic scaling for the following resources: Amazon ECS services Amazon EC2 Spot Fleet requests Amazon EMR clusters Amazon AppStream fleets Amazon DynamoDB tables and global secondary indexes throughput capacity Amazon Aurora Replicas Amazon SageMaker endpoint variants Custom resources provided by your own applications or servicesAPI SummaryThe Application Auto Scaling service API includes three key sets of actions: Register and manage scalable targets - Register AWS or custom resources as scalable targets (aresource that Application Auto Scaling can scale), set minimum and maximum capacity limits, andretrieve information on existing scalable targets.

5 Configure and manage automatic scaling - Define scaling policies to dynamically scale your resourcesin response to CloudWatch alarms, schedule one-time or recurring scaling actions, and retrieve yourrecent scaling activity history. Suspend and resume scaling - Temporarily suspend and later resume automatic scaling by callingthe RegisterScalableTarget (p. 52) action for any Application Auto Scaling scalable target. You cansuspend and resume, individually or in combination, scale-out activities triggered by a scaling policy,scale-in activities triggered by a scaling policy, and scheduled documentation for each action shows the Query API request syntax, the request parameters, and theresponse elements and provides links to language-specific SDK Reference topics. For more information,see AWS learn more about Application Auto Scaling, including information about granting IAM users requiredpermissions for Application Auto Scaling actions, see the Application Auto Scaling User document was last published on November 6, Version 2016-02-061 Application Auto Scaling API ReferenceActionsThe following actions are supported: DeleteScalingPolicy (p.)

6 3) DeleteScheduledAction (p. 7) DeregisterScalableTarget (p. 10) DescribeScalableTargets (p. 14) DescribeScalingActivities (p. 19) DescribeScalingPolicies (p. 26) DescribeScheduledActions (p. 33) PutScalingPolicy (p. 38) PutScheduledAction (p. 47) RegisterScalableTarget (p. 52)API Version 2016-02-062 Application Auto Scaling API ReferenceDeleteScalingPolicyDeleteScalin gPolicyDeletes the specified scaling policy for an Application Auto Scaling scalable a step scaling policy deletes the underlying alarm action, but does not delete the CloudWatchalarm associated with the scaling policy, even if it no longer has an associated more information, see Delete a Step Scaling Policy and Delete a Target Tracking Scaling Policy in theApplication Auto Scaling User create a scaling policy or update an existing one, see PutScalingPolicy (p. 38).Request Syntax{ "PolicyName": "string", "ResourceId": "string", "ScalableDimension": "string", "ServiceNamespace": "string"}Request ParametersFor information about the parameters that are common to all actions, see CommonParameters (p.

7 83).The request accepts the following data in JSON (p. 3)The name of the scaling : StringLength Constraints: Minimum length of 1. Maximum length of : [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00- \uDBFF\uDFFF\r\n\t]*Required: YesResourceId (p. 3)The identifier of the resource associated with the scalable target. This string consists of the resourcetype and unique identifier. ECS service - The resource type is service and the unique identifier is the cluster name andservice name. Example: service/default/sample-webapp. Spot Fleet request - The resource type is spot-fleet-request and the uniqueidentifier is the Spot Fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494 c-8788-1cee4 EXAMPLE. EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID andinstance group ID. Example: instancegroup/j-2 EEZNYKUA1 NTV/ig-1791Y4E1L8YI0.

8 AppStream fleet - The resource type is fleet and the unique identifier is the fleet : fleet/sample-fleet. DynamoDB table - The resource type is table and the unique identifier is the resource : table/my-table. DynamoDB global secondary index - The resource type is index and the unique identifier is theresource ID. Example: table/my-table/ Version 2016-02-063 Application Auto Scaling API ReferenceRequest Parameters Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster : cluster:my-db-cluster. Amazon SageMaker endpoint variants - The resource type is variant and the unique identifier isthe resource ID. Example: endpoint/my-end-point/variant/KMeansClus tering. Custom resources are not supported with a resource type. This parameter must specify theOutputValue from the CloudFormation template stack used to access the resources.

9 The uniqueidentifier is defined by the service provider. More information is available in our GitHub : StringLength Constraints: Minimum length of 1. Maximum length of : [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00- \uDBFF\uDFFF\r\n\t]*Required: YesScalableDimension (p. 3)The scalable dimension. This string consists of the service namespace, resource type, and scalingproperty. ecs:service:DesiredCount - The desired task count of an ECS service. ec2:spot-fleet-request:TargetCapacity - The target capacity of a Spot Fleet request. elasticmapreduce:instancegroup:InstanceC ount - The instance count of an EMRI nstance Group. appstream:fleet:DesiredCapacity - The desired capacity of an AppStream fleet. dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table. dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDBtable.

10 Dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB globalsecondary index. dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDBglobal secondary index. rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition. sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an AmazonSageMaker model endpoint variant. custom-resource:ResourceType:Property - The scalable dimension for a custom resourceprovided by your own application or : StringValid Values: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceC ount| appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits| dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits| dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount| sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:PropertyReq uired: YesServiceNamespace (p.)