DescribeScalingActivities
Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.
You can filter the results using ResourceId
and
ScalableDimension
.
For information about viewing scaling activities using the Amazon CLI, see Scaling activities for Application Auto Scaling.
Request Syntax
{
"IncludeNotScaledActivities": boolean
,
"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.
- IncludeNotScaledActivities
-
Specifies whether to include activities that aren't scaled (not scaled activities) in the response. Not scaled activities are activities that aren't completed or started for various reasons, such as preventing infinite scaling loops. For help interpreting the not scaled reason details in the response, see Scaling activities for Application Auto Scaling.
Type: Boolean
Required: No
- MaxResults
-
The maximum number of scalable targets. 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 aNextToken
value. To get the next set of results, include theNextToken
value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and aNextToken
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.
-
ECS service - The resource type is
service
and the unique identifier is the cluster name and service name. Example:service/my-cluster/my-service
. -
Spot Fleet - 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 table name. Example:table/my-table
. -
DynamoDB global secondary index - The resource type is
index
and the unique identifier is the index name. 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
. -
SageMaker endpoint variant - The resource type is
variant
and the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering
. -
Custom resources are not supported with a resource type. This parameter must specify the
OutputValue
from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our GitHub repository. -
Amazon Comprehend document classification endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE
. -
Amazon Comprehend entity recognizer endpoint - The resource type and unique identifier are specified using the endpoint ARN. Example:
arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE
. -
Lambda provisioned concurrency - The resource type is
function
and the unique identifier is the function name with a function version or alias name suffix that is not$LATEST
. Example:function:my-function:prod
orfunction:my-function:1
. -
Amazon Keyspaces table - The resource type is
table
and the unique identifier is the table name. Example:keyspace/mykeyspace/table/mytable
. -
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. Example:
arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5
. -
Amazon ElastiCache replication group - The resource type is
replication-group
and the unique identifier is the replication group name. Example:replication-group/mycluster
. -
Neptune cluster - The resource type is
cluster
and the unique identifier is the cluster name. Example:cluster:mycluster
. -
SageMaker serverless endpoint - The resource type is
variant
and the unique identifier is the resource ID. Example:endpoint/my-end-point/variant/KMeansClustering
. -
SageMaker inference component - The resource type is
inference-component
and the unique identifier is the resource ID. Example:inference-component/my-inference-component
. -
Pool of WorkSpaces - The resource type is
workspacespool
and the unique identifier is the pool ID. Example:workspacespool/wspool-123456
.
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 task count of an ECS service. -
elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group. -
ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet. -
appstream:fleet:DesiredCapacity
- The 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 and Aurora PostgreSQL-compatible edition. -
sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant. -
custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service. -
comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint. -
comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint. -
lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function. -
cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table. -
cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table. -
kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster. -
elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group. -
elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group. -
neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster. -
sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint. -
sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component. -
workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
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 | sagemaker:variant:DesiredInstanceCount | custom-resource:ResourceType:Property | comprehend:document-classifier-endpoint:DesiredInferenceUnits | comprehend:entity-recognizer-endpoint:DesiredInferenceUnits | lambda:function:ProvisionedConcurrency | cassandra:table:ReadCapacityUnits | cassandra:table:WriteCapacityUnits | kafka:broker-storage:VolumeSize | elasticache:replication-group:NodeGroups | elasticache:replication-group:Replicas | neptune:cluster:ReadReplicaCount | sagemaker:variant:DesiredProvisionedConcurrency | sagemaker:inference-component:DesiredCopyCount | workspaces:workspacespool:DesiredUserSessions
Required: No
-
- ServiceNamespace
-
The namespace of the Amazon service that provides the resource. For a resource provided by your own application or service, use
custom-resource
instead.Type: String
Valid Values:
ecs | elasticmapreduce | ec2 | appstream | dynamodb | rds | sagemaker | custom-resource | comprehend | lambda | cassandra | kafka | elasticache | neptune | workspaces
Required: Yes
Response Syntax
{
"NextToken": "string",
"ScalingActivities": [
{
"ActivityId": "string",
"Cause": "string",
"Description": "string",
"Details": "string",
"EndTime": number,
"NotScaledReasons": [
{
"Code": "string",
"CurrentCapacity": number,
"MaxCapacity": number,
"MinCapacity": 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
Examples
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 Signing
Amazon API requests in the IAM User Guide.
If you plan to use the Amazon CLI
Example of scaling activities for a scaling policy
The following example describes the scaling activities for an Amazon ECS service named
web-app
that's running in the default
cluster. It shows
the scaling activities for the scaling policy named
cpu75-target-tracking-scaling-policy
, initiated by the CloudWatch alarm
named
TargetTracking-service/my-cluster/my-service-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca
.
Sample Request
POST / HTTP/1.1
Host: application-autoscaling.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
X-Amz-Target: AnyScaleFrontendService.DescribeScalingActivities
X-Amz-Date: 20190506T224112Z
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/my-cluster/my-service",
"ServiceNamespace": "ecs",
"ScalableDimension": "ecs:service:DesiredCount"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: [request-id]
Content-Type: application/x-amz-json-1.1
Content-Length: 1784
Date: Fri, 06 May 2019 22:41:12 GMT
{
"ScalingActivities": [
{
"ScalableDimension": "ecs:service:DesiredCount",
"Description": "Setting desired count to 3.",
"ResourceId": "service/my-cluster/my-service",
"ActivityId": "4d759079-a31f-4d0c-8468-504c56e2eecf",
"StartTime": 1462574194.658,
"ServiceNamespace": "ecs",
"EndTime": 1462574276.686,
"Cause": "monitor alarm TargetTracking-service/my-cluster/my-service-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca in state ALARM triggered policy cpu75-target-tracking-scaling-policy",
"StatusMessage": "Successfully set desired count to 3. Change successfully fulfilled by ecs.",
"StatusCode": "Successful"
},
{
"ScalableDimension": "ecs:service:DesiredCount",
"Description": "Setting desired count to 2.",
"ResourceId": "service/my-cluster/my-service",
"ActivityId": "90aff0eb-dd6a-443c-889b-b809e78061c1",
"StartTime": 1462574254.223,
"ServiceNamespace": "ecs",
"EndTime": 1462574333.492,
"Cause": "monitor alarm TargetTracking-service/my-cluster/my-service-AlarmHigh-d4f0770c-b46e-434a-a60f-3b36d653feca in state ALARM triggered policy cpu75-target-tracking-scaling-policy",
"StatusMessage": "Successfully set desired count to 2. Change successfully fulfilled by ecs.",
"StatusCode": "Successful"
}
]
}
Example of scaling activities for scheduled actions
The following example describes the scaling activities for a DynamoDB table named
my-table
. It shows the scaling activities for scheduled actions named
my-first-scheduled-action
and
my-second-scheduled-action
.
Sample Request
POST / HTTP/1.1
Host: application-autoscaling.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
X-Amz-Target: AnyScaleFrontendService.DescribeScalingActivities
X-Amz-Date: 20190526T110828Z
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": "table/my-table",
"ServiceNamespace": "dynamodb",
"ScalableDimension": "dynamodb:table:WriteCapacityUnits"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: [request-id]
Content-Type: application/x-amz-json-1.1
Content-Length: 1784
Date: Fri, 26 May 2019 11:08:28 GMT
{
"ScalingActivities": [
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Description": "Setting write capacity units to 10.",
"ResourceId": "table/my-table",
"ActivityId": "4d1308c0-bbcf-4514-a673-b0220ae38547",
"StartTime": 1561574415.086,
"ServiceNamespace": "dynamodb",
"Cause": "maximum capacity was set to 10",
"StatusMessage": "Successfully set write capacity units to 10. Waiting for change to be fulfilled by dynamodb.",
"StatusCode": "InProgress"
},
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Description": "Setting min capacity to 5 and max capacity to 10",
"ResourceId": "table/my-table",
"ActivityId": "f2b7847b-721d-4e01-8ef0-0c8d3bacc1c7",
"StartTime": 1561574414.644,
"ServiceNamespace": "dynamodb",
"Cause": "scheduled action name my-second-scheduled-action was triggered",
"StatusMessage": "Successfully set min capacity to 5 and max capacity to 10",
"StatusCode": "Successful"
},
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Description": "Setting write capacity units to 15.",
"ResourceId": "table/my-table",
"ActivityId": "d8ea4de6-9eaa-499f-b466-2cc5e681ba8b",
"StartTime": 1561574108.904,
"ServiceNamespace": "dynamodb",
"EndTime": 1561574140.255,
"Cause": "minimum capacity was set to 15",
"StatusMessage": "Successfully set write capacity units to 15. Change successfully fulfilled by dynamodb.",
"StatusCode": "Successful"
},
{
"ScalableDimension": "dynamodb:table:WriteCapacityUnits",
"Description": "Setting min capacity to 15 and max capacity to 20",
"ResourceId": "table/my-table",
"ActivityId": "3250fd06-6940-4e8e-bb1f-d494db7554d2",
"StartTime": 1561574108.512,
"ServiceNamespace": "dynamodb",
"Cause": "scheduled action name my-first-scheduled-action was triggered",
"StatusMessage": "Successfully set min capacity to 15 and max capacity to 20",
"StatusCode": "Successful"
}
]
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: