[ aws . application-autoscaling ]
Gets information about the scalable targets in the specified namespace.
You can filter the results using ResourceIds
and ScalableDimension
.
See also: AWS API Documentation
describe-scalable-targets
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: ScalableTargets
describe-scalable-targets
--service-namespace <value>
[--resource-ids <value>]
[--scalable-dimension <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--service-namespace
(string)
The namespace of the Amazon Web Services 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
elasticache
neptune
--resource-ids
(list)
The identifier of the resource associated with the scalable target. 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 - 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
.(string)
Syntax:
"string" "string" ...
--scalable-dimension
(string)
The scalable dimension associated with the scalable target. 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.
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 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 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.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
elasticache:replication-group:NodeGroups
elasticache:replication-group:Replicas
neptune:cluster:ReadReplicaCount
--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 theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To describe scalable targets
The following describe-scalable-targets
example command displays details for the the scalable targets for the ecs
service namespace:
aws application-autoscaling describe-scalable-targets \
--service-namespace ecs
Output:
{
"ScalableTargets": [
{
"ScalableDimension": "ecs:service:DesiredCount",
"ResourceId": "service/default/web-app",
"RoleARN": "arn:aws:iam::123456789012:role/ApplicationAutoscalingECSRole",
"SuspendedState": {
"DynamicScalingOutSuspended": false,
"ScheduledScalingSuspended": false,
"DynamicScalingInSuspended": false
},
"CreationTime": 1462558906.199,
"MinCapacity": 1,
"ServiceNamespace": "ecs",
"MaxCapacity": 10
}
]
}
For more information, see What Is Application Auto Scaling? in the Application Auto Scaling User Guide.
ScalableTargets -> (list)
The scalable targets that match the request parameters.
(structure)
Represents a scalable target.
ServiceNamespace -> (string)
The namespace of the Amazon Web Services service that provides the resource, or a
custom-resource
.ResourceId -> (string)
The identifier of the resource associated with the scalable target. 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 - 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
.ScalableDimension -> (string)
The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.
ecs:service:DesiredCount
- The desired 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 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 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.MinCapacity -> (integer)
The minimum value to scale to in response to a scale-in activity.
MaxCapacity -> (integer)
The maximum value to scale to in response to a scale-out activity.
RoleARN -> (string)
The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.
CreationTime -> (timestamp)
The Unix timestamp for when the scalable target was created.
SuspendedState -> (structure)
Specifies whether the scaling activities for a scalable target are in a suspended state.
DynamicScalingInSuspended -> (boolean)
Whether scale in by a target tracking scaling policy or a step scaling policy is suspended. Set the value to
true
if you don’t want Application Auto Scaling to remove capacity when a scaling policy is triggered. The default isfalse
.DynamicScalingOutSuspended -> (boolean)
Whether scale out by a target tracking scaling policy or a step scaling policy is suspended. Set the value to
true
if you don’t want Application Auto Scaling to add capacity when a scaling policy is triggered. The default isfalse
.ScheduledScalingSuspended -> (boolean)
Whether scheduled scaling is suspended. Set the value to
true
if you don’t want Application Auto Scaling to add or remove capacity by initiating scheduled actions. The default isfalse
.
NextToken -> (string)
The token required to get the next set of results. This value is
null
if there are no more results to return.