ApplicationAutoScaling / Client / describe_scalable_targets

describe_scalable_targets#

ApplicationAutoScaling.Client.describe_scalable_targets(**kwargs)#

Gets information about the scalable targets in the specified namespace.

You can filter the results using ResourceIds and ScalableDimension.

Request Syntax

response = client.describe_scalable_targets(
    ServiceNamespace='ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune'|'workspaces',
    ResourceIds=[
        'string',
    ],
    ScalableDimension='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',
    MaxResults=123,
    NextToken='string'
)

Parameters:

ServiceNamespace (string) –
[REQUIRED]

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.
ResourceIds (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/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 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.
- 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.
- (string) –
ScalableDimension (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 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.
MaxResults (integer) –
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 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.
NextToken (string) – The token for the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'ScalableTargets': [
        {
            'ServiceNamespace': 'ecs'|'elasticmapreduce'|'ec2'|'appstream'|'dynamodb'|'rds'|'sagemaker'|'custom-resource'|'comprehend'|'lambda'|'cassandra'|'kafka'|'elasticache'|'neptune'|'workspaces',
            'ResourceId': 'string',
            'ScalableDimension': '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',
            'MinCapacity': 123,
            'MaxCapacity': 123,
            'RoleARN': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'SuspendedState': {
                'DynamicScalingInSuspended': True|False,
                'DynamicScalingOutSuspended': True|False,
                'ScheduledScalingSuspended': True|False
            },
            'ScalableTargetARN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ScalableTargets (list) –
  
  The scalable targets that match the request parameters.
  - (dict) –
    
    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/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 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.
      - 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.
    - 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 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.
    - 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 (datetime) –
      
      The Unix timestamp for when the scalable target was created.
    - SuspendedState (dict) –
      
      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 is false.
      - 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 is false.
      - 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 is false.
    - ScalableTargetARN (string) –
      
      The ARN of the scalable target.
- NextToken (string) –
  
  The token required to get the next set of results. This value is null if there are no more results to return.

Exceptions

ApplicationAutoScaling.Client.exceptions.ValidationException
ApplicationAutoScaling.Client.exceptions.InvalidNextTokenException
ApplicationAutoScaling.Client.exceptions.ConcurrentUpdateException
ApplicationAutoScaling.Client.exceptions.InternalServiceException

Examples

This example describes the scalable targets for the ECS service namespace.

response = client.describe_scalable_targets(
    ServiceNamespace='ecs',
)

print(response)

Expected Output:

{
    'ScalableTargets': [
        {
            'CreationTime': datetime(2019, 5, 6, 11, 21, 46, 0, 126, 0),
            'MaxCapacity': 10,
            'MinCapacity': 1,
            'ResourceId': 'service/default/web-app',
            'RoleARN': 'arn:aws:iam::012345678910:role/aws-service-role/ecs.application-autoscaling.amazonaws.com/AWSServiceRoleForApplicationAutoScaling_ECSService',
            'ScalableDimension': 'ecs:service:DesiredCount',
            'ServiceNamespace': 'ecs',
            'SuspendedState': {
                'DynamicScalingInSuspended': False,
                'DynamicScalingOutSuspended': False,
                'ScheduledScalingSuspended': False,
            },
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}