Struct aws_sdk_applicationautoscaling::client::Client
source · [−]pub struct Client<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }Expand description
Client for Application Auto Scaling
Client for invoking operations on Application Auto Scaling. Each operation on Application Auto Scaling is a method on this
this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.
Examples
Constructing a client and invoking an operation
// create a shared configuration. This can be used & shared between multiple service clients.
let shared_config = aws_config::load_from_env().await;
let client = aws_sdk_applicationautoscaling::Client::new(&shared_config);
// invoke an operation
/* let rsp = client
.<operation_name>().
.<param>("some value")
.send().await; */Constructing a client with custom configuration
use aws_config::RetryConfig;
let shared_config = aws_config::load_from_env().await;
let config = aws_sdk_applicationautoscaling::config::Builder::from(&shared_config)
.retry_config(RetryConfig::disabled())
.build();
let client = aws_sdk_applicationautoscaling::Client::from_conf(config);Implementations
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> Client<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
Constructs a fluent builder for the DeleteScalingPolicy operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)/set_policy_name(Option<String>):The name of the scaling policy.
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.resource_id(impl Into<String>)/set_resource_id(Option<String>):The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
-
ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
- On success, responds with
DeleteScalingPolicyOutput - On failure, responds with
SdkError<DeleteScalingPolicyError>
Constructs a fluent builder for the DeleteScheduledAction operation.
- The fluent builder is configurable:
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.scheduled_action_name(impl Into<String>)/set_scheduled_action_name(Option<String>):The name of the scheduled action.
resource_id(impl Into<String>)/set_resource_id(Option<String>):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
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
- On success, responds with
DeleteScheduledActionOutput - On failure, responds with
SdkError<DeleteScheduledActionError>
Constructs a fluent builder for the DeregisterScalableTarget operation.
- The fluent builder is configurable:
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.resource_id(impl Into<String>)/set_resource_id(Option<String>):The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
-
ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
- On success, responds with
DeregisterScalableTargetOutput - On failure, responds with
SdkError<DeregisterScalableTargetError>
Constructs a fluent builder for the DescribeScalableTargets operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.resource_ids(Vec<String>)/set_resource_ids(Option<Vec<String>>):The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.
-
ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
max_results(i32)/set_max_results(Option<i32>):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
MaxResultsresults at a time, along with aNextTokenvalue. To get the next set of results, include theNextTokenvalue in a subsequent call. If this parameter is not used, the operation returns up to 50 results and aNextTokenvalue, if applicable.next_token(impl Into<String>)/set_next_token(Option<String>):The token for the next set of results.
- On success, responds with
DescribeScalableTargetsOutputwith field(s):scalable_targets(Option<Vec<ScalableTarget>>):The scalable targets that match the request parameters.
next_token(Option<String>):The token required to get the next set of results. This value is
nullif there are no more results to return.
- On failure, responds with
SdkError<DescribeScalableTargetsError>
Constructs a fluent builder for the DescribeScalingActivities operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.resource_id(impl Into<String>)/set_resource_id(Option<String>):The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.
-
ECS service - The resource type is
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
max_results(i32)/set_max_results(Option<i32>):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
MaxResultsresults at a time, along with aNextTokenvalue. To get the next set of results, include theNextTokenvalue in a subsequent call. If this parameter is not used, the operation returns up to 50 results and aNextTokenvalue, if applicable.next_token(impl Into<String>)/set_next_token(Option<String>):The token for the next set of results.
- On success, responds with
DescribeScalingActivitiesOutputwith field(s):scaling_activities(Option<Vec<ScalingActivity>>):A list of scaling activity objects.
next_token(Option<String>):The token required to get the next set of results. This value is
nullif there are no more results to return.
- On failure, responds with
SdkError<DescribeScalingActivitiesError>
Constructs a fluent builder for the DescribeScalingPolicies operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
policy_names(Vec<String>)/set_policy_names(Option<Vec<String>>):The names of the scaling policies to describe.
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.resource_id(impl Into<String>)/set_resource_id(Option<String>):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
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
max_results(i32)/set_max_results(Option<i32>):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
MaxResultsresults at a time, along with aNextTokenvalue. To get the next set of results, include theNextTokenvalue in a subsequent call. If this parameter is not used, the operation returns up to 10 results and aNextTokenvalue, if applicable.next_token(impl Into<String>)/set_next_token(Option<String>):The token for the next set of results.
- On success, responds with
DescribeScalingPoliciesOutputwith field(s):scaling_policies(Option<Vec<ScalingPolicy>>):Information about the scaling policies.
next_token(Option<String>):The token required to get the next set of results. This value is
nullif there are no more results to return.
- On failure, responds with
SdkError<DescribeScalingPoliciesError>
Constructs a fluent builder for the DescribeScheduledActions operation.
This operation supports pagination; See into_paginator().
- The fluent builder is configurable:
scheduled_action_names(Vec<String>)/set_scheduled_action_names(Option<Vec<String>>):The names of the scheduled actions to describe.
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.resource_id(impl Into<String>)/set_resource_id(Option<String>):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
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
max_results(i32)/set_max_results(Option<i32>):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
MaxResultsresults at a time, along with aNextTokenvalue. To get the next set of results, include theNextTokenvalue in a subsequent call. If this parameter is not used, the operation returns up to 50 results and aNextTokenvalue, if applicable.next_token(impl Into<String>)/set_next_token(Option<String>):The token for the next set of results.
- On success, responds with
DescribeScheduledActionsOutputwith field(s):scheduled_actions(Option<Vec<ScheduledAction>>):Information about the scheduled actions.
next_token(Option<String>):The token required to get the next set of results. This value is
nullif there are no more results to return.
- On failure, responds with
SdkError<DescribeScheduledActionsError>
Constructs a fluent builder for the PutScalingPolicy operation.
- The fluent builder is configurable:
policy_name(impl Into<String>)/set_policy_name(Option<String>):The name of the scaling policy.
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.resource_id(impl Into<String>)/set_resource_id(Option<String>):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
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
policy_type(PolicyType)/set_policy_type(Option<PolicyType>):The policy type. This parameter is required if you are creating a scaling policy.
The following policy types are supported:
TargetTrackingScaling—Not supported for Amazon EMRStepScaling—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.
step_scaling_policy_configuration(StepScalingPolicyConfiguration)/set_step_scaling_policy_configuration(Option<StepScalingPolicyConfiguration>):A step scaling policy.
This parameter is required if you are creating a policy and the policy type is
StepScaling.target_tracking_scaling_policy_configuration(TargetTrackingScalingPolicyConfiguration)/set_target_tracking_scaling_policy_configuration(Option<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.
- On success, responds with
PutScalingPolicyOutputwith field(s):policy_arn(Option<String>):The Amazon Resource Name (ARN) of the resulting scaling policy.
alarms(Option<Vec<Alarm>>):The CloudWatch alarms created for the target tracking scaling policy.
- On failure, responds with
SdkError<PutScalingPolicyError>
Constructs a fluent builder for the PutScheduledAction operation.
- The fluent builder is configurable:
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.schedule(impl Into<String>)/set_schedule(Option<String>):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(impl Into<String>)/set_timezone(Option<String>):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+9orPacific/Tahiti). For more information, see https://www.joda.org/joda-time/timezones.html.scheduled_action_name(impl Into<String>)/set_scheduled_action_name(Option<String>):The name of the scheduled action. This name must be unique among all other scheduled actions on the specified scalable target.
resource_id(impl Into<String>)/set_resource_id(Option<String>):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
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
start_time(DateTime)/set_start_time(Option<DateTime>):The date and time for this scheduled action to start, in UTC.
end_time(DateTime)/set_end_time(Option<DateTime>):The date and time for the recurring schedule to end, in UTC.
scalable_target_action(ScalableTargetAction)/set_scalable_target_action(Option<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.
- On success, responds with
PutScheduledActionOutput - On failure, responds with
SdkError<PutScheduledActionError>
Constructs a fluent builder for the RegisterScalableTarget operation.
- The fluent builder is configurable:
service_namespace(ServiceNamespace)/set_service_namespace(Option<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-resourceinstead.resource_id(impl Into<String>)/set_resource_id(Option<String>):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
serviceand the unique identifier is the cluster name and service name. Example:service/default/sample-webapp. -
Spot Fleet - The resource type is
spot-fleet-requestand 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
instancegroupand 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
fleetand the unique identifier is the fleet name. Example:fleet/sample-fleet. -
DynamoDB table - The resource type is
tableand the unique identifier is the table name. Example:table/my-table. -
DynamoDB global secondary index - The resource type is
indexand the unique identifier is the index name. Example:table/my-table/index/my-table-index. -
Aurora DB cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:my-db-cluster. -
SageMaker endpoint variant - The resource type is
variantand 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
OutputValuefrom 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
functionand the unique identifier is the function name with a function version or alias name suffix that is not$LATEST. Example:function:my-function:prodorfunction:my-function:1. -
Amazon Keyspaces table - The resource type is
tableand 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-groupand the unique identifier is the replication group name. Example:replication-group/mycluster. -
Neptune cluster - The resource type is
clusterand the unique identifier is the cluster name. Example:cluster:mycluster.
-
scalable_dimension(ScalableDimension)/set_scalable_dimension(Option<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 an 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.
-
min_capacity(i32)/set_min_capacity(Option<i32>):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 certain resources, the minimum value allowed is 0. This includes Lambda provisioned concurrency, Spot Fleet, ECS services, Aurora DB clusters, EMR clusters, and custom resources. For all other resources, the minimum value allowed is 1.
max_capacity(i32)/set_max_capacity(Option<i32>):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 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.
role_arn(impl Into<String>)/set_role_arn(Option<String>):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.
suspended_state(SuspendedState)/set_suspended_state(Option<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
truesuspends the specified scaling activities. Setting it tofalse(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.
-
- On success, responds with
RegisterScalableTargetOutput - On failure, responds with
SdkError<RegisterScalableTargetError>
Creates a client with the given service config and connector override.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for Client<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for Client<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more