Serialized Form

Package com.amazonaws.services.applicationautoscaling.model

Class com.amazonaws.services.applicationautoscaling.model.Alarm extends Object implements Serializable

Serialized Fields

alarmName

String alarmName

The name of the alarm.

alarmARN

String alarmARN

The Amazon Resource Name (ARN) of the alarm.

Class com.amazonaws.services.applicationautoscaling.model.AWSApplicationAutoScalingException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationautoscaling.model.ConcurrentUpdateException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationautoscaling.model.CustomizedMetricSpecification extends Object implements Serializable

Serialized Fields

metricName

String metricName

The name of the metric. To get the exact metric name, namespace, and dimensions, inspect the Metric object that's returned by a call to ListMetrics.

namespace

String namespace

The namespace of the metric.

dimensions

List<E> dimensions

The dimensions of the metric.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

statistic

String statistic

The statistic of the metric.

unit

String unit

The unit of the metric. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

metrics

List<E> metrics

The metrics to include in the target tracking scaling policy, as a metric data query. This can include both raw metric and metric math expressions.

Class com.amazonaws.services.applicationautoscaling.model.DeleteScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name of the scaling policy.

serviceNamespace

String serviceNamespace

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.

resourceId

String resourceId

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

scalableDimension

String scalableDimension

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.

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

Class com.amazonaws.services.applicationautoscaling.model.DeleteScalingPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.applicationautoscaling.model.DeleteScheduledActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serviceNamespace

String serviceNamespace

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.

scheduledActionName

String scheduledActionName

The name of the scheduled action.

resourceId

String resourceId

The identifier of the resource associated with the scheduled action. 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 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.

scalableDimension

String scalableDimension

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.

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

Class com.amazonaws.services.applicationautoscaling.model.DeleteScheduledActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.applicationautoscaling.model.DeregisterScalableTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serviceNamespace

String serviceNamespace

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.

resourceId

String resourceId

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

scalableDimension

String scalableDimension

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.

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

Class com.amazonaws.services.applicationautoscaling.model.DeregisterScalableTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalableTargetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serviceNamespace

String serviceNamespace

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<E> resourceIds

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

scalableDimension

String scalableDimension

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.

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

maxResults

Integer 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 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 nextToken

The token for the next set of results.

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalableTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

scalableTargets

List<E> scalableTargets

The scalable targets that match the request parameters.

nextToken

String nextToken

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

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingActivitiesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serviceNamespace

String serviceNamespace

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.

resourceId

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

scalableDimension

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

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

maxResults

Integer 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 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 nextToken

The token for the next set of results.

includeNotScaledActivities

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

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingActivitiesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

scalingActivities

List<E> scalingActivities

A list of scaling activity objects.

nextToken

String nextToken

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

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingPoliciesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyNames

List<E> policyNames

The names of the scaling policies to describe.

serviceNamespace

String serviceNamespace

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.

resourceId

String resourceId

The identifier of the resource associated with the scaling policy. 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 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.

scalableDimension

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

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

maxResults

Integer maxResults

The maximum number of scalable targets. This value can be between 1 and 10. The default value is 10.

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 10 results and a NextToken value, if applicable.

nextToken

String nextToken

The token for the next set of results.

Class com.amazonaws.services.applicationautoscaling.model.DescribeScalingPoliciesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

scalingPolicies

List<E> scalingPolicies

Information about the scaling policies.

nextToken

String nextToken

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

Class com.amazonaws.services.applicationautoscaling.model.DescribeScheduledActionsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

scheduledActionNames

List<E> scheduledActionNames

The names of the scheduled actions to describe.

serviceNamespace

String serviceNamespace

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.

resourceId

String resourceId

The identifier of the resource associated with the scheduled action. 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 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.

scalableDimension

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

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

maxResults

Integer maxResults

The maximum number of scheduled action 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.

nextToken

String nextToken

The token for the next set of results.

Class com.amazonaws.services.applicationautoscaling.model.DescribeScheduledActionsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

scheduledActions

List<E> scheduledActions

Information about the scheduled actions.

nextToken

String nextToken

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

Class com.amazonaws.services.applicationautoscaling.model.FailedResourceAccessException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationautoscaling.model.InternalServiceException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationautoscaling.model.InvalidNextTokenException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationautoscaling.model.LimitExceededException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationautoscaling.model.ListTagsForResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceARN

String resourceARN

Specify the ARN of the scalable target.

For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123

To get the ARN for a scalable target, use DescribeScalableTargets.

Class com.amazonaws.services.applicationautoscaling.model.ListTagsForResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

tags

Map<K,V> tags

A list of tags. Each tag consists of a tag key and a tag value.

Class com.amazonaws.services.applicationautoscaling.model.MetricDimension extends Object implements Serializable

Serialized Fields

name

String name

The name of the dimension.

value

String value

The value of the dimension.

Class com.amazonaws.services.applicationautoscaling.model.NotScaledReason extends Object implements Serializable

Serialized Fields

code

String code

A code that represents the reason for not scaling.

Valid values:

• AutoScalingAnticipatedFlapping

• TargetServicePutResourceAsUnscalable

• AlreadyAtMaxCapacity

• AlreadyAtMinCapacity

• AlreadyAtDesiredCapacity

maxCapacity

Integer maxCapacity

The maximum capacity.

minCapacity

Integer minCapacity

The minimum capacity.

currentCapacity

Integer currentCapacity

The current capacity.

Class com.amazonaws.services.applicationautoscaling.model.ObjectNotFoundException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.applicationautoscaling.model.PredefinedMetricSpecification extends Object implements Serializable

Serialized Fields

predefinedMetricType

String predefinedMetricType

The metric type. The ALBRequestCountPerTarget metric type applies only to Spot Fleets and ECS services.

resourceLabel

String resourceLabel

Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is ALBRequestCountPerTarget and there is a target group attached to the Spot Fleet or ECS service.

You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:

app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff.

Where:

• app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN

• targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.

To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.

Class com.amazonaws.services.applicationautoscaling.model.PutScalingPolicyRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

policyName

String policyName

The name of the scaling policy.

You cannot change the name of a scaling policy, but you can delete the original scaling policy and create a new scaling policy with the same settings and a different name.

serviceNamespace

String serviceNamespace

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.

resourceId

String resourceId

The identifier of the resource associated with the scaling policy. 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 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.

scalableDimension

String scalableDimension

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.

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

policyType

String policyType

The scaling policy type. This parameter is required if you are creating a scaling policy.

The following policy types are supported:

TargetTrackingScaling—Not supported for Amazon EMR

StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.

For more information, see Target tracking scaling policies and Step scaling policies in the Application Auto Scaling User Guide.

stepScalingPolicyConfiguration

StepScalingPolicyConfiguration stepScalingPolicyConfiguration

A step scaling policy.

This parameter is required if you are creating a policy and the policy type is StepScaling.

targetTrackingScalingPolicyConfiguration

TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration

A target tracking scaling policy. Includes support for predefined or customized metrics.

This parameter is required if you are creating a policy and the policy type is TargetTrackingScaling .

Class com.amazonaws.services.applicationautoscaling.model.PutScalingPolicyResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

policyARN

String policyARN

The Amazon Resource Name (ARN) of the resulting scaling policy.

alarms

List<E> alarms

The CloudWatch alarms created for the target tracking scaling policy.

Class com.amazonaws.services.applicationautoscaling.model.PutScheduledActionRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serviceNamespace

String serviceNamespace

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.

schedule

String schedule

The schedule for this action. The following formats are supported:

• At expressions - "at(yyyy-mm-ddThh:mm:ss)"

• Rate expressions - "rate(value unit)"

• Cron expressions - "cron(fields)"

At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.

At and cron expressions use Universal Coordinated Time (UTC) by default.

The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.

timezone

String timezone

Specifies the time zone used when setting a scheduled action by using an at or cron expression. If a time zone is not provided, UTC is used by default.

Valid values are the canonical names of the IANA time zones supported by Joda-Time (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://www.joda.org/joda-time/timezones.html.

scheduledActionName

String scheduledActionName

The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.

resourceId

String resourceId

The identifier of the resource associated with the scheduled action. 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 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.

scalableDimension

String scalableDimension

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.

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

startTime

Date startTime

The date and time for this scheduled action to start, in UTC.

endTime

Date endTime

The date and time for the recurring schedule to end, in UTC.

scalableTargetAction

ScalableTargetAction scalableTargetAction

The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

Class com.amazonaws.services.applicationautoscaling.model.PutScheduledActionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.applicationautoscaling.model.RegisterScalableTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

serviceNamespace

String serviceNamespace

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.

resourceId

String resourceId

The identifier of the resource that is 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 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.

scalableDimension

String scalableDimension

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.

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

minCapacity

Integer minCapacity

The minimum value that you plan to scale in to. When a scaling policy is in effect, Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to changing demand. This property is required when registering a new scalable target.

For the following resources, the minimum value allowed is 0.

• AppStream 2.0 fleets

• Aurora DB clusters

• ECS services

• EMR clusters

• Lambda provisioned concurrency

• SageMaker endpoint variants

• SageMaker Serverless endpoint provisioned concurrency

• Spot Fleets

• custom resources

It's strongly recommended that you specify a value greater than 0. A value greater than 0 means that data points are continuously reported to CloudWatch that scaling policies can use to scale on a metric like average CPU utilization.

For all other resources, the minimum allowed value depends on the type of resource that you are using. If you provide a value that is lower than what a resource can accept, an error occurs. In which case, the error message will provide the minimum value that the resource can accept.

maxCapacity

Integer maxCapacity

The maximum value that you plan to scale out to. When a scaling policy is in effect, Application Auto Scaling can scale out (expand) as needed to the maximum capacity limit in response to changing demand. This property is required when registering a new scalable target.

Although you can specify a large maximum capacity, note that service quotas might impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference.

roleARN

String roleARN

This parameter is required for services that do not support service-linked roles (such as Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

If the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which it creates if it does not yet exist. For more information, see Application Auto Scaling IAM roles.

suspendedState

SuspendedState suspendedState

An embedded object that contains attributes and attribute values that are used to suspend and resume automatic scaling. Setting the value of an attribute to true suspends the specified scaling activities. Setting it to false (default) resumes the specified scaling activities.

Suspension Outcomes

• For DynamicScalingInSuspended, while a suspension is in effect, all scale-in activities that are triggered by a scaling policy are suspended.

• For DynamicScalingOutSuspended, while a suspension is in effect, all scale-out activities that are triggered by a scaling policy are suspended.

• For ScheduledScalingSuspended, while a suspension is in effect, all scaling activities that involve scheduled actions are suspended.

For more information, see Suspending and resuming scaling in the Application Auto Scaling User Guide.

tags

Map<K,V> tags

Assigns one or more tags to the scalable target. Use this parameter to tag the scalable target when it is created. To tag an existing scalable target, use the TagResource operation.

Each tag consists of a tag key and a tag value. Both the tag key and the tag value are required. You cannot have more than one tag on a scalable target with the same tag key.

Use tags to control access to a scalable target. For more information, see Tagging support for Application Auto Scaling in the Application Auto Scaling User Guide.

Class com.amazonaws.services.applicationautoscaling.model.RegisterScalableTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

scalableTargetARN

String scalableTargetARN

The ARN of the scalable target.

Class com.amazonaws.services.applicationautoscaling.model.ResourceNotFoundException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:

1L

Serialized Fields

resourceName

String resourceName

The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).

Class com.amazonaws.services.applicationautoscaling.model.ScalableTarget extends Object implements Serializable

Serialized Fields

serviceNamespace

String serviceNamespace

The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

resourceId

String resourceId

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

scalableDimension

String scalableDimension

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.

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

minCapacity

Integer minCapacity

The minimum value to scale to in response to a scale-in activity.

maxCapacity

Integer maxCapacity

The maximum value to scale to in response to a scale-out activity.

roleARN

String roleARN

The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.

creationTime

Date creationTime

The Unix timestamp for when the scalable target was created.

suspendedState

SuspendedState suspendedState

Specifies whether the scaling activities for a scalable target are in a suspended state.

scalableTargetARN

String scalableTargetARN

The ARN of the scalable target.

Class com.amazonaws.services.applicationautoscaling.model.ScalableTargetAction extends Object implements Serializable

Serialized Fields

minCapacity

Integer minCapacity

The minimum capacity.

When the scheduled action runs, the resource will have at least this much capacity, but it might have more depending on other settings, such as the target utilization level of a target tracking scaling policy.

maxCapacity

Integer maxCapacity

The maximum capacity.

Although you can specify a large maximum capacity, note that service quotas may impose lower limits. Each service has its own default quotas for the maximum capacity of the resource. If you want to specify a higher limit, you can request an increase. For more information, consult the documentation for that service. For information about the default quotas for each service, see Service endpoints and quotas in the Amazon Web Services General Reference.

Class com.amazonaws.services.applicationautoscaling.model.ScalingActivity extends Object implements Serializable

Serialized Fields

activityId

String activityId

The unique identifier of the scaling activity.

serviceNamespace

String serviceNamespace

The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

resourceId

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

scalableDimension

String scalableDimension

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.

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

description

String description

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

cause

String cause

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

startTime

Date startTime

The Unix timestamp for when the scaling activity began.

endTime

Date endTime

The Unix timestamp for when the scaling activity ended.

statusCode

String statusCode

Indicates the status of the scaling activity.

statusMessage

String statusMessage

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

details

String details

The details about the scaling activity.

notScaledReasons

List<E> notScaledReasons

Machine-readable data that describes the reason for a not scaled activity. Only available when DescribeScalingActivities includes not scaled activities.

Class com.amazonaws.services.applicationautoscaling.model.ScalingPolicy extends Object implements Serializable

Serialized Fields

policyARN

String policyARN

The Amazon Resource Name (ARN) of the scaling policy.

policyName

String policyName

The name of the scaling policy.

serviceNamespace

String serviceNamespace

The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

resourceId

String resourceId

The identifier of the resource associated with the scaling policy. 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 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.

scalableDimension

String scalableDimension

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.

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

policyType

String policyType

The scaling policy type.

The following policy types are supported:

TargetTrackingScaling—Not supported for Amazon EMR

StepScaling—Not supported for DynamoDB, Amazon Comprehend, Lambda, Amazon Keyspaces, Amazon MSK, Amazon ElastiCache, or Neptune.

stepScalingPolicyConfiguration

StepScalingPolicyConfiguration stepScalingPolicyConfiguration

A step scaling policy.

targetTrackingScalingPolicyConfiguration

TargetTrackingScalingPolicyConfiguration targetTrackingScalingPolicyConfiguration

A target tracking scaling policy.

alarms

List<E> alarms

The CloudWatch alarms associated with the scaling policy.

creationTime

Date creationTime

The Unix timestamp for when the scaling policy was created.

Class com.amazonaws.services.applicationautoscaling.model.ScheduledAction extends Object implements Serializable

Serialized Fields

scheduledActionName

String scheduledActionName

The name of the scheduled action.

scheduledActionARN

String scheduledActionARN

The Amazon Resource Name (ARN) of the scheduled action.

serviceNamespace

String serviceNamespace

The namespace of the Amazon Web Services service that provides the resource, or a custom-resource.

schedule

String schedule

The schedule for this action. The following formats are supported:

• At expressions - "at(yyyy-mm-ddThh:mm:ss)"

• Rate expressions - "rate(value unit)"

• Cron expressions - "cron(fields)"

At expressions are useful for one-time schedules. Cron expressions are useful for scheduled actions that run periodically at a specified date and time, and rate expressions are useful for scheduled actions that run at a regular interval.

At and cron expressions use Universal Coordinated Time (UTC) by default.

The cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].

For rate expressions, value is a positive integer and unit is minute | minutes | hour | hours | day | days.

For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.

timezone

String timezone

The time zone used when referring to the date and time of a scheduled action, when the scheduled action uses an at or cron expression.

resourceId

String resourceId

The identifier of the resource associated with the scaling policy. 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 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.

scalableDimension

String scalableDimension

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.

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

• sagemaker:variant:DesiredProvisionedConcurrency - The provisioned concurrency for a SageMaker Serverless endpoint.

startTime

Date startTime

The date and time that the action is scheduled to begin, in UTC.

endTime

Date endTime

The date and time that the action is scheduled to end, in UTC.

scalableTargetAction

ScalableTargetAction scalableTargetAction

The new minimum and maximum capacity. You can set both values or just one. At the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.

creationTime

Date creationTime

The date and time that the scheduled action was created.

Class com.amazonaws.services.applicationautoscaling.model.StepAdjustment extends Object implements Serializable

Serialized Fields

metricIntervalLowerBound

Double metricIntervalLowerBound

The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it's exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.

metricIntervalUpperBound

Double metricIntervalUpperBound

The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it's inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.

The upper bound must be greater than the lower bound.

scalingAdjustment

Integer scalingAdjustment

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. For exact capacity, you must specify a non-negative value.

Class com.amazonaws.services.applicationautoscaling.model.StepScalingPolicyConfiguration extends Object implements Serializable

Serialized Fields

adjustmentType

String adjustmentType

Specifies how the ScalingAdjustment value in a StepAdjustment is interpreted (for example, an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

AdjustmentType is required if you are adding a new step scaling policy configuration.

stepAdjustments

List<E> stepAdjustments

A set of adjustments that enable you to scale based on the size of the alarm breach.

At least one step adjustment is required if you are adding a new step scaling policy configuration.

minAdjustmentMagnitude

Integer minAdjustmentMagnitude

The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Application Auto Scaling scales out the service by 2 tasks.

cooldown

Integer cooldown

The amount of time, in seconds, to wait for a previous scaling activity to take effect. If not specified, the default value is 300. For more information, see Cooldown period in the Application Auto Scaling User Guide.

metricAggregationType

String metricAggregationType

The aggregation type for the CloudWatch metrics. Valid values are Minimum, Maximum, and Average. If the aggregation type is null, the value is treated as Average.

Class com.amazonaws.services.applicationautoscaling.model.SuspendedState extends Object implements Serializable

Serialized Fields

dynamicScalingInSuspended

Boolean dynamicScalingInSuspended

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 dynamicScalingOutSuspended

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 scheduledScalingSuspended

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.

Class com.amazonaws.services.applicationautoscaling.model.TagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceARN

String resourceARN

Identifies the Application Auto Scaling scalable target that you want to apply tags to.

For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123

To get the ARN for a scalable target, use DescribeScalableTargets.

tags

Map<K,V> tags

The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource.

Each tag consists of a tag key and a tag value.

You cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key. If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the current tag value with the specified one.

For information about the rules that apply to tag keys and tag values, see User-defined tag restrictions in the Amazon Web Services Billing and Cost Management User Guide.

Class com.amazonaws.services.applicationautoscaling.model.TagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingMetric extends Object implements Serializable

Serialized Fields

dimensions

List<E> dimensions

The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.

Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.

metricName

String metricName

The name of the metric.

namespace

String namespace

The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.

Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingMetricDataQuery extends Object implements Serializable

Serialized Fields

expression

String expression

The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id of the other metrics to refer to those metrics, and can also use the Id of other expressions to use the result of those expressions.

Conditional: Within each TargetTrackingMetricDataQuery object, you must specify either Expression or MetricStat, but not both.

id

String id

A short name that identifies the object's results in the response. This name must be unique among all MetricDataQuery objects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.

label

String label

A human-readable label for this metric or expression. This is especially useful if this is a math expression, so that you know what the value represents.

metricStat

TargetTrackingMetricStat metricStat

Information about the metric data to return.

Conditional: Within each MetricDataQuery object, you must specify either Expression or MetricStat, but not both.

returnData

Boolean returnData

Indicates whether to return the timestamps and raw data values of this metric.

If you use any math expressions, specify true for this value for only the final math expression that the metric specification is based on. You must specify false for ReturnData for all the other metrics and expressions used in the metric specification.

If you are only retrieving metrics and not performing any math expressions, do not specify anything for ReturnData. This sets it to its default (true).

Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingMetricDimension extends Object implements Serializable

Serialized Fields

name

String name

The name of the dimension.

value

String value

The value of the dimension.

Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingMetricStat extends Object implements Serializable

Serialized Fields

metric

TargetTrackingMetric metric

The CloudWatch metric to return, including the metric name, namespace, and dimensions. To get the exact metric name, namespace, and dimensions, inspect the Metric object that is returned by a call to ListMetrics.

stat

String stat

The statistic to return. It can include any CloudWatch statistic or extended statistic. For a list of valid values, see the table in Statistics in the Amazon CloudWatch User Guide.

The most commonly used metric for scaling is Average.

unit

String unit

The unit to use for the returned data points. For a complete list of the units that CloudWatch supports, see the MetricDatum data type in the Amazon CloudWatch API Reference.

Class com.amazonaws.services.applicationautoscaling.model.TargetTrackingScalingPolicyConfiguration extends Object implements Serializable

Serialized Fields

targetValue

Double targetValue

The target value for the metric. Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

If the scaling policy specifies the ALBRequestCountPerTarget predefined metric, specify the target utilization as the optimal average request count per target during any one-minute interval.

predefinedMetricSpecification

PredefinedMetricSpecification predefinedMetricSpecification

A predefined metric. You can specify either a predefined metric or a customized metric.

customizedMetricSpecification

CustomizedMetricSpecification customizedMetricSpecification

A customized metric. You can specify either a predefined metric or a customized metric.

scaleOutCooldown

Integer scaleOutCooldown

The amount of time, in seconds, to wait for a previous scale-out activity to take effect. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

scaleInCooldown

Integer scaleInCooldown

The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start. For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide.

disableScaleIn

Boolean disableScaleIn

Indicates whether scale in by the target tracking scaling policy is disabled. If the value is true, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false.

Class com.amazonaws.services.applicationautoscaling.model.TooManyTagsException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:

1L

Serialized Fields

resourceName

String resourceName

The name of the Application Auto Scaling resource. This value is an Amazon Resource Name (ARN).

Class com.amazonaws.services.applicationautoscaling.model.UntagResourceRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

resourceARN

String resourceARN

Identifies the Application Auto Scaling scalable target from which to remove tags.

For example: arn:aws:application-autoscaling:us-east-1:123456789012:scalable-target/1234abcd56ab78cd901ef1234567890ab123

To get the ARN for a scalable target, use DescribeScalableTargets.

tagKeys

List<E> tagKeys

One or more tag keys. Specify only the tag keys, not the tag values.

Class com.amazonaws.services.applicationautoscaling.model.UntagResourceResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.applicationautoscaling.model.ValidationException extends AWSApplicationAutoScalingException implements Serializable

serialVersionUID:

1L