[ aws . application-autoscaling ]

describe-scaling-activities

Description

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 .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

describe-scaling-activities is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: ScalingActivities

Synopsis

  describe-scaling-activities
--service-namespace <value>
[--resource-id <value>]
[--scalable-dimension <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--service-namespace (string)

The namespace of the AWS service that provides the resource. For a resource provided by your own application or service, use custom-resource instead.

Possible values:

• ecs

• elasticmapreduce

• ec2

• appstream

• dynamodb

• rds

• sagemaker

• custom-resource

• comprehend

• lambda

• cassandra

• kafka

--resource-id (string)

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 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 .

• Amazon 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 or function: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 .

--scalable-dimension (string)

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 and Aurora PostgreSQL-compatible edition.

• sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon 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.

Possible 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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

Example 1: To describe scaling activities for a scalable target

The following describe-scaling-activities example displays details for th the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.

aws application-autoscaling describe-scaling-activities \
    --service-namespace ecs \
    --scalable-dimension ecs:service:DesiredCount \
    --resource-id service/default/web-app

Output:

{
    "ScalingActivities": [
        {
            "ScalableDimension": "ecs:service:DesiredCount",
            "Description": "Setting desired count to 1.",
            "ResourceId": "service/default/web-app",
            "ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399",
            "StartTime": 1462575838.171,
            "ServiceNamespace": "ecs",
            "EndTime": 1462575872.111,
            "Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25",
            "StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs.",
            "StatusCode": "Successful"
        }
    ]
}

Example 2: To describe scaling activities triggered by scheduled actions

The following describe-scaling-activities example describes the scaling activities for the specified DynamoDB table. The output shows scaling activities triggered by two different scheduled actions:

aws application-autoscaling describe-scaling-activities \
    --service-namespace dynamodb \
    --scalable-dimension dynamodb:table:WriteCapacityUnits \
    --resource-id table/my-table

Output:

{
    "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",
            "EndTime": 1561574449.51,
            "Cause": "maximum capacity was set to 10",
            "StatusMessage": "Successfully set write capacity units to 10. Change successfully fulfilled by dynamodb.",
            "StatusCode": "Successful"
        },
        {
            "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"
        }
    ]
}

For more information, see Scheduled Scaling in the Application Auto Scaling User Guide.

Output

ScalingActivities -> (list)

A list of scaling activity objects.

(structure)

Represents a scaling activity.

ActivityId -> (string)

The unique identifier of the scaling activity.

ServiceNamespace -> (string)

The namespace of the AWS service that provides the resource, or a custom-resource .

ResourceId -> (string)

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/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 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 .

• Amazon 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 or function: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 .

ScalableDimension -> (string)

The scalable dimension. This string consists of the service namespace, resource type, and scaling property.

• 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 and Aurora PostgreSQL-compatible edition.

• sagemaker:variant:DesiredInstanceCount - The number of EC2 instances for an Amazon 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.

Description -> (string)

A simple description of what action the scaling activity intends to accomplish.

Cause -> (string)

A simple description of what caused the scaling activity to happen.

StartTime -> (timestamp)

The Unix timestamp for when the scaling activity began.

EndTime -> (timestamp)

The Unix timestamp for when the scaling activity ended.

StatusCode -> (string)

Indicates the status of the scaling activity.

StatusMessage -> (string)

A simple message about the current status of the scaling activity.

Details -> (string)

The details about the scaling activity.

NextToken -> (string)

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