diff --git a/codegen/sdk-codegen/aws-models/application-auto-scaling.json b/codegen/sdk-codegen/aws-models/application-auto-scaling.json index fe417d8d90e..1cc31a38a78 100644 --- a/codegen/sdk-codegen/aws-models/application-auto-scaling.json +++ b/codegen/sdk-codegen/aws-models/application-auto-scaling.json @@ -147,7 +147,7 @@ "name": "application-autoscaling" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "
With Application Auto Scaling, you can configure automatic scaling for the following\n resources:
\nAmazon AppStream 2.0 fleets
\nAmazon Aurora Replicas
\nAmazon Comprehend document classification and entity recognizer endpoints
\nAmazon DynamoDB tables and global secondary indexes throughput capacity
\nAmazon ECS services
\nAmazon ElastiCache for Redis clusters (replication groups)
\nAmazon EMR clusters
\nAmazon Keyspaces (for Apache Cassandra) tables
\nLambda function provisioned concurrency
\nAmazon Managed Streaming for Apache Kafka broker storage
\nAmazon Neptune clusters
\nAmazon SageMaker endpoint variants
\nAmazon SageMaker inference components
\nAmazon SageMaker serverless endpoint provisioned concurrency
\nSpot Fleets (Amazon EC2)
\nWorkSpaces pools
\nCustom resources provided by your own applications or services
\nTo learn more about Application Auto Scaling, see the Application Auto Scaling User\n Guide.
\n\n API Summary\n
\nThe Application Auto Scaling service API includes three key sets of actions:
\nRegister and manage scalable targets - Register Amazon Web Services or custom resources as scalable\n targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and\n retrieve information on existing scalable targets.
\nConfigure and manage automatic scaling - Define scaling policies to dynamically scale\n your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions,\n and retrieve your recent scaling activity history.
\nSuspend and resume scaling - Temporarily suspend and later resume automatic scaling by\n calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can\n suspend and resume (individually or in combination) scale-out activities that are\n triggered by a scaling policy, scale-in activities that are triggered by a scaling policy,\n and scheduled scaling.
\nWith Application Auto Scaling, you can configure automatic scaling for the following\n resources:
\nAmazon AppStream 2.0 fleets
\nAmazon Aurora Replicas
\nAmazon Comprehend document classification and entity recognizer endpoints
\nAmazon DynamoDB tables and global secondary indexes throughput capacity
\nAmazon ECS services
\nAmazon ElastiCache for Redis clusters (replication groups)
\nAmazon EMR clusters
\nAmazon Keyspaces (for Apache Cassandra) tables
\nLambda function provisioned concurrency
\nAmazon Managed Streaming for Apache Kafka broker storage
\nAmazon Neptune clusters
\nAmazon SageMaker endpoint variants
\nAmazon SageMaker inference components
\nAmazon SageMaker serverless endpoint provisioned concurrency
\nSpot Fleets (Amazon EC2)
\nPool of WorkSpaces
\nCustom resources provided by your own applications or services
\nTo learn more about Application Auto Scaling, see the Application Auto Scaling User\n Guide.
\n\n API Summary\n
\nThe Application Auto Scaling service API includes three key sets of actions:
\nRegister and manage scalable targets - Register Amazon Web Services or custom resources as scalable\n targets (a resource that Application Auto Scaling can scale), set minimum and maximum capacity limits, and\n retrieve information on existing scalable targets.
\nConfigure and manage automatic scaling - Define scaling policies to dynamically scale\n your resources in response to CloudWatch alarms, schedule one-time or recurring scaling actions,\n and retrieve your recent scaling activity history.
\nSuspend and resume scaling - Temporarily suspend and later resume automatic scaling by\n calling the RegisterScalableTarget API action for any Application Auto Scaling scalable target. You can\n suspend and resume (individually or in combination) scale-out activities that are\n triggered by a scaling policy, scale-in activities that are triggered by a scaling policy,\n and scheduled scaling.
\nThe identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension associated with the scalable target.\n 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.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension associated with the scalable target.\n 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.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.\n If you specify a scalable dimension, you must also specify a resource ID.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scheduled action.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource that is associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scalable target.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension associated with the scalable target.\n This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scaling activity.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Amazon WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The identifier of the resource associated with the scaling policy.\n This string consists of the resource type and unique identifier.
\nECS service - The resource type is service
and the unique identifier is the cluster name \n and service name. Example: service/my-cluster/my-service
.
Spot Fleet - The resource type is spot-fleet-request
and the unique identifier is the \n 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.\n Example: instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0
.
AppStream 2.0 fleet - The resource type is fleet
and the unique identifier is the fleet name.\n Example: fleet/sample-fleet
.
DynamoDB table - The resource type is table
and the unique identifier is the table name. \n Example: table/my-table
.
DynamoDB global secondary index - The resource type is index
and the unique identifier is the index name. \n Example: table/my-table/index/my-table-index
.
Aurora DB cluster - The resource type is cluster
and the unique identifier is the cluster name.\n Example: cluster:my-db-cluster
.
SageMaker endpoint variant - The resource type is variant
and the unique identifier is the resource ID.\n 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\n is available in our GitHub\n 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
. \n 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. \n Example: keyspace/mykeyspace/table/mytable
.
Amazon MSK cluster - The resource type and unique identifier are specified using the cluster ARN. \n 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.\n 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.\n Example: endpoint/my-end-point/variant/KMeansClustering
.
SageMaker inference component - The resource type is inference-component
and the unique identifier is the resource ID.\n Example: inference-component/my-inference-component
.
Pool of WorkSpaces - The resource type is workspacespool
and the unique identifier is the pool ID. \n Example: workspacespool/wspool-123456
.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The capacity of a WorkSpaces pool.
The scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The task count of an ECS service.
\n elasticmapreduce:instancegroup:InstanceCount
- The instance count of an EMR Instance Group.
\n ec2:spot-fleet-request:TargetCapacity
- The target capacity of a Spot Fleet.
\n appstream:fleet:DesiredCapacity
- The capacity of an AppStream 2.0 fleet.
\n dynamodb:table:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB table.
\n dynamodb:table:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB table.
\n dynamodb:index:ReadCapacityUnits
- The provisioned read capacity for a DynamoDB global secondary index.
\n dynamodb:index:WriteCapacityUnits
- The provisioned write capacity for a DynamoDB global secondary index.
\n rds:cluster:ReadReplicaCount
- The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.
\n sagemaker:variant:DesiredInstanceCount
- The number of EC2 instances for a SageMaker model endpoint variant.
\n custom-resource:ResourceType:Property
- The scalable dimension for a custom resource provided by your own application or service.
\n comprehend:document-classifier-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend document classification endpoint.
\n comprehend:entity-recognizer-endpoint:DesiredInferenceUnits
- The number of inference units for an Amazon Comprehend entity recognizer endpoint.
\n lambda:function:ProvisionedConcurrency
- The provisioned concurrency for a Lambda function.
\n cassandra:table:ReadCapacityUnits
- The provisioned read capacity for an Amazon Keyspaces table.
\n cassandra:table:WriteCapacityUnits
- The provisioned write capacity for an Amazon Keyspaces table.
\n kafka:broker-storage:VolumeSize
- The provisioned volume size (in GiB) for brokers in an Amazon MSK cluster.
\n elasticache:replication-group:NodeGroups
- The number of node groups for an Amazon ElastiCache replication group.
\n elasticache:replication-group:Replicas
- The number of replicas per node group for an Amazon ElastiCache replication group.
\n neptune:cluster:ReadReplicaCount
- The count of read replicas in an Amazon Neptune DB cluster.
\n sagemaker:variant:DesiredProvisionedConcurrency
- The provisioned concurrency for a SageMaker serverless endpoint.
\n sagemaker:inference-component:DesiredCopyCount
- The number of copies across an endpoint for a SageMaker inference component.
\n workspaces:workspacespool:DesiredUserSessions
- The number of user sessions for the WorkSpaces in the pool.
Information about an association between a Direct Connect gateway and a virtual gateway or transit gateway.
" + } } }, "traits": { @@ -151,7 +154,7 @@ ], "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "Deprecated. Use AllocateHostedConnection instead.
\nCreates a hosted connection on an interconnect.
\nAllocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
\nIntended for use by Direct Connect Partners only.
\nDeprecated. Use AllocateHostedConnection instead.
\nCreates a hosted connection on an interconnect.
\nAllocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.
\nIntended for use by Direct Connect Partners only.
\nThe bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.
", + "smithy.api#documentation": "The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps,\n 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Note that only those\n Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps,\n 10Gbps, or 25Gbps hosted connection.
", "smithy.api#required": {} } }, @@ -443,7 +446,10 @@ "type": "structure", "members": { "virtualInterface": { - "target": "com.amazonaws.directconnect#VirtualInterface" + "target": "com.amazonaws.directconnect#VirtualInterface", + "traits": { + "smithy.api#documentation": "Information about the transit virtual interface.
" + } } }, "traits": { @@ -1735,7 +1741,7 @@ "bandwidth": { "target": "com.amazonaws.directconnect#Bandwidth", "traits": { - "smithy.api#documentation": "The port bandwidth, in Gbps. The possible values are 1 and 10.
", + "smithy.api#documentation": "The port bandwidth, in Gbps. The possible values are 1, 10, and 100.
", "smithy.api#required": {} } }, @@ -1792,7 +1798,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a link aggregation group (LAG) with the specified number of bundled\n physical dedicated connections between the customer network and a specific Direct Connect location.\n A LAG is a logical interface that uses the Link Aggregation Control Protocol\n (LACP) to aggregate multiple interfaces, enabling you to treat them as a single \n interface.
\nAll connections in a LAG must use the same bandwidth (either 1Gbps or 10Gbps) and must terminate at the same Direct Connect endpoint.
\nYou can have up to 10 dedicated connections per LAG. Regardless of this limit, if you\n request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is\n created.
\nYou can specify an existing physical dedicated connection or interconnect to include in\n the LAG (which counts towards the total number of connections). Doing so interrupts the\n current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG\n will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any\n virtual interfaces associated with the dedicated connection are automatically disassociated\n and re-associated with the LAG. The connection ID does not change.
\nIf the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is \n automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual \n interfaces cannot be directly configured.
" + "smithy.api#documentation": "Creates a link aggregation group (LAG) with the specified number of bundled\n physical dedicated connections between the customer network and a specific Direct Connect location.\n A LAG is a logical interface that uses the Link Aggregation Control Protocol\n (LACP) to aggregate multiple interfaces, enabling you to treat them as a single \n interface.
\nAll connections in a LAG must use the same bandwidth (either 1Gbps, 10Gbps, 100Gbps,\n or 400Gbps) and must terminate at the same Direct Connect endpoint.
\nYou can have up to 10 dedicated connections per location. Regardless of this limit, if you\n request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is\n created..
\nYou can specify an existing physical dedicated connection or interconnect to include in\n the LAG (which counts towards the total number of connections). Doing so interrupts the\n current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG\n will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any\n virtual interfaces associated with the dedicated connection are automatically disassociated\n and re-associated with the LAG. The connection ID does not change.
\nIf the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is \n automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual \n interfaces cannot be directly configured.
" } }, "com.amazonaws.directconnect#CreateLagRequest": { @@ -1802,7 +1808,7 @@ "target": "com.amazonaws.directconnect#Count", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of physical dedicated connections initially provisioned and bundled by the\n LAG. You can have a maximum of four connections when the port speed is 1G or 10G, or two when the port speed is 100G.
", + "smithy.api#documentation": "The number of physical dedicated connections initially provisioned and bundled by the LAG.\n You can have a maximum of four connections when the port speed is 1Gbps or 10Gbps, or two when\n the port speed is 100Gbps or 400Gbps.
", "smithy.api#required": {} } }, @@ -1816,7 +1822,7 @@ "connectionsBandwidth": { "target": "com.amazonaws.directconnect#Bandwidth", "traits": { - "smithy.api#documentation": "The bandwidth of the individual physical dedicated connections bundled by the LAG. The\n possible values are 1Gbps and 10Gbps.
", + "smithy.api#documentation": "The bandwidth of the individual physical dedicated connections bundled by the LAG. The\n possible values are 1Gbps,10Gbps, 100Gbps, and 400Gbps.
", "smithy.api#required": {} } }, @@ -1885,7 +1891,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic.\n A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW).\n Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple \n VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface \n to a VGW only provides access to a single VPC within the same Region.
\nSetting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to\n the underlying physical connection if it wasn't updated to support jumbo frames. Updating \n the connection disrupts network connectivity for all virtual interfaces associated with \n the connection for up to 30 seconds. To check whether your connection supports jumbo \n frames, call DescribeConnections. To check whether your virtual \n interface supports jumbo frames, call DescribeVirtualInterfaces.
" + "smithy.api#documentation": "Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic.\n A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW).\n Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple \n VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface \n to a VGW only provides access to a single VPC within the same Region.
\nSetting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to\n the underlying physical connection if it wasn't updated to support jumbo frames. Updating \n the connection disrupts network connectivity for all virtual interfaces associated with \n the connection for up to 30 seconds. To check whether your connection supports jumbo \n frames, call DescribeConnections. To check whether your virtual \n interface supports jumbo frames, call DescribeVirtualInterfaces.
" } }, "com.amazonaws.directconnect#CreatePrivateVirtualInterfaceRequest": { @@ -2010,7 +2016,10 @@ "type": "structure", "members": { "virtualInterface": { - "target": "com.amazonaws.directconnect#VirtualInterface" + "target": "com.amazonaws.directconnect#VirtualInterface", + "traits": { + "smithy.api#documentation": "Information about a virtual interface.
" + } } }, "traits": { @@ -2451,7 +2460,7 @@ ], "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "Deprecated. Use DescribeLoa instead.
\nGets the LOA-CFA for a connection.
\nThe Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or\n service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information,\n see Requesting Cross Connects\n at Direct Connect Locations in the Direct Connect User Guide.
" + "smithy.api#documentation": "Deprecated. Use DescribeLoa instead.
\nGets the LOA-CFA for a connection.
\nThe Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or\n service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information,\n see Requesting Cross Connects\n at Direct Connect Locations in the Direct Connect User Guide.
" } }, "com.amazonaws.directconnect#DescribeConnectionLoaRequest": { @@ -2559,7 +2568,7 @@ ], "traits": { "smithy.api#deprecated": {}, - "smithy.api#documentation": "Deprecated. Use DescribeHostedConnections instead.
\nLists the connections that have been provisioned on the specified interconnect.
\nIntended for use by Direct Connect Partners only.
\nDeprecated. Use DescribeHostedConnections instead.
\nLists the connections that have been provisioned on the specified interconnect.
\nIntended for use by Direct Connect Partners only.
\nDeprecated. Use DescribeLoa instead.
\nGets the LOA-CFA for the specified interconnect.
\nThe Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility.\n For more information, see Requesting Cross Connects at Direct Connect Locations\n in the Direct Connect User Guide.
" + "smithy.api#documentation": "Deprecated. Use DescribeLoa instead.
\nGets the LOA-CFA for the specified interconnect.
\nThe Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility.\n For more information, see Requesting Cross Connects at Direct Connect Locations\n in the Direct Connect User Guide.
" } }, "com.amazonaws.directconnect#DescribeInterconnectLoaRequest": { @@ -3303,7 +3312,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the virtual private gateways owned by the Amazon Web Services account.
\nYou can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
" + "smithy.api#documentation": "Deprecated. Use DescribeVpnGateways
instead. See DescribeVPNGateways in the Amazon Elastic Compute Cloud API Reference.
Lists the virtual private gateways owned by the Amazon Web Services account.
\nYou can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.
" } }, "com.amazonaws.directconnect#DescribeVirtualInterfaces": { @@ -4106,14 +4115,14 @@ "connectionsBandwidth": { "target": "com.amazonaws.directconnect#Bandwidth", "traits": { - "smithy.api#documentation": "The individual bandwidth of the physical connections bundled by the LAG. The possible\n values are 1Gbps and 10Gbps.
" + "smithy.api#documentation": "The individual bandwidth of the physical connections bundled by the LAG. The possible\n values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..
" } }, "numberOfConnections": { "target": "com.amazonaws.directconnect#Count", "traits": { "smithy.api#default": 0, - "smithy.api#documentation": "The number of physical dedicated connections bundled by the LAG, up to a maximum of 10.
" + "smithy.api#documentation": "The number of physical dedicated connections initially provisioned and bundled by the LAG.\n You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two\n when the port speed is 100 Gbps or 400 Gbps.
" } }, "lagId": { @@ -4613,7 +4622,7 @@ "mtu": { "target": "com.amazonaws.directconnect#MTU", "traits": { - "smithy.api#documentation": "The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
" + "smithy.api#documentation": "The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.
" } }, "authKey": { @@ -4698,7 +4707,7 @@ "mtu": { "target": "com.amazonaws.directconnect#MTU", "traits": { - "smithy.api#documentation": "The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
" + "smithy.api#documentation": "The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.
" } }, "authKey": { @@ -6801,7 +6810,10 @@ "type": "structure", "members": { "directConnectGatewayAssociation": { - "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociation" + "target": "com.amazonaws.directconnect#DirectConnectGatewayAssociation", + "traits": { + "smithy.api#documentation": "Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
" + } } }, "traits": { @@ -6834,7 +6846,10 @@ "type": "structure", "members": { "directConnectGateway": { - "target": "com.amazonaws.directconnect#DirectConnectGateway" + "target": "com.amazonaws.directconnect#DirectConnectGateway", + "traits": { + "smithy.api#documentation": "Informaiton about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateways or transit gateways.
" + } } }, "traits": { @@ -6912,7 +6927,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the specified attributes of the specified virtual private interface.
\nSetting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to\n the underlying physical connection if it wasn't updated to support jumbo frames. Updating \n the connection disrupts network connectivity for all virtual interfaces associated with \n the connection for up to 30 seconds. To check whether your connection supports jumbo \n frames, call DescribeConnections. To check whether your virtual \n interface supports jumbo frames, call DescribeVirtualInterfaces.
" + "smithy.api#documentation": "Updates the specified attributes of the specified virtual private interface.
\nSetting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to\n the underlying physical connection if it wasn't updated to support jumbo frames. Updating \n the connection disrupts network connectivity for all virtual interfaces associated with \n the connection for up to 30 seconds. To check whether your connection supports jumbo \n frames, call DescribeConnections. To check whether your virtual \n interface supports jumbo frames, call DescribeVirtualInterfaces.
" } }, "com.amazonaws.directconnect#UpdateVirtualInterfaceAttributesRequest": { @@ -6928,7 +6943,7 @@ "mtu": { "target": "com.amazonaws.directconnect#MTU", "traits": { - "smithy.api#documentation": "The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
" + "smithy.api#documentation": "The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.
" } }, "enableSiteLink": { @@ -7036,7 +7051,7 @@ "virtualInterfaceType": { "target": "com.amazonaws.directconnect#VirtualInterfaceType", "traits": { - "smithy.api#documentation": "The type of virtual interface. The possible values are private
and public
.
The type of virtual interface. The possible values are private
, public
and transit
.
Attaches a policy to a root, an organizational unit (OU), or an individual account.\n How the policy affects accounts depends on the type of policy. Refer to the\n Organizations User Guide for information about each policy type:
\n\n BACKUP_POLICY\n
\n\n TAG_POLICY\n
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", "smithy.api#examples": [ { - "title": "To attach a policy to an OU", - "documentation": "The following example shows how to attach a service control policy (SCP) to an OU:\n", + "title": "To attach a policy to an account", + "documentation": "The following example shows how to attach a service control policy (SCP) to an account:\n", "input": { - "TargetId": "ou-examplerootid111-exampleouid111", + "TargetId": "333333333333", "PolicyId": "p-examplepolicyid111" } }, { - "title": "To attach a policy to an account", - "documentation": "The following example shows how to attach a service control policy (SCP) to an account:\n", + "title": "To attach a policy to an OU", + "documentation": "The following example shows how to attach a service control policy (SCP) to an OU:\n", "input": { - "TargetId": "333333333333", + "TargetId": "ou-examplerootid111-exampleouid111", "PolicyId": "p-examplepolicyid111" } } @@ -2028,7 +2028,7 @@ } }, "traits": { - "smithy.api#documentation": "Performing this operation violates a minimum or maximum value limit. For example,\n attempting to remove the last service control policy (SCP) from an OU or root, inviting\n or creating too many accounts to the organization, or attaching too many policies to an\n account, OU, or root. This exception includes a reason that contains additional\n information about the violated limit:
\nSome of the reasons in the following list might not be applicable to this specific\n API or operation.
\nACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management\n account from the organization. You can't remove the management account. Instead,\n after you remove all member accounts, delete the organization itself.
\nACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an\n account from the organization that doesn't yet have enough information to exist\n as a standalone account. This account requires you to first complete phone\n verification. Follow the steps at Removing a member account from your organization in the\n Organizations User Guide.
\nACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can create in one day.
\nACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your\n account isn't fully active. You must complete the account setup before you\n create an organization.
\nACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number\n of accounts in an organization. If you need more accounts, contact Amazon Web Services Support to\n request an increase in your limit.
\nOr the number of invitations that you tried to send would cause you to exceed\n the limit of accounts in your organization. Send fewer invitations or contact\n Amazon Web Services Support to request an increase in the number of accounts.
\nDeleted and closed accounts still count toward your limit.
\nIf you get this exception when running a command immediately after\n creating the organization, wait one hour and try again. After an hour, if\n the command continues to fail with this error, contact Amazon Web Services Support.
\nCANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot\n register a suspended account as a delegated administrator.
\nCANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register\n the management account of the organization as a delegated administrator for an\n Amazon Web Services service integrated with Organizations. You can designate only a member account as a\n delegated administrator.
\nCANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management\n account. To close the management account for the organization, you must first\n either remove or close all member accounts in the organization. Follow standard\n account closure process using root credentials.
\nCANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an\n account that is registered as a delegated administrator for a service integrated\n with your organization. To complete this operation, you must first deregister\n this account as a delegated administrator.
\nCLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the\n past 30 days.
\nCLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can close at a time.
\nCREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an\n organization in the specified region, you must enable all features mode.
\nDELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an\n Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has\n a delegated administrator. To complete this operation, you must first deregister\n any existing delegated administrators for this service.
\nEMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for\n a limited period of time. You must resubmit the request and generate a new\n verfication code.
\nHANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n handshakes that you can send in one day.
\nINVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported\n payment method is associated with the account. Amazon Web Services does not support cards\n issued by financial institutions in Russia or Belarus. For more information, see\n Managing your\n Amazon Web Services payments.
\nMASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in\n this organization, you first must migrate the organization's management account\n to the marketplace that corresponds to the management account's address. For\n example, accounts with India addresses must be associated with the AISPL\n marketplace. All accounts in an organization must be associated with the same\n marketplace.
\nMASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions\n in China. To create an organization, the master must have a valid business\n license. For more information, contact customer support.
\nMASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must\n first provide a valid contact address and phone number for the management\n account. Then try the operation again.
\nMASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the\n management account must have an associated account in the Amazon Web Services GovCloud\n (US-West) Region. For more information, see Organizations\n in the \n Amazon Web Services GovCloud User Guide.
\nMASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with\n this management account, you first must associate a valid payment instrument,\n such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in\n the Organizations User Guide.
\nMAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to\n register more delegated administrators than allowed for the service principal.\n
\nMAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number\n of policies of a certain type that can be attached to an entity at one\n time.
\nMAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this\n resource.
\nMEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with\n this member account, you first must associate a valid payment instrument, such\n as a credit card, with the account. For more information, see Considerations before removing an account from an organization in\n the Organizations User Guide.
\nMIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy\n from an entity that would cause the entity to have fewer than the minimum number\n of policies of a certain type required.
\nORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation\n that requires the organization to be configured to support all features. An\n organization that supports only consolidated billing features can't perform this\n operation.
\nOU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many\n levels deep.
\nOU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you\n can have in an organization.
\nPOLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger\n than the maximum size.
\nPOLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies\n that you can have in an organization.
\nSERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated\n administrator before you enabled service access. Call the\n EnableAWSServiceAccess
API first.
TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags\n that are not compliant with the tag policy requirements for this account.
\nWAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, there is a waiting\n period before you can remove it from the organization. If you get an error that\n indicates that a wait period is required, try again in a few days.
\nPerforming this operation violates a minimum or maximum value limit. For example,\n attempting to remove the last service control policy (SCP) from an OU or root, inviting\n or creating too many accounts to the organization, or attaching too many policies to an\n account, OU, or root. This exception includes a reason that contains additional\n information about the violated limit:
\nSome of the reasons in the following list might not be applicable to this specific\n API or operation.
\nACCOUNT_CANNOT_LEAVE_ORGANIZATION: You attempted to remove the management\n account from the organization. You can't remove the management account. Instead,\n after you remove all member accounts, delete the organization itself.
\nACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an\n account from the organization that doesn't yet have enough information to exist\n as a standalone account. This account requires you to first complete phone\n verification. Follow the steps at Removing a member account from your organization in the\n Organizations User Guide.
\nACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can create in one day.
\nACCOUNT_CREATION_NOT_COMPLETE: Your account setup isn't complete or your\n account isn't fully active. You must complete the account setup before you\n create an organization.
\nACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number\n of accounts in an organization. If you need more accounts, contact Amazon Web Services Support to\n request an increase in your limit.
\nOr the number of invitations that you tried to send would cause you to exceed\n the limit of accounts in your organization. Send fewer invitations or contact\n Amazon Web Services Support to request an increase in the number of accounts.
\nDeleted and closed accounts still count toward your limit.
\nIf you get this exception when running a command immediately after\n creating the organization, wait one hour and try again. After an hour, if\n the command continues to fail with this error, contact Amazon Web Services Support.
\nCANNOT_REGISTER_SUSPENDED_ACCOUNT_AS_DELEGATED_ADMINISTRATOR: You cannot\n register a suspended account as a delegated administrator.
\nCANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register\n the management account of the organization as a delegated administrator for an\n Amazon Web Services service integrated with Organizations. You can designate only a member account as a\n delegated administrator.
\nCANNOT_CLOSE_MANAGEMENT_ACCOUNT: You attempted to close the management\n account. To close the management account for the organization, you must first\n either remove or close all member accounts in the organization. Follow standard\n account closure process using root credentials.
\nCANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an\n account that is registered as a delegated administrator for a service integrated\n with your organization. To complete this operation, you must first deregister\n this account as a delegated administrator.
\nCLOSE_ACCOUNT_QUOTA_EXCEEDED: You have exceeded close account quota for the\n past 30 days.
\nCLOSE_ACCOUNT_REQUESTS_LIMIT_EXCEEDED: You attempted to exceed the number of\n accounts that you can close at a time.
\nCREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an\n organization in the specified region, you must enable all features mode.
\nDELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an\n Amazon Web Services account as a delegated administrator for an Amazon Web Services service that already has\n a delegated administrator. To complete this operation, you must first deregister\n any existing delegated administrators for this service.
\nEMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for\n a limited period of time. You must resubmit the request and generate a new\n verfication code.
\nHANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of\n handshakes that you can send in one day.
\nINVALID_PAYMENT_INSTRUMENT: You cannot remove an account because no supported\n payment method is associated with the account. Amazon Web Services does not support cards\n issued by financial institutions in Russia or Belarus. For more information, see\n Managing your\n Amazon Web Services payments.
\nMASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in\n this organization, you first must migrate the organization's management account\n to the marketplace that corresponds to the management account's address. All\n accounts in an organization must be associated with the same marketplace.
\nMASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the Amazon Web Services Regions in\n China. To create an organization, the master must have a valid business license.\n For more information, contact customer support.
\nMASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must\n first provide a valid contact address and phone number for the management\n account. Then try the operation again.
\nMASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the\n management account must have an associated account in the Amazon Web Services GovCloud\n (US-West) Region. For more information, see Organizations\n in the \n Amazon Web Services GovCloud User Guide.
\nMASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with\n this management account, you first must associate a valid payment instrument,\n such as a credit card, with the account. For more information, see Considerations before removing an account from an organization in\n the Organizations User Guide.
\nMAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to\n register more delegated administrators than allowed for the service principal.\n
\nMAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number\n of policies of a certain type that can be attached to an entity at one\n time.
\nMAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this\n resource.
\nMEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with\n this member account, you first must associate a valid payment instrument, such\n as a credit card, with the account. For more information, see Considerations before removing an account from an organization in\n the Organizations User Guide.
\nMIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy\n from an entity that would cause the entity to have fewer than the minimum number\n of policies of a certain type required.
\nORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation\n that requires the organization to be configured to support all features. An\n organization that supports only consolidated billing features can't perform this\n operation.
\nOU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many\n levels deep.
\nOU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you\n can have in an organization.
\nPOLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger\n than the maximum size.
\nPOLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies\n that you can have in an organization.
\nSERVICE_ACCESS_NOT_ENABLED: You attempted to register a delegated\n administrator before you enabled service access. Call the\n EnableAWSServiceAccess
API first.
TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags\n that are not compliant with the tag policy requirements for this account.
\nWAIT_PERIOD_ACTIVE: After you create an Amazon Web Services account, there is a waiting\n period before you can remove it from the organization. If you get an error that\n indicates that a wait period is required, try again in a few days.
\nCreates an Amazon Web Services account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CreateAccount
operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:
Use the Id
value of the CreateAccountStatus
response\n element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the CloudTrail log for the CreateAccountResult
event. For\n information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.
The user who calls the API to create an account must have the\n organizations:CreateAccount
permission. If you enabled all features in\n the organization, Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations
. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.
If the request includes tags, then the requester must have the\n organizations:TagResource
permission.
Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole
by default) that grants users in the\n management account administrator permissions in the new member account. Principals in\n the management account can assume the role. Organizations clones the company name and address\n information for the new account from the organization's management account.
This operation can be called only from the organization's management account.
\nFor more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.
\nWhen you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate\n as a standalone account, such as a payment method and signing the end user\n license agreement (EULA) is not automatically\n collected. If you must remove an account from your organization later, you\n can do so only after you provide the missing information. For more\n information, see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nIf you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.
\nIf you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.
\nUsing CreateAccount
to create multiple temporary accounts\n isn't recommended. You can only close an account from the Billing and Cost Management console, and\n you must be signed in as the root user. For information on the requirements\n and process for closing an account, see Closing a member\n account in your organization in the\n Organizations User Guide.
When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting access to\n your billing information and tools.
\nCreates an Amazon Web Services account that is automatically a member of the organization whose\n credentials made the request. This is an asynchronous request that Amazon Web Services performs in the\n background. Because CreateAccount
operates asynchronously, it can return a\n successful completion message even though account initialization might still be in\n progress. You might need to wait a few minutes before you can successfully access the\n account. To check the status of the request, do one of the following:
Use the Id
value of the CreateAccountStatus
response\n element from this operation to provide as a parameter to the DescribeCreateAccountStatus operation.
Check the CloudTrail log for the CreateAccountResult
event. For\n information on using CloudTrail with Organizations, see Logging and monitoring in Organizations in the\n Organizations User Guide.
The user who calls the API to create an account must have the\n organizations:CreateAccount
permission. If you enabled all features in\n the organization, Organizations creates the required service-linked role named\n AWSServiceRoleForOrganizations
. For more information, see Organizations and service-linked roles in the\n Organizations User Guide.
If the request includes tags, then the requester must have the\n organizations:TagResource
permission.
Organizations preconfigures the new member account with a role (named\n OrganizationAccountAccessRole
by default) that grants users in the\n management account administrator permissions in the new member account. Principals in\n the management account can assume the role. Organizations clones the company name and address\n information for the new account from the organization's management account.
This operation can be called only from the organization's management account.
\nFor more information about creating accounts, see Creating\n a member account in your organization in the\n Organizations User Guide.
\nWhen you create an account in an organization using the Organizations console,\n API, or CLI commands, the information required for the account to operate\n as a standalone account, such as a payment method is not automatically\n collected. If you must remove an account from your organization later, you\n can do so only after you provide the missing information. For more\n information, see Considerations before removing an account from an organization\n in the Organizations User Guide.
\nIf you get an exception that indicates that you exceeded your account\n limits for the organization, contact Amazon Web Services Support.
\nIf you get an exception that indicates that the operation failed because\n your organization is still initializing, wait one hour and then try again.\n If the error persists, contact Amazon Web Services Support.
\nUsing CreateAccount
to create multiple temporary accounts\n isn't recommended. You can only close an account from the Billing and Cost Management console, and\n you must be signed in as the root user. For information on the requirements\n and process for closing an account, see Closing a member\n account in your organization in the\n Organizations User Guide.
When you create a member account with this operation, you can choose whether to\n create the account with the IAM User and Role Access to\n Billing Information switch enabled. If you enable it, IAM users and\n roles that have appropriate permissions can view billing information for the\n account. If you disable it, only the account root user can access billing\n information. For information about how to disable this switch for an account, see\n Granting access to\n your billing information and tools.
\nLists the account creation requests that match the specified status that is currently\n being tracked for the organization.
\nAlways check the NextToken
response parameter \nfor a null
value when calling a List*
operation. These operations can \noccasionally return an empty set of results even when there are more results available. The \nNextToken
response parameter value is null
\n only \nwhen there are no more results to display.
This operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", "smithy.api#examples": [ { - "title": "To get a list of completed account creation requests made in the organization", - "documentation": "The following example shows a user requesting a list of only the completed account creation requests made for the current organization:", + "title": "To get a list of all account creation requests made in the organization", + "documentation": "The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization:", "input": { "States": [ - "SUCCEEDED" + "IN_PROGRESS" ] }, "output": { "CreateAccountStatuses": [ { - "Id": "car-exampleaccountcreationrequestid1", - "AccountId": "444444444444", - "AccountName": "Developer Test Account", + "State": "IN_PROGRESS", + "Id": "car-exampleaccountcreationrequestid2", "RequestedTimestamp": "2017-01-15T13:45:23.01Z", - "State": "SUCCEEDED", - "CompletedTimestamp": "2017-01-15T13:45:23.6Z" + "AccountName": "Production Account" } ] } }, { - "title": "To get a list of all account creation requests made in the organization", - "documentation": "The following example shows a user requesting a list of only the in-progress account creation requests made for the current organization:", + "title": "To get a list of completed account creation requests made in the organization", + "documentation": "The following example shows a user requesting a list of only the completed account creation requests made for the current organization:", "input": { "States": [ - "IN_PROGRESS" + "SUCCEEDED" ] }, "output": { "CreateAccountStatuses": [ { - "State": "IN_PROGRESS", - "Id": "car-exampleaccountcreationrequestid2", + "Id": "car-exampleaccountcreationrequestid1", + "AccountId": "444444444444", + "AccountName": "Developer Test Account", "RequestedTimestamp": "2017-01-15T13:45:23.01Z", - "AccountName": "Production Account" + "State": "SUCCEEDED", + "CompletedTimestamp": "2017-01-15T13:45:23.6Z" } ] } @@ -8843,16 +8849,15 @@ "smithy.api#documentation": "Updates an existing policy with a new name, description, or content. If you don't\n supply any parameter, that value remains unchanged. You can't change a policy's\n type.
\nThis operation can be called only from the organization's\nmanagement account or by a member account that is a delegated administrator for an Amazon Web Services service.
", "smithy.api#examples": [ { - "title": "To update the details of a policy", - "documentation": "The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n", + "title": "To update the content of a policy", + "documentation": "The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n", "input": { "PolicyId": "p-examplepolicyid111", - "Name": "Renamed-Policy", - "Description": "This description replaces the original." + "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": {\\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }" }, "output": { "Policy": { - "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"ec2:*\", \"Resource\": \"*\" } }", + "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": { \\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }", "PolicySummary": { "Id": "p-examplepolicyid111", "AwsManaged": false, @@ -8865,15 +8870,16 @@ } }, { - "title": "To update the content of a policy", - "documentation": "The following example shows how to replace the JSON text of the SCP from the preceding example with a new JSON policy text string that allows S3 actions instead of EC2 actions:/n/n", + "title": "To update the details of a policy", + "documentation": "The following example shows how to rename a policy and give it a new description and new content. The output confirms the new name and description text:/n/n", "input": { "PolicyId": "p-examplepolicyid111", - "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": {\\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }" + "Name": "Renamed-Policy", + "Description": "This description replaces the original." }, "output": { "Policy": { - "Content": "{ \\\"Version\\\": \\\"2012-10-17\\\", \\\"Statement\\\": { \\\"Effect\\\": \\\"Allow\\\", \\\"Action\\\": \\\"s3:*\\\", \\\"Resource\\\": \\\"*\\\" } }", + "Content": "{ \"Version\": \"2012-10-17\", \"Statement\": { \"Effect\": \"Allow\", \"Action\": \"ec2:*\", \"Resource\": \"*\" } }", "PolicySummary": { "Id": "p-examplepolicyid111", "AwsManaged": false, diff --git a/codegen/sdk-codegen/aws-models/rekognition.json b/codegen/sdk-codegen/aws-models/rekognition.json index dcc61af9ec9..291b9d3a94a 100644 --- a/codegen/sdk-codegen/aws-models/rekognition.json +++ b/codegen/sdk-codegen/aws-models/rekognition.json @@ -1550,6 +1550,12 @@ "smithy.api#documentation": "\nThe ARN of the Amazon Rekognition Custom Labels project to which you want to asssign the dataset.\n
", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.rekognition#TagMap", + "traits": { + "smithy.api#documentation": "A set of tags (key-value pairs) that you want to attach to the dataset.
" + } } }, "traits": { @@ -1729,6 +1735,12 @@ "traits": { "smithy.api#documentation": "Specifies whether automatic retraining should be attempted for the versions of the\n project. Automatic retraining is done as a best effort. Required argument for Content\n Moderation. Applicable only to adapters.
" } + }, + "Tags": { + "target": "com.amazonaws.rekognition#TagMap", + "traits": { + "smithy.api#documentation": "A set of tags (key-value pairs) that you want to attach to the project.
" + } } }, "traits": { @@ -4326,7 +4338,7 @@ "ModerationLabels": { "target": "com.amazonaws.rekognition#ModerationLabels", "traits": { - "smithy.api#documentation": "Array of detected Moderation labels and the time, in milliseconds from the start of the\n video, they were detected.
" + "smithy.api#documentation": "Array of detected Moderation labels. For video operations, this includes the time, \n in milliseconds from the start of the video, they were detected.
" } }, "ModerationModelVersion": { @@ -6311,7 +6323,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
\nThe label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId
). When\n the label detection operation finishes, Amazon Rekognition publishes a completion status to the\n Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection
.
To get the results of the label detection operation, first check that the status value\n published to the Amazon SNS topic is SUCCEEDED
. If so, call GetLabelDetection and pass the job identifier (JobId
) from the\n initial call to StartLabelDetection
.
\n GetLabelDetection
returns an array of detected labels\n (Labels
) sorted by the time the labels were detected. You can also sort by the\n label name by specifying NAME
for the SortBy
input parameter. If\n there is no NAME
specified, the default sort is by\n timestamp.
You can select how results are aggregated by using the AggregateBy
input\n parameter. The default aggregation method is TIMESTAMPS
. You can also aggregate\n by SEGMENTS
, which aggregates all instances of labels detected in a given\n segment.
The returned Labels array may include the following attributes:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.
\nParents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical\n taxonomy of detected labels. For example, a detected car might be assigned the label car.\n The label car has two parent labels: Vehicle (its parent) and Transportation (its\n grandparent). The response includes the all ancestors for a label, where every ancestor is\n a unique label. In the previous example, Car, Vehicle, and Transportation are returned as\n unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common object labels, \n returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing \n the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.
\nTimestamp - Time, in milliseconds from the start of the video, that the label was detected.\n For aggregation by SEGMENTS
, the StartTimestampMillis
,\n EndTimestampMillis
, and DurationMillis
structures are what\n define a segment. Although the “Timestamp” structure is still returned with each label,\n its value is set to be the same as StartTimestampMillis
.
Timestamp and Bounding box information are returned for detected Instances, only if\n aggregation is done by TIMESTAMPS
. If aggregating by SEGMENTS
,\n information about detected instances isn’t returned.
The version of the label model used for the detection is also returned.
\n\n Note DominantColors
isn't returned for Instances
,\n although it is shown as part of the response in the sample seen below.\n
Use MaxResults
parameter to limit the number of labels returned. If\n there are more results than specified in MaxResults
, the value of\n NextToken
in the operation response contains a pagination token for getting the\n next set of results. To get the next page of results, call GetlabelDetection
and\n populate the NextToken
request parameter with the token value returned from the\n previous call to GetLabelDetection
.
Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.
\nThe label detection operation is started by a call to StartLabelDetection which returns a job identifier (JobId
). When\n the label detection operation finishes, Amazon Rekognition publishes a completion status to the\n Amazon Simple Notification Service topic registered in the initial call to StartlabelDetection
.
To get the results of the label detection operation, first check that the status value\n published to the Amazon SNS topic is SUCCEEDED
. If so, call GetLabelDetection and pass the job identifier (JobId
) from the\n initial call to StartLabelDetection
.
\n GetLabelDetection
returns an array of detected labels\n (Labels
) sorted by the time the labels were detected. You can also sort by the\n label name by specifying NAME
for the SortBy
input parameter. If\n there is no NAME
specified, the default sort is by\n timestamp.
You can select how results are aggregated by using the AggregateBy
input\n parameter. The default aggregation method is TIMESTAMPS
. You can also aggregate\n by SEGMENTS
, which aggregates all instances of labels detected in a given\n segment.
The returned Labels array may include the following attributes:
\nName - The name of the detected label.
\nConfidence - The level of confidence in the label assigned to a detected object.
\nParents - The ancestor labels for a detected label. GetLabelDetection returns a hierarchical\n taxonomy of detected labels. For example, a detected car might be assigned the label car.\n The label car has two parent labels: Vehicle (its parent) and Transportation (its\n grandparent). The response includes the all ancestors for a label, where every ancestor is\n a unique label. In the previous example, Car, Vehicle, and Transportation are returned as\n unique labels in the response.
\nAliases - Possible Aliases for the label.
\nCategories - The label categories that the detected label belongs to.
\nBoundingBox — Bounding boxes are described for all instances of detected common object labels, \n returned in an array of Instance objects. An Instance object contains a BoundingBox object, describing \n the location of the label on the input image. It also includes the confidence for the accuracy of the detected bounding box.
\nTimestamp - Time, in milliseconds from the start of the video, that the label was detected.\n For aggregation by SEGMENTS
, the StartTimestampMillis
,\n EndTimestampMillis
, and DurationMillis
structures are what\n define a segment. Although the “Timestamp” structure is still returned with each label,\n its value is set to be the same as StartTimestampMillis
.
Timestamp and Bounding box information are returned for detected Instances, only if\n aggregation is done by TIMESTAMPS
. If aggregating by SEGMENTS
,\n information about detected instances isn’t returned.
The version of the label model used for the detection is also returned.
\n\n Note DominantColors
isn't returned for Instances
,\n although it is shown as part of the response in the sample seen below.\n
Use MaxResults
parameter to limit the number of labels returned. If\n there are more results than specified in MaxResults
, the value of\n NextToken
in the operation response contains a pagination token for getting the\n next set of results. To get the next page of results, call GetlabelDetection
and\n populate the NextToken
request parameter with the token value returned from the\n previous call to GetLabelDetection
.
If you are retrieving results while using the Amazon Simple Notification Service, note that you will receive an\n \"ERROR\" notification if the job encounters an issue.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json index 7cf1241b5a8..96267045856 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.json +++ b/codegen/sdk-codegen/aws-models/workspaces.json @@ -8012,7 +8012,8 @@ "Capacity": { "target": "com.amazonaws.workspaces#NonEmptyString", "traits": { - "smithy.api#documentation": "The size of the root volume.
" + "smithy.api#documentation": "The size of the root volume.
", + "smithy.api#required": {} } } }, @@ -9559,7 +9560,8 @@ "Capacity": { "target": "com.amazonaws.workspaces#NonEmptyString", "traits": { - "smithy.api#documentation": "The size of the user volume.
" + "smithy.api#documentation": "The size of the user volume.
", + "smithy.api#required": {} } } },