Menu
Application Auto Scaling
API Reference (API Version 2016-02-06)

DescribeScalingActivities

Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.

You can filter the results using the ResourceId and ScalableDimension parameters.

Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see DescribeScalingPolicies. To create a scaling policy or update an existing one, see PutScalingPolicy.

Request Syntax

{ "MaxResults": number, "NextToken": "string", "ResourceId": "string", "ScalableDimension": "string", "ServiceNamespace": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of scalable target results. This value can be between 1 and 50. The default value is 50.

If this parameter is used, the operation returns up to MaxResults results at a time, along with a NextToken value. To get the next set of results, include the NextToken value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a NextToken value, if applicable.

Type: Integer

Required: No

NextToken

The token for the next set of results.

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

ResourceId

The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.

  • ECS service - The resource type is service and the unique identifier is the cluster name and service name. Example: service/default/sample-webapp.

  • Spot fleet request - The resource type is spot-fleet-request and the unique identifier is the Spot fleet request ID. Example: spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE.

  • EMR cluster - The resource type is instancegroup and the unique identifier is the cluster ID and instance group ID. Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0.

  • AppStream 2.0 fleet - The resource type is fleet and the unique identifier is the fleet name. Example: fleet/sample-fleet.

  • DynamoDB table - The resource type is table and the unique identifier is the resource ID. Example: table/my-table.

  • DynamoDB global secondary index - The resource type is index and the unique identifier is the resource ID. Example: table/my-table/index/my-table-index.

  • Aurora DB cluster - The resource type is cluster and the unique identifier is the cluster name. Example: cluster:my-db-cluster.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

ScalableDimension

The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.

  • 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:InstanceCount - The instance count of an EMR Instance Group.

  • appstream:fleet:DesiredCapacity - The desired capacity of an AppStream 2.0 fleet.

  • dynamodb:table:ReadCapacityUnits - The provisioned read capacity for a DynamoDB table.

  • dynamodb:table:WriteCapacityUnits - The provisioned write capacity for a DynamoDB table.

  • dynamodb:index:ReadCapacityUnits - The provisioned read capacity for a DynamoDB global secondary index.

  • dynamodb:index:WriteCapacityUnits - The provisioned write capacity for a DynamoDB global secondary index.

  • rds:cluster:ReadReplicaCount - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.

Type: String

Valid Values: ecs:service:DesiredCount | ec2:spot-fleet-request:TargetCapacity | elasticmapreduce:instancegroup:InstanceCount | appstream:fleet:DesiredCapacity | dynamodb:table:ReadCapacityUnits | dynamodb:table:WriteCapacityUnits | dynamodb:index:ReadCapacityUnits | dynamodb:index:WriteCapacityUnits | rds:cluster:ReadReplicaCount

Required: No

ServiceNamespace

The namespace of the AWS service. For more information, see AWS Service Namespaces in the Amazon Web Services General Reference.

Type: String

Valid Values: ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds

Required: Yes

Response Syntax

{ "NextToken": "string", "ScalingActivities": [ { "ActivityId": "string", "Cause": "string", "Description": "string", "Details": "string", "EndTime": number, "ResourceId": "string", "ScalableDimension": "string", "ServiceNamespace": "string", "StartTime": number, "StatusCode": "string", "StatusMessage": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token required to get the next set of results. This value is null if there are no more results to return.

Type: String

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

ScalingActivities

A list of scaling activity objects.

Type: Array of ScalingActivity objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentUpdateException

Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.

HTTP Status Code: 400

InternalServiceException

The service encountered an internal error.

HTTP Status Code: 400

InvalidNextTokenException

The next token supplied was invalid.

HTTP Status Code: 400

ValidationException

An exception was thrown for a validation issue. Review the available parameters for the API request.

HTTP Status Code: 400

Example

If you plan to create requests manually, you must replace the Authorization header contents in the examples (AUTHPARAMS) with a signature. For more information, see Signature Version 4 Signing Process in the AWS Gerneral Reference. If you plan to use the AWS CLI or one of the AWS SDKs, these tools sign the requests for you.

Example

The following example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster, and it limits the returned results to 2.

Sample Request

POST / HTTP/1.1 Host: autoscaling.us-west-2.amazonaws.com Accept-Encoding: identity Content-Length: 117 X-Amz-Target: AnyScaleFrontendService.DescribeScalingActivities X-Amz-Date: 20160506T224112Z User-Agent: aws-cli/1.10.26 Python/2.7.11 Darwin/15.4.0 botocore/1.4.8 Content-Type: application/x-amz-json-1.1 Authorization: AUTHPARAMS { "ResourceId": "service/default/web-app", "ServiceNamespace": "ecs", "ScalableDimension": "ecs:service:DesiredCount" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: a2704130-13db-11e6-9fca-039a3edb2541 Content-Type: application/x-amz-json-1.1 Content-Length: 1784 Date: Fri, 06 May 2016 22:41:12 GMT { "ScalingActivities": [ { "ActivityId": "0b812df9-a093-4074-9064-8a8f6c0521f5", "Cause": "monitor alarm web-app-cpu-gt-75 in state ALARM triggered policy web-app-cpu-gt-75", "Description": "Setting desired count to 3.", "ResourceId": "service/default/web-app", "ScalableDimension": "ecs:service:DesiredCount", "ServiceNamespace": "ecs", "StartTime": 1462568034.684, "StatusCode": "Pending" }, { "ActivityId": "4d759079-a31f-4d0c-8468-504c56e2eecf", "Cause": "monitor alarm web-app-cpu-gt-75 in state ALARM triggered policy web-app-cpu-gt-75", "Description": "Setting desired count to 3.", "EndTime": 1462574276.686, "ResourceId": "service/default/web-app", "ScalableDimension": "ecs:service:DesiredCount", "ServiceNamespace": "ecs", "StartTime": 1462574194.658, "StatusCode": "Successful", "StatusMessage": "Successfully set desired count to 3. Change successfully fulfilled by ecs." }, { "ActivityId": "90aff0eb-dd6a-443c-889b-b809e78061c1", "Cause": "monitor alarm web-app-cpu-gt-75 in state ALARM triggered policy web-app-cpu-gt-75", "Description": "Setting desired count to 9.", "EndTime": 1462574333.492, "ResourceId": "service/default/web-app", "ScalableDimension": "ecs:service:DesiredCount", "ServiceNamespace": "ecs", "StartTime": 1462574254.223, "StatusCode": "Successful", "StatusMessage": "Successfully set desired count to 9. Change successfully fulfilled by ecs." }, { "ActivityId": "ee381679-5079-46b5-ac1a-418253981efd", "Cause": "monitor alarm web-app-cpu-gt-75 in state ALARM triggered policy web-app-cpu-gt-75", "Description": "Setting desired count to 10.", "ResourceId": "service/default/web-app", "ScalableDimension": "ecs:service:DesiredCount", "ServiceNamespace": "ecs", "StartTime": 1462574434.077, "StatusCode": "InProgress", "StatusMessage": "Successfully set desired count to 10. Waiting for change to be fulfilled by ecs." } ] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: