diff --git a/codegen/sdk-codegen/aws-models/application-auto-scaling.json b/codegen/sdk-codegen/aws-models/application-auto-scaling.json index 0d642e9a7dd..fe417d8d90e 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 Serverless endpoint provisioned concurrency
\nAmazon SageMaker inference components
\nSpot Fleets (Amazon EC2)
\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)
\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.
\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/default/sample-webapp
.
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
.
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 scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The desired 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 desired 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.
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 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/default/sample-webapp
.
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
.
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 scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The desired 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 desired 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.
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 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/default/sample-webapp
.
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
.
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 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 desired 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 desired 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.
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 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/default/sample-webapp
.
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
.
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 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 desired 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 desired 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.
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 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/default/sample-webapp
.
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
.
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 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 desired 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 desired 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.
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 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/default/sample-webapp
.
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
.
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 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 desired 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 desired 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.
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.
Describes the Application Auto Scaling scheduled actions for the specified service namespace.
\nYou can filter the results using the ResourceId
,\n ScalableDimension
, and ScheduledActionNames
parameters.
For more information, see Scheduled scaling and Managing scheduled scaling in the\n Application Auto Scaling User Guide.
", + "smithy.api#documentation": "Describes the Application Auto Scaling scheduled actions for the specified service namespace.
\nYou can filter the results using the ResourceId
,\n ScalableDimension
, and ScheduledActionNames
parameters.
For more information, see Scheduled scaling in the Application Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To describe scheduled actions", @@ -1917,13 +1917,13 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "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/default/sample-webapp
.
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
.
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 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 desired 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 desired 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.
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.
Returns all the tags on the specified Application Auto Scaling scalable target.
\nFor general information about tags, including the format and syntax, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference.
", + "smithy.api#documentation": "Returns all the tags on the specified Application Auto Scaling scalable target.
\nFor general information about tags, including the format and syntax, see Tagging your Amazon Web Services\n resources in the Amazon Web Services General Reference.
", "smithy.api#examples": [ { "title": "To list tags for a scalable target", @@ -2373,6 +2373,12 @@ "traits": { "smithy.api#enumValue": "SageMakerInferenceComponentInvocationsPerCopy" } + }, + "WorkSpacesAverageUserSessionsCapacityUtilization": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WorkSpacesAverageUserSessionsCapacityUtilization" + } } } }, @@ -2412,7 +2418,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the reason for an activity that isn't scaled (not scaled\n activity), in machine-readable format. For help interpreting the not scaled\n reason details, see Scaling activities for Application Auto Scaling.
" + "smithy.api#documentation": "Describes the reason for an activity that isn't scaled (not scaled\n activity), in machine-readable format. For help interpreting the not scaled\n reason details, see Scaling activities for Application Auto Scaling in the\n Application Auto Scaling User Guide.
" } }, "com.amazonaws.applicationautoscaling#NotScaledReasons": { @@ -2483,7 +2489,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a predefined metric for a target tracking scaling policy to use with\n Application Auto Scaling.
\nOnly the Amazon Web Services that you're using send metrics to Amazon CloudWatch. To determine whether a\n desired metric already exists by looking up its namespace and dimension using the CloudWatch\n metrics dashboard in the console, follow the procedure in Monitor your\n resources using CloudWatch in the Application Auto Scaling User Guide.
" + "smithy.api#documentation": "Represents a predefined metric for a target tracking scaling policy to use with\n Application Auto Scaling.
\nFor more information, Predefined metrics for target tracking scaling policies in the\n Application Auto Scaling User Guide.
" } }, "com.amazonaws.applicationautoscaling#PutScalingPolicy": { @@ -2572,14 +2578,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "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/default/sample-webapp
.
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
.
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 scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The desired 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 desired 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.
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 schedule for this action. The following formats are supported:
\nAt expressions - \"at(yyyy-mm-ddThh:mm:ss)
\"
Rate expressions - \"rate(value\n unit)
\"
Cron expressions - \"cron(fields)
\"
At expressions are useful for one-time schedules. Cron expressions are useful for \n scheduled actions that run periodically at a specified date and time, and rate expressions \n are useful for scheduled actions that run at a regular interval.
\nAt and cron expressions use Universal Coordinated Time (UTC) by\n default.
\nThe cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
\nFor rate expressions, value is a positive integer and unit is \n minute
| minutes
| hour
| hours
| day
| days
.
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
" + "smithy.api#documentation": "The schedule for this action. The following formats are supported:
\nAt expressions - \"at(yyyy-mm-ddThh:mm:ss)
\"
Rate expressions - \"rate(value\n unit)
\"
Cron expressions - \"cron(fields)
\"
At expressions are useful for one-time schedules. Cron expressions are useful for \n scheduled actions that run periodically at a specified date and time, and rate expressions \n are useful for scheduled actions that run at a regular interval.
\nAt and cron expressions use Universal Coordinated Time (UTC) by\n default.
\nThe cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
\nFor rate expressions, value is a positive integer and unit is \n minute
| minutes
| hour
| hours
| day
| days
.
For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.
" } }, "Timezone": { @@ -2705,14 +2711,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "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/default/sample-webapp
.
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
.
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 scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The desired 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 desired 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.
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 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/default/sample-webapp
.
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
.
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 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 desired 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 desired 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.
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 minimum value that you plan to scale in to. When a scaling policy is in effect,\n Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to\n changing demand. This property is required when registering a new scalable target.
\nFor the following resources, the minimum value allowed is 0.
\nAppStream 2.0 fleets
\nAurora DB clusters
\nECS services
\nEMR clusters
\nLambda provisioned concurrency
\nSageMaker endpoint variants
\nSageMaker Serverless endpoint provisioned concurrency
\nSpot Fleets
\ncustom resources
\nIt's strongly recommended that you specify a value greater than 0. A value greater than 0\n means that data points are continuously reported to CloudWatch that scaling policies can use to\n scale on a metric like average CPU utilization.
\nFor all other resources, the minimum allowed value depends on the type of resource that\n you are using. If you provide a value that is lower than what a resource can accept, an error\n occurs. In which case, the error message will provide the minimum value that the resource can\n accept.
" + "smithy.api#documentation": "The minimum value that you plan to scale in to. When a scaling policy is in effect,\n Application Auto Scaling can scale in (contract) as needed to the minimum capacity limit in response to\n changing demand. This property is required when registering a new scalable target.
\nFor the following resources, the minimum value allowed is 0.
\nAppStream 2.0 fleets
\nAurora DB clusters
\nECS services
\nEMR clusters
\nLambda provisioned concurrency
\nSageMaker endpoint variants
\nSageMaker inference components
\nSageMaker serverless endpoint provisioned concurrency
\nSpot Fleets
\ncustom resources
\nIt's strongly recommended that you specify a value greater than 0. A value greater than 0\n means that data points are continuously reported to CloudWatch that scaling policies can use to\n scale on a metric like average CPU utilization.
\nFor all other resources, the minimum allowed value depends on the type of resource that\n you are using. If you provide a value that is lower than what a resource can accept, an error\n occurs. In which case, the error message will provide the minimum value that the resource can\n accept.
" } }, "MaxCapacity": { @@ -2827,13 +2833,13 @@ "RoleARN": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "This parameter is required for services that do not support service-linked roles (such as\n Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable\n target on your behalf.
\nIf the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which\n it creates if it does not yet exist. For more information, see Application Auto Scaling IAM roles.
" + "smithy.api#documentation": "This parameter is required for services that do not support service-linked roles (such as\n Amazon EMR), and it must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable\n target on your behalf.
\nIf the service supports service-linked roles, Application Auto Scaling uses a service-linked role, which\n it creates if it does not yet exist. For more information, see How Application Auto Scaling works with IAM.
" } }, "SuspendedState": { "target": "com.amazonaws.applicationautoscaling#SuspendedState", "traits": { - "smithy.api#documentation": "An embedded object that contains attributes and attribute values that are used to\n suspend and resume automatic scaling. Setting the value of an attribute to\n true
suspends the specified scaling activities. Setting it to\n false
(default) resumes the specified scaling activities.
\n Suspension Outcomes\n
\nFor DynamicScalingInSuspended
, while a suspension is in effect, all\n scale-in activities that are triggered by a scaling policy are suspended.
For DynamicScalingOutSuspended
, while a suspension is in effect, all\n scale-out activities that are triggered by a scaling policy are suspended.
For ScheduledScalingSuspended
, while a suspension is in effect, all\n scaling activities that involve scheduled actions are suspended.
For more information, see Suspending and resuming scaling in the Application Auto Scaling User\n Guide.
" + "smithy.api#documentation": "An embedded object that contains attributes and attribute values that are used to\n suspend and resume automatic scaling. Setting the value of an attribute to\n true
suspends the specified scaling activities. Setting it to\n false
(default) resumes the specified scaling activities.
\n Suspension Outcomes\n
\nFor DynamicScalingInSuspended
, while a suspension is in effect, all\n scale-in activities that are triggered by a scaling policy are suspended.
For DynamicScalingOutSuspended
, while a suspension is in effect, all\n scale-out activities that are triggered by a scaling policy are suspended.
For ScheduledScalingSuspended
, while a suspension is in effect, all\n scaling activities that involve scheduled actions are suspended.
For more information, see Suspend and resume scaling in the Application Auto Scaling User\n Guide.
" } }, "Tags": { @@ -3057,6 +3063,12 @@ "traits": { "smithy.api#enumValue": "sagemaker:inference-component:DesiredCopyCount" } + }, + "WorkSpacesWorkSpacesPoolDesiredUserSessions": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "workspaces:workspacespool:DesiredUserSessions" + } } } }, @@ -3073,14 +3085,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "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/default/sample-webapp
.
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
.
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 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 desired 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 desired 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.
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 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/default/sample-webapp
.
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
.
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 scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The desired 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 desired 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.
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 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/default/sample-webapp
.
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
.
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 scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The desired 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 desired 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.
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 schedule for this action. The following formats are supported:
\nAt expressions - \"at(yyyy-mm-ddThh:mm:ss)
\"
Rate expressions - \"rate(value\n unit)
\"
Cron expressions - \"cron(fields)
\"
At expressions are useful for one-time schedules. Cron expressions are useful for \n scheduled actions that run periodically at a specified date and time, and rate expressions \n are useful for scheduled actions that run at a regular interval.
\nAt and cron expressions use Universal Coordinated Time (UTC) by\n default.
\nThe cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
\nFor rate expressions, value is a positive integer and unit is \n minute
| minutes
| hour
| hours
| day
| days
.
For more information and examples, see Example scheduled actions for Application Auto Scaling in the Application Auto Scaling User Guide.
", + "smithy.api#documentation": "The schedule for this action. The following formats are supported:
\nAt expressions - \"at(yyyy-mm-ddThh:mm:ss)
\"
Rate expressions - \"rate(value\n unit)
\"
Cron expressions - \"cron(fields)
\"
At expressions are useful for one-time schedules. Cron expressions are useful for \n scheduled actions that run periodically at a specified date and time, and rate expressions \n are useful for scheduled actions that run at a regular interval.
\nAt and cron expressions use Universal Coordinated Time (UTC) by\n default.
\nThe cron format consists of six fields separated by white spaces: [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
\nFor rate expressions, value is a positive integer and unit is \n minute
| minutes
| hour
| hours
| day
| days
.
For more information, see Schedule recurring scaling actions using cron expressions in the Application Auto Scaling User Guide.
", "smithy.api#required": {} } }, @@ -3417,14 +3429,14 @@ "ResourceId": { "target": "com.amazonaws.applicationautoscaling#ResourceIdMaxLen1600", "traits": { - "smithy.api#documentation": "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/default/sample-webapp
.
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
.
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 scalable dimension. This string consists of the service namespace, resource type, and scaling property.
\n\n ecs:service:DesiredCount
- The desired 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 desired 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.
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.
Adds or edits tags on an Application Auto Scaling scalable target.
\nEach tag consists of a tag key and a tag value, which are both case-sensitive strings.\n To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag\n key and a new tag value.
\nYou can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a\n scaling policy or scheduled action.
\nYou can also add tags to an Application Auto Scaling scalable target while creating it\n (RegisterScalableTarget
).
For general information about tags, including the format and syntax, see Tagging Amazon Web Services\n resources in the Amazon Web Services General Reference.
\nUse tags to control access to a scalable target. For more information, see Tagging support\n for Application Auto Scaling in the Application Auto Scaling User Guide.
", + "smithy.api#documentation": "Adds or edits tags on an Application Auto Scaling scalable target.
\nEach tag consists of a tag key and a tag value, which are both case-sensitive strings.\n To add a tag, specify a new tag key and a tag value. To edit a tag, specify an existing tag\n key and a new tag value.
\nYou can use this operation to tag an Application Auto Scaling scalable target, but you cannot tag a\n scaling policy or scheduled action.
\nYou can also add tags to an Application Auto Scaling scalable target while creating it\n (RegisterScalableTarget
).
For general information about tags, including the format and syntax, see Tagging your Amazon Web Services\n resources in the Amazon Web Services General Reference.
\nUse tags to control access to a scalable target. For more information, see Tagging support\n for Application Auto Scaling in the Application Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To add a tag to a scalable target", @@ -3738,7 +3756,7 @@ "Tags": { "target": "com.amazonaws.applicationautoscaling#TagMap", "traits": { - "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services\n resource.
\nEach tag consists of a tag key and a tag value.
\nYou cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key.\n If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the\n current tag value with the specified one.
\nFor information about the rules that apply to tag keys and tag values, see User-defined tag\n restrictions in the Amazon Web Services Billing and Cost Management User\n Guide.
", + "smithy.api#documentation": "The tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services\n resource.
\nEach tag consists of a tag key and a tag value.
\nYou cannot have more than one tag on an Application Auto Scaling scalable target with the same tag key.\n If you specify an existing tag key with a different tag value, Application Auto Scaling replaces the\n current tag value with the specified one.
\nFor information about the rules that apply to tag keys and tag values, see User-defined tag\n restrictions in the Amazon Web Services Billing User Guide.
", "smithy.api#required": {} } } @@ -3927,7 +3945,7 @@ } }, "traits": { - "smithy.api#documentation": "This structure defines the CloudWatch metric to return, along with the statistic, period, and\n unit.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.
" + "smithy.api#documentation": "This structure defines the CloudWatch metric to return, along with the statistic and\n unit.
\nFor more information about the CloudWatch terminology below, see Amazon CloudWatch\n concepts in the Amazon CloudWatch User Guide.
" } }, "com.amazonaws.applicationautoscaling#TargetTrackingMetricUnit": { @@ -3982,7 +4000,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a target tracking scaling policy configuration to use with Application Auto Scaling.
\nFor more information, see Target tracking scaling policies in the Application Auto Scaling User\n Guide.
" + "smithy.api#documentation": "Represents a target tracking scaling policy configuration to use with Application Auto Scaling.
\nFor more information, see Target tracking scaling policies in the\n Application Auto Scaling User Guide.
" } }, "com.amazonaws.applicationautoscaling#TimestampType": { diff --git a/codegen/sdk-codegen/aws-models/chime-sdk-media-pipelines.json b/codegen/sdk-codegen/aws-models/chime-sdk-media-pipelines.json index 538c8a60130..f76ca5ca89f 100644 --- a/codegen/sdk-codegen/aws-models/chime-sdk-media-pipelines.json +++ b/codegen/sdk-codegen/aws-models/chime-sdk-media-pipelines.json @@ -256,6 +256,13 @@ "smithy.api#documentation": "Turns language identification on or off.
" } }, + "IdentifyMultipleLanguages": { + "target": "com.amazonaws.chimesdkmediapipelines#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Turns language identification on or off for multiple languages.
" + } + }, "LanguageOptions": { "target": "com.amazonaws.chimesdkmediapipelines#LanguageOptions", "traits": { @@ -282,7 +289,7 @@ } }, "traits": { - "smithy.api#documentation": "A structure that contains the configuration settings for an Amazon Transcribe processor.
" + "smithy.api#documentation": "A structure that contains the configuration settings for an Amazon Transcribe processor.
\nCalls to this API must include a LanguageCode
, IdentifyLanguage
, or IdentifyMultipleLanguages
parameter. \n If you include more than one of those parameters, your transcription job fails.
Creates an Kinesis video stream pool for the media pipeline.
", + "smithy.api#documentation": "Creates an Amazon Kinesis Video Stream pool for use with media stream\n pipelines.
\nIf a meeting uses an opt-in Region as its \n MediaRegion, \n the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1
Region, the KVS stream must also be in af-south-1
. However, if the meeting uses a \n Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1
, the KVS stream can be in \n eu-west-2
, us-east-1
, af-south-1
, or any other Region that the Amazon Chime SDK supports.
To learn which AWS Region a meeting uses, call the GetMeeting API and \n use the MediaRegion \n parameter from the response.
\nFor more information about opt-in Regions, refer to Available Regions in the \n Amazon Chime SDK Developer Guide, and \n Specify which AWS Regions your account can use, \n in the AWS Account Management Reference Guide.
\nThe configuration settings for the video stream.
", + "smithy.api#documentation": "The configuration settings for the stream.
", "smithy.api#required": {} } }, "PoolName": { "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolName", "traits": { - "smithy.api#documentation": "The name of the video stream pool.
", + "smithy.api#documentation": "The name of the pool.
", "smithy.api#required": {} } }, @@ -2463,7 +2470,7 @@ "Tags": { "target": "com.amazonaws.chimesdkmediapipelines#TagList", "traits": { - "smithy.api#documentation": "The tags assigned to the video stream pool.
" + "smithy.api#documentation": "The tags assigned to the stream pool.
" } } }, @@ -2477,7 +2484,7 @@ "KinesisVideoStreamPoolConfiguration": { "target": "com.amazonaws.chimesdkmediapipelines#KinesisVideoStreamPoolConfiguration", "traits": { - "smithy.api#documentation": "The configuration for the Kinesis video stream pool.
" + "smithy.api#documentation": "The configuration for applying the streams to the pool.
\nDeletes an Kinesis video stream pool.
", + "smithy.api#documentation": "Deletes an Amazon Kinesis Video Stream pool.
", "smithy.api#http": { "method": "DELETE", "uri": "/media-pipeline-kinesis-video-stream-pools/{Identifier}", @@ -2815,7 +2822,7 @@ "Identifier": { "target": "com.amazonaws.chimesdkmediapipelines#NonEmptyString", "traits": { - "smithy.api#documentation": "The ID of the pool being deleted.
", + "smithy.api#documentation": "The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3206,7 +3213,7 @@ "Identifier": { "target": "com.amazonaws.chimesdkmediapipelines#NonEmptyString", "traits": { - "smithy.api#documentation": "The ID of the video stream pool.
", + "smithy.api#documentation": "The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3681,7 +3688,7 @@ } }, "traits": { - "smithy.api#documentation": "The configuration of an Kinesis video stream.
" + "smithy.api#documentation": "The configuration of an Kinesis video stream.
\nIf a meeting uses an opt-in Region as its \n MediaRegion, \n the KVS stream must be in that same Region. For example, if a meeting uses the af-south-1
Region, the KVS stream must also be in af-south-1
. However, if the meeting uses a \n Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses ca-central-1
, the KVS stream can be in \n eu-west-2
, us-east-1
, af-south-1
, or any other Region that the Amazon Chime SDK supports.
To learn which AWS Region a meeting uses, call the GetMeeting API and \n use the MediaRegion \n parameter from the response.
\nFor more information about opt-in Regions, refer to Available Regions in the \n Amazon Chime SDK Developer Guide, and \n Specify which AWS Regions your account can use, \n in the AWS Account Management Reference Guide.
\nThe ARN of the media stream sink.
", + "smithy.api#documentation": "The ARN of the Kinesis Video Stream pool returned by the CreateMediaPipelineKinesisVideoStreamPool API.
", "smithy.api#required": {} } }, @@ -5456,7 +5463,7 @@ "SourceArn": { "target": "com.amazonaws.chimesdkmediapipelines#Arn", "traits": { - "smithy.api#documentation": "The ARN of the media stream source.
", + "smithy.api#documentation": "The ARN of the meeting.
", "smithy.api#required": {} } } @@ -5813,7 +5820,7 @@ }, "traits": { "smithy.api#length": { - "min": 2, + "min": 1, "max": 2 } } @@ -7042,7 +7049,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an Kinesis video stream pool in a media pipeline.
", + "smithy.api#documentation": "Updates an Amazon Kinesis Video Stream pool in a media pipeline.
", "smithy.api#http": { "method": "PUT", "uri": "/media-pipeline-kinesis-video-stream-pools/{Identifier}", @@ -7056,7 +7063,7 @@ "Identifier": { "target": "com.amazonaws.chimesdkmediapipelines#NonEmptyString", "traits": { - "smithy.api#documentation": "The ID of the video stream pool.
", + "smithy.api#documentation": "The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } diff --git a/codegen/sdk-codegen/aws-models/cloudfront.json b/codegen/sdk-codegen/aws-models/cloudfront.json index c57eb3ac9bd..1be0bd9361e 100644 --- a/codegen/sdk-codegen/aws-models/cloudfront.json +++ b/codegen/sdk-codegen/aws-models/cloudfront.json @@ -434,7 +434,7 @@ } }, "traits": { - "smithy.api#documentation": "A complex type that describes how CloudFront processes requests.
\nYou must create at least as many cache behaviors (including the default cache\n\t\t\tbehavior) as you have origins if you want CloudFront to serve objects from all of the origins.\n\t\t\tEach cache behavior specifies the one origin from which you want CloudFront to get objects. If\n\t\t\tyou have two origins and only the default cache behavior, the default cache behavior\n\t\t\twill cause CloudFront to get objects from one of the origins, but the other origin is never\n\t\t\tused.
\nFor the current quota (formerly known as limit) on the number of cache behaviors that\n\t\t\tyou can add to a distribution, see Quotas in the\n\t\t\tAmazon CloudFront Developer Guide.
\nIf you don't want to specify any cache behaviors, include only an empty\n\t\t\tCacheBehaviors
element. For more information, see CacheBehaviors. Don't include an empty\n\t\t\t\tCacheBehavior
element because this is invalid.
To delete all cache behaviors in an existing distribution, update the distribution\n\t\t\tconfiguration and include only an empty CacheBehaviors
element.
To add, change, or remove one or more cache behaviors, update the distribution\n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the\n\t\t\tupdated distribution.
\nFor more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
" + "smithy.api#documentation": "A complex type that describes how CloudFront processes requests.
\nYou must create at least as many cache behaviors (including the default cache\n\t\t\tbehavior) as you have origins if you want CloudFront to serve objects from all of the origins.\n\t\t\tEach cache behavior specifies the one origin from which you want CloudFront to get objects. If\n\t\t\tyou have two origins and only the default cache behavior, the default cache behavior\n\t\t\twill cause CloudFront to get objects from one of the origins, but the other origin is never\n\t\t\tused.
\nFor the current quota (formerly known as limit) on the number of cache behaviors that\n\t\t\tyou can add to a distribution, see Quotas in the\n\t\t\tAmazon CloudFront Developer Guide.
\nIf you don't want to specify any cache behaviors, include only an empty\n\t\t\t\tCacheBehaviors
element. Don't specify an empty individual\n\t\t\t\tCacheBehavior
element, because this is invalid. For more information,\n\t\t\tsee CacheBehaviors.
To delete all cache behaviors in an existing distribution, update the distribution\n\t\t\tconfiguration and include only an empty CacheBehaviors
element.
To add, change, or remove one or more cache behaviors, update the distribution\n\t\t\tconfiguration and specify all of the cache behaviors that you want to include in the\n\t\t\tupdated distribution.
\nFor more information about cache behaviors, see Cache Behavior Settings in the Amazon CloudFront Developer Guide.
" } }, "com.amazonaws.cloudfront#CacheBehaviorList": { @@ -795,7 +795,7 @@ "Items": { "target": "com.amazonaws.cloudfront#MethodsList", "traits": { - "smithy.api#documentation": "A complex type that contains the HTTP methods that you want CloudFront to cache responses\n\t\t\tto.
", + "smithy.api#documentation": "A complex type that contains the HTTP methods that you want CloudFront to cache responses\n\t\t\tto. Valid values for CachedMethods
include GET
, HEAD
, and OPTIONS
, depending on which caching option you choose. For more information, see the preceding section.
List tags for a CloudFront resource.
", + "smithy.api#documentation": "List tags for a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "GET", "uri": "/2020-05-31/tagging", @@ -15810,7 +15810,7 @@ } ], "traits": { - "smithy.api#documentation": "Add tags to a CloudFront resource.
", + "smithy.api#documentation": "Add tags to a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/tagging?Operation=Tag", @@ -16835,7 +16835,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove tags from a CloudFront resource.
", + "smithy.api#documentation": "Remove tags from a CloudFront resource. For more information, see Tagging a distribution in the Amazon CloudFront Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/2020-05-31/tagging?Operation=Untag", diff --git a/codegen/sdk-codegen/aws-models/datazone.json b/codegen/sdk-codegen/aws-models/datazone.json index 2645914872f..369f18219fd 100644 --- a/codegen/sdk-codegen/aws-models/datazone.json +++ b/codegen/sdk-codegen/aws-models/datazone.json @@ -5787,6 +5787,9 @@ { "target": "com.amazonaws.datazone#GetIamPortalLoginUrl" }, + { + "target": "com.amazonaws.datazone#GetLineageNode" + }, { "target": "com.amazonaws.datazone#GetProject" }, @@ -5826,6 +5829,9 @@ { "target": "com.amazonaws.datazone#ListEnvironments" }, + { + "target": "com.amazonaws.datazone#ListLineageNodeHistory" + }, { "target": "com.amazonaws.datazone#ListNotifications" }, @@ -5853,6 +5859,9 @@ { "target": "com.amazonaws.datazone#ListTimeSeriesDataPoints" }, + { + "target": "com.amazonaws.datazone#PostLineageEvent" + }, { "target": "com.amazonaws.datazone#PostTimeSeriesDataPoints" }, @@ -8309,6 +8318,23 @@ "smithy.api#documentation": "A summary of a Amazon DataZone domain.
" } }, + "com.amazonaws.datazone#EdgeDirection": { + "type": "enum", + "members": { + "UPSTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPSTREAM" + } + }, + "DOWNSTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOWNSTREAM" + } + } + } + }, "com.amazonaws.datazone#EditedValue": { "type": "string", "traits": { @@ -9211,7 +9237,7 @@ "traits": { "smithy.api#documentation": "The content of the metadata form.
", "smithy.api#length": { - "max": 150000 + "max": 300000 } } } @@ -11656,6 +11682,173 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#GetLineageNode": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#GetLineageNodeInput" + }, + "output": { + "target": "com.amazonaws.datazone#GetLineageNodeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the data lineage node.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/lineage/nodes/{identifier}" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#GetLineageNodeInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain in which you want to get the data lineage node.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "identifier": { + "target": "com.amazonaws.datazone#LineageNodeIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the data lineage node that you want to get.
\nBoth, a lineage node identifier generated by Amazon DataZone and a\n sourceIdentifier
of the lineage node are supported. If\n sourceIdentifier
is greater than 1800 characters, you can use lineage node\n identifier generated by Amazon DataZone to get the node details.
The event time stamp for which you want to get the data lineage node.
", + "smithy.api#httpQuery": "timestamp" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#GetLineageNodeOutput": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where you're getting the data lineage node.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the data lineage node.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the data lineage node.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the data lineage node was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The user who created the data lineage node.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the data lineage node was updated.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The user who updated the data lineage node.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#LineageNodeId", + "traits": { + "smithy.api#documentation": "The ID of the data lineage node.
", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the type of the specified data lineage node.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision type of the specified data lineage node.
" + } + }, + "sourceIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The source identifier of the data lineage node.
" + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp of the event described in the data lineage node.
" + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormOutputList", + "traits": { + "smithy.api#documentation": "The metadata of the specified data lineage node.
" + } + }, + "upstreamNodes": { + "target": "com.amazonaws.datazone#LineageNodeReferenceList", + "traits": { + "smithy.api#documentation": "The upstream nodes of the specified data lineage node.
" + } + }, + "downstreamNodes": { + "target": "com.amazonaws.datazone#LineageNodeReferenceList", + "traits": { + "smithy.api#documentation": "The downsteam nodes of the specified data lineage node.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#GetListing": { "type": "operation", "input": { @@ -13601,6 +13794,215 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.datazone#LineageEvent": { + "type": "blob", + "traits": { + "smithy.api#length": { + "max": 300000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.datazone#LineageNodeId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9_-]{1,36}$" + } + }, + "com.amazonaws.datazone#LineageNodeIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2086 + } + } + }, + "com.amazonaws.datazone#LineageNodeReference": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.datazone#LineageNodeId", + "traits": { + "smithy.api#documentation": "The ID of the data lineage node.
" + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The event timestamp of the data lineage node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The reference details for the data lineage node.
" + } + }, + "com.amazonaws.datazone#LineageNodeReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#LineageNodeReference" + }, + "traits": { + "smithy.api#length": { + "max": 100 + } + } + }, + "com.amazonaws.datazone#LineageNodeSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.datazone#LineageNodeSummary" + } + }, + "com.amazonaws.datazone#LineageNodeSummary": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain of the data lineage node.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the data lineage node.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the data lineage node.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the data lineage node was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The user who created the data lineage node.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the data lineage node was updated.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The user who updated the data lineage node.
" + } + }, + "id": { + "target": "com.amazonaws.datazone#LineageNodeId", + "traits": { + "smithy.api#documentation": "The ID of the data lineage node.
", + "smithy.api#required": {} + } + }, + "typeName": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the type of the data lineage node.
", + "smithy.api#required": {} + } + }, + "typeRevision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The type of the revision of the data lineage node.
" + } + }, + "sourceIdentifier": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The alternate ID of the data lineage node.
" + } + }, + "eventTimestamp": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "The event timestamp of the data lineage node.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The summary of the data lineage node.
" + } + }, + "com.amazonaws.datazone#LineageNodeTypeItem": { + "type": "structure", + "members": { + "domainId": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where the data lineage node type lives.
", + "smithy.api#required": {} + } + }, + "name": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The name of the data lineage node type.
" + } + }, + "description": { + "target": "smithy.api#String", + "traits": { + "smithy.api#documentation": "The description of the data lineage node type.
" + } + }, + "createdAt": { + "target": "com.amazonaws.datazone#CreatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the data lineage node type was created.
" + } + }, + "createdBy": { + "target": "com.amazonaws.datazone#CreatedBy", + "traits": { + "smithy.api#documentation": "The user who created the data lineage node type.
" + } + }, + "updatedAt": { + "target": "com.amazonaws.datazone#UpdatedAt", + "traits": { + "smithy.api#documentation": "The timestamp at which the data lineage node type was updated.
" + } + }, + "updatedBy": { + "target": "com.amazonaws.datazone#UpdatedBy", + "traits": { + "smithy.api#documentation": "The user who updated the data lineage node type.
" + } + }, + "revision": { + "target": "com.amazonaws.datazone#Revision", + "traits": { + "smithy.api#documentation": "The revision of the data lineage node type.
", + "smithy.api#required": {} + } + }, + "formsOutput": { + "target": "com.amazonaws.datazone#FormsOutputMap", + "traits": { + "smithy.api#documentation": "The forms output of the data lineage node type.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a data lineage node type.
" + } + }, "com.amazonaws.datazone#ListAssetRevisions": { "type": "operation", "input": { @@ -14721,6 +15123,133 @@ "smithy.api#output": {} } }, + "com.amazonaws.datazone#ListLineageNodeHistory": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#ListLineageNodeHistoryInput" + }, + "output": { + "target": "com.amazonaws.datazone#ListLineageNodeHistoryOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the history of the specified data lineage node.
", + "smithy.api#http": { + "code": 200, + "method": "GET", + "uri": "/v2/domains/{domainIdentifier}/lineage/nodes/{identifier}/history" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "nodes" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.datazone#ListLineageNodeHistoryInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where you want to list the history of the specified data lineage\n node.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "maxResults": { + "target": "com.amazonaws.datazone#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of history items to return in a single call to\n ListLineageNodeHistory. When the number of memberships to be listed is greater than the\n value of MaxResults, the response contains a NextToken value that you can use in a\n subsequent call to ListLineageNodeHistory to list the next set of items.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of history items is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of items, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of\n items.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "identifier": { + "target": "com.amazonaws.datazone#LineageNodeIdentifier", + "traits": { + "smithy.api#documentation": "The ID of the data lineage node whose history you want to list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "direction": { + "target": "com.amazonaws.datazone#EdgeDirection", + "traits": { + "smithy.api#documentation": "The direction of the data lineage node refers to the lineage node having neighbors in\n that direction. For example, if direction is UPSTREAM
, the\n ListLineageNodeHistory
API responds with historical versions with upstream\n neighbors only.
Specifies whether the action is to return data lineage node history from the time after\n the event timestamp.
", + "smithy.api#httpQuery": "timestampGTE" + } + }, + "eventTimestampLTE": { + "target": "smithy.api#Timestamp", + "traits": { + "smithy.api#documentation": "Specifies whether the action is to return data lineage node history from the time prior\n of the event timestamp.
", + "smithy.api#httpQuery": "timestampLTE" + } + }, + "sortOrder": { + "target": "com.amazonaws.datazone#SortOrder", + "traits": { + "smithy.api#documentation": "The order by which you want data lineage node history to be sorted.
", + "smithy.api#httpQuery": "sortOrder" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#ListLineageNodeHistoryOutput": { + "type": "structure", + "members": { + "nodes": { + "target": "com.amazonaws.datazone#LineageNodeSummaries", + "traits": { + "smithy.api#documentation": "The nodes returned by the ListLineageNodeHistory action.
" + } + }, + "nextToken": { + "target": "com.amazonaws.datazone#PaginationToken", + "traits": { + "smithy.api#documentation": "When the number of history items is greater than the default value for the MaxResults\n parameter, or if you explicitly specify a value for MaxResults that is less than the number\n of items, the response includes a pagination token named NextToken. You can specify this\n NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of\n items.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#ListMetadataGenerationRuns": { "type": "operation", "input": { @@ -16544,6 +17073,86 @@ } } }, + "com.amazonaws.datazone#PostLineageEvent": { + "type": "operation", + "input": { + "target": "com.amazonaws.datazone#PostLineageEventInput" + }, + "output": { + "target": "com.amazonaws.datazone#PostLineageEventOutput" + }, + "errors": [ + { + "target": "com.amazonaws.datazone#AccessDeniedException" + }, + { + "target": "com.amazonaws.datazone#ConflictException" + }, + { + "target": "com.amazonaws.datazone#InternalServerException" + }, + { + "target": "com.amazonaws.datazone#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.datazone#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.datazone#ThrottlingException" + }, + { + "target": "com.amazonaws.datazone#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Posts a data lineage event.
", + "smithy.api#http": { + "code": 200, + "method": "POST", + "uri": "/v2/domains/{domainIdentifier}/lineage/events" + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.datazone#PostLineageEventInput": { + "type": "structure", + "members": { + "domainIdentifier": { + "target": "com.amazonaws.datazone#DomainId", + "traits": { + "smithy.api#documentation": "The ID of the domain where you want to post a data lineage event.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "event": { + "target": "com.amazonaws.datazone#LineageEvent", + "traits": { + "smithy.api#documentation": "The data lineage event that you want to post. Only open-lineage run event are supported\n as events.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "clientToken": { + "target": "com.amazonaws.datazone#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that is provided to ensure the idempotency of the\n request.
", + "smithy.api#httpQuery": "clientToken", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.datazone#PostLineageEventOutput": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.datazone#PostTimeSeriesDataPoints": { "type": "operation", "input": { @@ -18550,6 +19159,12 @@ "traits": { "smithy.api#documentation": "The form type included in the results of the SearchTypes
action.
The details of a data lineage node type.
" + } } }, "traits": { @@ -20892,6 +21507,12 @@ "traits": { "smithy.api#enumValue": "FORM_TYPE" } + }, + "LINEAGE_NODE_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINEAGE_NODE_TYPE" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/elasticache.json b/codegen/sdk-codegen/aws-models/elasticache.json index 61f28a3ccf6..bcc195c9b43 100644 --- a/codegen/sdk-codegen/aws-models/elasticache.json +++ b/codegen/sdk-codegen/aws-models/elasticache.json @@ -4762,21 +4762,21 @@ "smithy.api#documentation": "Creates a copy of an entire cluster or replication group at a specific moment in\n time.
\nThis operation is valid for Redis only.
\nLists available reserved cache node offerings.
", "smithy.api#examples": [ + { + "title": "DescribeReseredCacheNodeOfferings", + "documentation": "Lists available reserved cache node offerings for cache.r3.large nodes with a 3 year commitment.", + "input": { + "ReservedCacheNodesOfferingId": "", + "CacheNodeType": "cache.r3.large", + "Duration": "3", + "OfferingType": "Light Utilization", + "MaxRecords": 25 + }, + "output": { + "Marker": "", + "ReservedCacheNodesOfferings": [] + } + }, { "title": "DescribeReseredCacheNodeOfferings", "documentation": "Lists available reserved cache node offerings.", @@ -8836,21 +8864,6 @@ ] } }, - { - "title": "DescribeReseredCacheNodeOfferings", - "documentation": "Lists available reserved cache node offerings for cache.r3.large nodes with a 3 year commitment.", - "input": { - "ReservedCacheNodesOfferingId": "", - "CacheNodeType": "cache.r3.large", - "Duration": "3", - "OfferingType": "Light Utilization", - "MaxRecords": 25 - }, - "output": { - "Marker": "", - "ReservedCacheNodesOfferings": [] - } - }, { "title": "DescribeReseredCacheNodeOfferings", "documentation": "Lists available reserved cache node offerings.", @@ -10852,6 +10865,16 @@ "traits": { "smithy.api#documentation": "Lists all available node types that you can scale your Redis cluster's or replication\n group's current node type.
\nWhen you use the ModifyCacheCluster
or\n ModifyReplicationGroup
operations to scale your cluster or replication\n group, the value of the CacheNodeType
parameter must be one of the node\n types returned by this operation.
Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.
", + "smithy.api#documentation": "The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
", "smithy.api#jsonName": "engineVersion", "smithy.api#required": {} } @@ -628,10 +628,8 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot. Set to true by default, if no value is specified.
", - "smithy.api#jsonName": "autoMinorVersionUpgrade", - "smithy.api#required": {} + "smithy.api#documentation": "Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot. Set to true by default, if no value is specified.
Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.
Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
", - "smithy.api#jsonName": "engineVersion", - "smithy.api#required": {} + "smithy.api#documentation": "The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
", + "smithy.api#jsonName": "engineVersion" } }, "HostInstanceType": { @@ -863,10 +859,8 @@ "EngineVersion": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#clientOptional": {}, - "smithy.api#documentation": "Required. The broker engine's version. For a list of supported engine versions, see Supported engines.
", - "smithy.api#jsonName": "engineVersion", - "smithy.api#required": {} + "smithy.api#documentation": "The broker engine version. Defaults to the latest available version for the specified broker engine type. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
", + "smithy.api#jsonName": "engineVersion" } }, "Name": { @@ -1668,7 +1662,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
", + "smithy.api#documentation": "Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.
", "smithy.api#jsonName": "autoMinorVersionUpgrade" } }, @@ -1745,7 +1739,7 @@ "EngineVersion": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The broker engine's version. For a list of supported engine versions, see Supported engines.
", + "smithy.api#documentation": "The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
", "smithy.api#jsonName": "engineVersion" } }, @@ -1787,7 +1781,7 @@ "PendingEngineVersion": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
", + "smithy.api#documentation": "The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
", "smithy.api#jsonName": "pendingEngineVersion" } }, @@ -1975,7 +1969,7 @@ "EngineVersion": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "Required. The broker engine's version. For a list of supported engine versions, see, Supported engines.
", + "smithy.api#documentation": "The broker engine version. Defaults to the latest available version for the specified broker engine type. For a list of supported engine versions, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
", "smithy.api#jsonName": "engineVersion" } }, @@ -3315,7 +3309,7 @@ "AutoMinorVersionUpgrade": { "target": "com.amazonaws.mq#__boolean", "traits": { - "smithy.api#documentation": "Enables automatic upgrades to new minor versions for brokers, as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window of the broker or after a manual broker reboot.
", + "smithy.api#documentation": "Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.
Must be set to true for ActiveMQ brokers version 5.18 and above and for RabbitMQ brokers version 3.13 and above.
The broker engine version. For a list of supported engine versions, see Supported engines.
", + "smithy.api#documentation": "The broker engine version. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
When upgrading to ActiveMQ version 5.18 and above or RabbitMQ version 3.13 and above, you must have autoMinorVersionUpgrade set to true for the broker.
The new boolean value that specifies whether broker engines automatically upgrade to new minor versions as new versions are released and supported by Amazon MQ.
", + "smithy.api#documentation": "Enables automatic upgrades to new patch versions for brokers as new versions are released and supported by Amazon MQ. Automatic upgrades occur during the scheduled maintenance window or after a manual broker reboot.
", "smithy.api#jsonName": "autoMinorVersionUpgrade" } }, @@ -3423,7 +3417,7 @@ "EngineVersion": { "target": "com.amazonaws.mq#__string", "traits": { - "smithy.api#documentation": "The broker engine version to upgrade to. For a list of supported engine versions, see Supported engines.
", + "smithy.api#documentation": "The broker engine version to upgrade to. For more information, see the ActiveMQ version management and the RabbitMQ version management sections in the Amazon MQ Developer Guide.
", "smithy.api#jsonName": "engineVersion" } }, @@ -4050,6 +4044,9 @@ "name": "mq" }, "aws.protocols#restJson1": {}, + "smithy.api#auth": [ + "aws.auth#sigv4" + ], "smithy.api#documentation": "Amazon MQ is a managed message broker service for Apache ActiveMQ and RabbitMQ that makes it easy to set up and operate message brokers in the cloud. A message broker allows software applications and components to communicate using various programming languages, operating systems, and formal messaging protocols.
", "smithy.api#title": "AmazonMQ", "smithy.rules#endpointRuleSet": { diff --git a/codegen/sdk-codegen/aws-models/qconnect.json b/codegen/sdk-codegen/aws-models/qconnect.json index 74a2f64b812..363e641ecaf 100644 --- a/codegen/sdk-codegen/aws-models/qconnect.json +++ b/codegen/sdk-codegen/aws-models/qconnect.json @@ -14,6 +14,20 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.qconnect#AmazonConnectGuideAssociationData": { + "type": "structure", + "members": { + "flowId": { + "target": "com.amazonaws.qconnect#GenericArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an Amazon Connect flow. Step-by-step guides are a type of flow.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Content association data for a step-by-step\n guide.
" + } + }, "com.amazonaws.qconnect#AndConditions": { "type": "list", "member": { @@ -44,7 +58,7 @@ "com.amazonaws.qconnect#Arn": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" + "smithy.api#pattern": "^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" } }, "com.amazonaws.qconnect#Assistant": { @@ -660,6 +674,11 @@ "target": "com.amazonaws.qconnect#GetContentSummary" } ], + "resources": [ + { + "target": "com.amazonaws.qconnect#ContentAssociation" + } + ], "traits": { "aws.api#arn": { "template": "content/{knowledgeBaseId}/{contentId}" @@ -667,6 +686,219 @@ "aws.iam#disableConditionKeyInference": {} } }, + "com.amazonaws.qconnect#ContentAssociation": { + "type": "resource", + "identifiers": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#UuidOrArn" + } + }, + "create": { + "target": "com.amazonaws.qconnect#CreateContentAssociation" + }, + "read": { + "target": "com.amazonaws.qconnect#GetContentAssociation" + }, + "delete": { + "target": "com.amazonaws.qconnect#DeleteContentAssociation" + }, + "list": { + "target": "com.amazonaws.qconnect#ListContentAssociations" + }, + "traits": { + "aws.api#arn": { + "template": "content-association/{knowledgeBaseId}/{contentId}/{contentAssociationId}" + }, + "aws.iam#disableConditionKeyInference": {} + } + }, + "com.amazonaws.qconnect#ContentAssociationContents": { + "type": "union", + "members": { + "amazonConnectGuideAssociation": { + "target": "com.amazonaws.qconnect#AmazonConnectGuideAssociationData", + "traits": { + "smithy.api#documentation": "The data of the step-by-step guide association.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The contents of a content association.
" + } + }, + "com.amazonaws.qconnect#ContentAssociationData": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#required": {} + } + }, + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", + "smithy.api#required": {} + } + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#required": {} + } + }, + "contentAssociationArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content association.
", + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#ContentAssociationType", + "traits": { + "smithy.api#documentation": "The type of association.
", + "smithy.api#required": {} + } + }, + "associationData": { + "target": "com.amazonaws.qconnect#ContentAssociationContents", + "traits": { + "smithy.api#documentation": "The content association.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the content association.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#ContentAssociation" + } + ] + } + }, + "com.amazonaws.qconnect#ContentAssociationSummary": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#required": {} + } + }, + "knowledgeBaseArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the knowledge base.
", + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#required": {} + } + }, + "contentArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content.
", + "smithy.api#required": {} + } + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#Uuid", + "traits": { + "smithy.api#documentation": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#required": {} + } + }, + "contentAssociationArn": { + "target": "com.amazonaws.qconnect#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the content association.
", + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#ContentAssociationType", + "traits": { + "smithy.api#documentation": "The type of association.
", + "smithy.api#required": {} + } + }, + "associationData": { + "target": "com.amazonaws.qconnect#ContentAssociationContents", + "traits": { + "smithy.api#documentation": "The content association.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a content association.
", + "smithy.api#references": [ + { + "resource": "com.amazonaws.qconnect#ContentAssociation" + } + ] + } + }, + "com.amazonaws.qconnect#ContentAssociationSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.qconnect#ContentAssociationSummary" + } + }, + "com.amazonaws.qconnect#ContentAssociationType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AMAZON_CONNECT_GUIDE", + "name": "AMAZON_CONNECT_GUIDE" + } + ] + } + }, "com.amazonaws.qconnect#ContentData": { "type": "structure", "members": { @@ -1216,6 +1448,107 @@ "smithy.api#idempotent": {} } }, + "com.amazonaws.qconnect#CreateContentAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#CreateContentAssociationRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#CreateContentAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ConflictException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.qconnect#ThrottlingException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an association between a content resource in a knowledge base and step-by-step\n guides. Step-by-step guides offer instructions to agents for resolving common\n customer issues. You create a content association to integrate Amazon Q in Connect and step-by-step\n guides.
\nAfter you integrate Amazon Q and step-by-step guides, when Amazon Q provides a\n recommendation to an agent based on the intent that it's detected, it also provides them with\n the option to start the step-by-step guide that you have associated with the content.
\nNote the following limitations:
\nYou can create only one content association for each\n content resource in a knowledge base.
\nYou can associate a step-by-step guide with multiple content resources.
\nFor more information, see Integrate Amazon Q in Connect with\n step-by-step guides in the Amazon Connect Administrator\n Guide.
", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations", + "method": "POST" + } + } + }, + "com.amazonaws.qconnect#CreateContentAssociationRequest": { + "type": "structure", + "members": { + "clientToken": { + "target": "com.amazonaws.qconnect#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", + "smithy.api#idempotencyToken": {} + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "associationType": { + "target": "com.amazonaws.qconnect#ContentAssociationType", + "traits": { + "smithy.api#documentation": "The type of association.
", + "smithy.api#required": {} + } + }, + "association": { + "target": "com.amazonaws.qconnect#ContentAssociationContents", + "traits": { + "smithy.api#documentation": "The identifier of the associated resource.
", + "smithy.api#required": {} + } + }, + "tags": { + "target": "com.amazonaws.qconnect#Tags", + "traits": { + "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#CreateContentAssociationResponse": { + "type": "structure", + "members": { + "contentAssociation": { + "target": "com.amazonaws.qconnect#ContentAssociationData", + "traits": { + "smithy.api#documentation": "The association between Amazon Q in Connect content and another resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#CreateContentRequest": { "type": "structure", "members": { @@ -1803,6 +2136,74 @@ "smithy.api#idempotent": {} } }, + "com.amazonaws.qconnect#DeleteContentAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#DeleteContentAssociationRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#DeleteContentAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the content association.
\nFor more information about content associations--what they are and when they are used--see\n Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect\n Administrator Guide.
", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations/{contentAssociationId}", + "method": "DELETE", + "code": 204 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.qconnect#DeleteContentAssociationRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#DeleteContentAssociationResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#DeleteContentRequest": { "type": "structure", "members": { @@ -2361,6 +2762,80 @@ "smithy.api#readonly": {} } }, + "com.amazonaws.qconnect#GetContentAssociation": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#GetContentAssociationRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#GetContentAssociationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the content association.
\nFor more information about content associations--what they are and when they are used--see\n Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect\n Administrator Guide.
", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations/{contentAssociationId}", + "method": "GET" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#GetContentAssociationRequest": { + "type": "structure", + "members": { + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentAssociationId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the content association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#GetContentAssociationResponse": { + "type": "structure", + "members": { + "contentAssociation": { + "target": "com.amazonaws.qconnect#ContentAssociationData", + "traits": { + "smithy.api#documentation": "The association between Amazon Q in Connect content and another resource.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#GetContentRequest": { "type": "structure", "members": { @@ -2929,7 +3404,7 @@ "failedRecordReport": { "target": "com.amazonaws.qconnect#Url", "traits": { - "smithy.api#documentation": "The link to donwload the information of resource data that failed to be imported.
" + "smithy.api#documentation": "The link to download the information of resource data that failed to be imported.
" } }, "urlExpiry": { @@ -3555,6 +4030,99 @@ } } }, + "com.amazonaws.qconnect#ListContentAssociations": { + "type": "operation", + "input": { + "target": "com.amazonaws.qconnect#ListContentAssociationsRequest" + }, + "output": { + "target": "com.amazonaws.qconnect#ListContentAssociationsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.qconnect#AccessDeniedException" + }, + { + "target": "com.amazonaws.qconnect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.qconnect#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the content associations.
\nFor more information about content associations--what they are and when they are used--see\n Integrate Amazon Q in Connect with step-by-step guides in the Amazon Connect\n Administrator Guide.
", + "smithy.api#http": { + "uri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/associations", + "method": "GET" + }, + "smithy.api#paginated": { + "inputToken": "nextToken", + "outputToken": "nextToken", + "pageSize": "maxResults", + "items": "contentAssociationSummaries" + }, + "smithy.api#readonly": {} + } + }, + "com.amazonaws.qconnect#ListContentAssociationsRequest": { + "type": "structure", + "members": { + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.qconnect#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "knowledgeBaseId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the knowledge base.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "contentId": { + "target": "com.amazonaws.qconnect#UuidOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the content.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.qconnect#ListContentAssociationsResponse": { + "type": "structure", + "members": { + "contentAssociationSummaries": { + "target": "com.amazonaws.qconnect#ContentAssociationSummaryList", + "traits": { + "smithy.api#documentation": "Summary information about content associations.
", + "smithy.api#required": {} + } + }, + "nextToken": { + "target": "com.amazonaws.qconnect#NextToken", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.qconnect#ListContents": { "type": "operation", "input": { @@ -4081,7 +4649,7 @@ "andConditions": { "target": "com.amazonaws.qconnect#AndConditions", "traits": { - "smithy.api#documentation": "A list of conditions which would be applied together with an AND
condition.
A list of conditions which would be applied together with an AND
\n condition.
A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an OR
\n condition.
A leaf node condition which can be used to specify a tag condition.\n
" + "smithy.api#documentation": "A leaf node condition which can be used to specify a tag condition.
" } }, "com.amazonaws.qconnect#TagFilter": { @@ -6384,13 +6952,13 @@ "andConditions": { "target": "com.amazonaws.qconnect#AndConditions", "traits": { - "smithy.api#documentation": "A list of conditions which would be applied together with an AND
condition.
A list of conditions which would be applied together with an AND
\n condition.
A list of conditions which would be applied together with an OR
condition.
A list of conditions which would be applied together with an OR
\n condition.
Details about the source content text data.
" } }, + "com.amazonaws.qconnect#ThrottlingException": { + "type": "structure", + "members": { + "message": { + "target": "smithy.api#String" + } + }, + "traits": { + "smithy.api#documentation": "The throttling limit has been exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400, + "smithy.api#retryable": {} + } + }, "com.amazonaws.qconnect#TimeToLive": { "type": "integer", "traits": { @@ -6911,7 +7493,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a session. A session is a contextual container used for generating recommendations.\n Amazon Connect updates the existing Amazon Q in Connect session for each contact on which Amazon Q in Connect\n is enabled.
", + "smithy.api#documentation": "Updates a session. A session is a contextual container used for generating\n recommendations. Amazon Connect updates the existing Amazon Q in Connect session for each contact on\n which Amazon Q in Connect is enabled.
", "smithy.api#http": { "uri": "/assistants/{assistantId}/sessions/{sessionId}", "method": "POST" @@ -7002,7 +7584,7 @@ "com.amazonaws.qconnect#UuidOrArn": { "type": "string", "traits": { - "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" + "smithy.api#pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$" } }, "com.amazonaws.qconnect#ValidationException": { diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 2962f27681d..18face9a2b4 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -4001,6 +4001,12 @@ "traits": { "smithy.api#documentation": "The configuration of a page break for a section.
" } + }, + "RepeatConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionRepeatConfiguration", + "traits": { + "smithy.api#documentation": "Describes the configurations that are required to declare a section as repeating.
" + } } }, "traits": { @@ -4033,6 +4039,148 @@ "smithy.api#documentation": "The configuration of content in a body section.
" } }, + "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", + "traits": { + "smithy.api#documentation": "Number of values to use from the column for repetition.
" + } + }, + "SortByMetrics": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", + "traits": { + "smithy.api#documentation": "Sort criteria on the column values that you use for repetition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.
" + } + }, + "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnSort" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", + "traits": { + "smithy.api#documentation": "Number of values to use from the column for repetition.
" + } + }, + "SortByMetrics": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", + "traits": { + "smithy.api#documentation": "Sort criteria on the column values that you use for repetition.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.
" + } + }, + "com.amazonaws.quicksight#BodySectionRepeatConfiguration": { + "type": "structure", + "members": { + "DimensionConfigurations": { + "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList", + "traits": { + "smithy.api#documentation": "List of BodySectionRepeatDimensionConfiguration
values that describe the dataset column and constraints for the column used to repeat the contents of a section.
Page break configuration to apply for each repeating instance.
" + } + }, + "NonRepeatingVisuals": { + "target": "com.amazonaws.quicksight#NonRepeatingVisualsList", + "traits": { + "smithy.api#documentation": "List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the configurations that are required to declare a section as repeating.
" + } + }, + "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration": { + "type": "structure", + "members": { + "DynamicCategoryDimensionConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration", + "traits": { + "smithy.api#documentation": "Describes the Category dataset column and constraints around the dynamic values that will be used in repeating the section contents.
" + } + }, + "DynamicNumericDimensionConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration", + "traits": { + "smithy.api#documentation": "Describes the Numeric dataset column and constraints around the dynamic values used to repeat the contents of a section.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration
" + } + }, + "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.quicksight#BodySectionRepeatPageBreakConfiguration": { + "type": "structure", + "members": { + "After": { + "target": "com.amazonaws.quicksight#SectionAfterPageBreak" + } + }, + "traits": { + "smithy.api#documentation": "The page break configuration to apply for each repeating instance.
" + } + }, "com.amazonaws.quicksight#BookmarksConfigurations": { "type": "structure", "members": { @@ -4902,6 +5050,29 @@ } } }, + "com.amazonaws.quicksight#CategoryInnerFilter": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#CategoryFilterConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "A CategoryInnerFilter
filters text values for the NestedFilter
.
A TopBottomFilter
filters data to the top or bottom values for a given column.
A NestedFilter
filters data with a subset of data that is defined by the nested inner filter.
A CategoryInnerFilter
filters text values for the NestedFilter
.
The InnerFilter
defines the subset of data to be used with the NestedFilter
.
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "The column that the filter is applied to.
", + "smithy.api#required": {} + } + }, + "IncludeInnerSet": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.
", + "smithy.api#required": {} + } + }, + "InnerFilter": { + "target": "com.amazonaws.quicksight#InnerFilter", + "traits": { + "smithy.api#documentation": "The InnerFilter
defines the subset of data to be used with the NestedFilter
.
A NestedFilter
filters data with a subset of data that is defined by the nested inner filter.
Returns the details of the DB instance’s server certificate.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" + "smithy.api#documentation": "The details of the DB instance’s server certificate.
\nFor more information, see Using SSL/TLS to encrypt a connection to a DB \n instance in the Amazon RDS User Guide and \n \n Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora \n User Guide.
" } }, "com.amazonaws.rds#CertificateList": { @@ -4221,7 +4221,7 @@ "DBSubnetGroupName": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "A DB subnet group to associate with this DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust match the name of an existing DB subnet group.
\nMust not be default
.
Example: mydbsubnetgroup
\n
A DB subnet group to associate with this DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\nValid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
\nConstraints:
\nMust match the name of an existing DB subnet group.
\nExample: mydbsubnetgroup
\n
The value of a processor feature name.
" + "smithy.api#documentation": "The value of a processor feature.
" } } }, "traits": { - "smithy.api#documentation": "Contains the processor features of a DB instance class.
\nTo specify the number of CPU cores, use the coreCount
feature name \n for the Name
parameter. To specify the number of threads per core, use the\n threadsPerCore
feature name for the Name
parameter.
You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:
\n\n CreateDBInstance
\n
\n ModifyDBInstance
\n
\n RestoreDBInstanceFromDBSnapshot
\n
\n RestoreDBInstanceFromS3
\n
\n RestoreDBInstanceToPointInTime
\n
You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions
action and specifying the\n instance class for the DBInstanceClass
parameter.
In addition, you can use the following actions for DB instance class processor information:
\n\n DescribeDBInstances
\n
\n DescribeDBSnapshots
\n
\n DescribeValidDBInstanceModifications
\n
If you call DescribeDBInstances
, ProcessorFeature
returns\n non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
\nYour Oracle DB instance class supports configuring the number of CPU cores and threads per core.
\nThe current number CPU cores and threads is set to a non-default value.
\nFor more information, see Configuring the\n Processor of the DB Instance Class in the Amazon RDS User Guide.\n \n
" + "smithy.api#documentation": "Contains the processor features of a DB instance class.
\nTo specify the number of CPU cores, use the coreCount
feature name \n for the Name
parameter. To specify the number of threads per core, use the\n threadsPerCore
feature name for the Name
parameter.
You can set the processor features of the DB instance class for a DB instance when you\n call one of the following actions:
\n\n CreateDBInstance
\n
\n ModifyDBInstance
\n
\n RestoreDBInstanceFromDBSnapshot
\n
\n RestoreDBInstanceFromS3
\n
\n RestoreDBInstanceToPointInTime
\n
You can view the valid processor values for a particular instance class by calling the\n DescribeOrderableDBInstanceOptions
action and specifying the\n instance class for the DBInstanceClass
parameter.
In addition, you can use the following actions for DB instance class processor information:
\n\n DescribeDBInstances
\n
\n DescribeDBSnapshots
\n
\n DescribeValidDBInstanceModifications
\n
If you call DescribeDBInstances
, ProcessorFeature
returns\n non-null values only if the following conditions are met:
You are accessing an Oracle DB instance.
\nYour Oracle DB instance class supports configuring the number of CPU cores and threads per core.
\nThe current number CPU cores and threads is set to a non-default value.
\nFor more information, see \n Configuring the processor for a DB instance class in RDS for Oracle in the Amazon RDS User Guide.\n \n
" } }, "com.amazonaws.rds#ProcessorFeatureList": { @@ -29918,7 +29918,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nYou can't export snapshot data from Db2 or RDS Custom DB instances.
\nYou can't export cluster data from Multi-AZ DB clusters.
\nFor more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
\nFor more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.
", + "smithy.api#documentation": "Starts an export of DB snapshot or DB cluster data to Amazon S3. \n The provided IAM role must have access to the S3 bucket.
\nYou can't export snapshot data from Db2 or RDS Custom DB instances.
\nFor more information on exporting DB snapshot data, see \n Exporting DB snapshot \n data to Amazon S3 in the Amazon RDS User Guide\n or Exporting DB \n cluster snapshot data to Amazon S3 in the Amazon Aurora User Guide.
\nFor more information on exporting DB cluster data, see \n Exporting DB \n cluster data to Amazon S3 in the Amazon Aurora User Guide.
", "smithy.api#examples": [ { "title": "To export a snapshot to Amazon S3", diff --git a/codegen/sdk-codegen/aws-models/sagemaker.json b/codegen/sdk-codegen/aws-models/sagemaker.json index e494fc80ec4..a02c56b9e21 100644 --- a/codegen/sdk-codegen/aws-models/sagemaker.json +++ b/codegen/sdk-codegen/aws-models/sagemaker.json @@ -6503,7 +6503,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS)\n volume to each instance of the SageMaker HyperPod cluster instance group.
" + "smithy.api#documentation": "Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS)\n volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" } }, "com.amazonaws.sagemaker#ClusterEbsVolumeSizeInGB": { @@ -6755,7 +6755,7 @@ } }, "traits": { - "smithy.api#documentation": "Defines the configuration for attaching additional storage to the instances in the\n SageMaker HyperPod cluster instance group.
" + "smithy.api#documentation": "Defines the configuration for attaching additional storage to the instances in the\n SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
" } }, "com.amazonaws.sagemaker#ClusterInstanceStorageConfigs": { @@ -15568,7 +15568,7 @@ "target": "com.amazonaws.sagemaker#HubContentType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of hub content to delete.
", + "smithy.api#documentation": "The type of hub content reference to delete. The only supported type of hub content reference to delete is ModelReference
.
The machine learning tools that are hidden from the Studio left navigation pane.
" + } + }, + "HiddenAppTypes": { + "target": "com.amazonaws.sagemaker#HiddenAppTypesList", + "traits": { + "smithy.api#documentation": "The Applications supported in Studio that are hidden from the Studio left navigation pane.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
" + } + }, "com.amazonaws.sagemaker#SubnetId": { "type": "string", "traits": { @@ -68473,6 +68588,12 @@ "traits": { "smithy.api#documentation": "The settings for assigning a custom file system to a user profile. Permitted users can\n access this file system in Amazon SageMaker Studio.
" } + }, + "StudioWebPortalSettings": { + "target": "com.amazonaws.sagemaker#StudioWebPortalSettings", + "traits": { + "smithy.api#documentation": "Studio settings. If these settings are applied on a user level, they take priority over the settings applied on a domain level.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/workspaces.json b/codegen/sdk-codegen/aws-models/workspaces.json index 06482832e7a..c9a15e8a696 100644 --- a/codegen/sdk-codegen/aws-models/workspaces.json +++ b/codegen/sdk-codegen/aws-models/workspaces.json @@ -32,7 +32,7 @@ "com.amazonaws.workspaces#ARN": { "type": "string", "traits": { - "smithy.api#pattern": "^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$" + "smithy.api#pattern": "^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\\\-]{0,1023}$" } }, "com.amazonaws.workspaces#AcceptAccountLinkInvitation": { @@ -251,6 +251,44 @@ "target": "com.amazonaws.workspaces#AccountModification" } }, + "com.amazonaws.workspaces#ActiveDirectoryConfig": { + "type": "structure", + "members": { + "DomainName": { + "target": "com.amazonaws.workspaces#DomainName", + "traits": { + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#required": {} + } + }, + "ServiceAccountSecretArn": { + "target": "com.amazonaws.workspaces#SecretsManagerArn", + "traits": { + "smithy.api#documentation": "Indicates the secret ARN on the service account.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the Active Directory config.
" + } + }, + "com.amazonaws.workspaces#ActiveUserSessions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.workspaces#ActualUserSessions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.workspaces#AddInName": { "type": "string", "traits": { @@ -406,6 +444,71 @@ "target": "com.amazonaws.workspaces#ApplicationResourceAssociation" } }, + "com.amazonaws.workspaces#ApplicationSettingsRequest": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.workspaces#ApplicationSettingsStatusEnum", + "traits": { + "smithy.api#documentation": "Enables or disables persistent application settings for users during their pool sessions.
", + "smithy.api#required": {} + } + }, + "SettingsGroup": { + "target": "com.amazonaws.workspaces#SettingsGroup", + "traits": { + "smithy.api#documentation": "The path prefix for the S3 bucket where users’ persistent application settings are stored. \n You can allow the same persistent application settings to be used across multiple pools by specifying \n the same settings group for each pool.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The persistent application settings for users of a WorkSpaces pool.
" + } + }, + "com.amazonaws.workspaces#ApplicationSettingsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.workspaces#ApplicationSettingsStatusEnum", + "traits": { + "smithy.api#documentation": "Specifies whether persistent application settings are enabled for users during their pool sessions.
", + "smithy.api#required": {} + } + }, + "SettingsGroup": { + "target": "com.amazonaws.workspaces#SettingsGroup", + "traits": { + "smithy.api#documentation": "The path prefix for the S3 bucket where users’ persistent application settings are stored.
" + } + }, + "S3BucketName": { + "target": "com.amazonaws.workspaces#S3BucketName", + "traits": { + "smithy.api#documentation": "The S3 bucket where users’ persistent application settings are stored. When persistent \n application settings are enabled for the first time for an account in an Amazon Web Services Region, \n an S3 bucket is created. The bucket is unique to the Amazon Web Services account and the Region.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the persistent application settings for users of a WorkSpaces pool.
" + } + }, + "com.amazonaws.workspaces#ApplicationSettingsStatusEnum": { + "type": "enum", + "members": { + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + }, + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + } + } + }, "com.amazonaws.workspaces#AssociateConnectionAlias": { "type": "operation", "input": { @@ -764,6 +867,17 @@ } } }, + "com.amazonaws.workspaces#AuthenticationType": { + "type": "enum", + "members": { + "SAML": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAML" + } + } + } + }, "com.amazonaws.workspaces#AuthorizeIpRules": { "type": "operation", "input": { @@ -822,6 +936,14 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#AvailableUserSessions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.workspaces#AwsAccount": { "type": "string", "traits": { @@ -948,6 +1070,57 @@ } } }, + "com.amazonaws.workspaces#Capacity": { + "type": "structure", + "members": { + "DesiredUserSessions": { + "target": "com.amazonaws.workspaces#DesiredUserSessions", + "traits": { + "smithy.api#documentation": "The desired number of user sessions for a multi-session pool. \n This is not allowed for single-session pools.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the user capacity for a WorkSpaces pool.
" + } + }, + "com.amazonaws.workspaces#CapacityStatus": { + "type": "structure", + "members": { + "AvailableUserSessions": { + "target": "com.amazonaws.workspaces#AvailableUserSessions", + "traits": { + "smithy.api#documentation": "The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.
", + "smithy.api#required": {} + } + }, + "DesiredUserSessions": { + "target": "com.amazonaws.workspaces#DesiredUserSessions", + "traits": { + "smithy.api#documentation": "The total number of sessions slots that are either running or pending. This \n represents the total number of concurrent streaming sessions your pool can support \n in a steady state.
", + "smithy.api#required": {} + } + }, + "ActualUserSessions": { + "target": "com.amazonaws.workspaces#ActualUserSessions", + "traits": { + "smithy.api#documentation": "The total number of session slots that are available for WorkSpaces pools.
", + "smithy.api#required": {} + } + }, + "ActiveUserSessions": { + "target": "com.amazonaws.workspaces#ActiveUserSessions", + "traits": { + "smithy.api#documentation": "The number of user sessions currently being used for pool sessions. This only applies to multi-session pools.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the capacity status for a WorkSpaces pool
" + } + }, "com.amazonaws.workspaces#CertificateAuthorityArn": { "type": "string", "traits": { @@ -2308,6 +2481,113 @@ "smithy.api#documentation": "Creates one or more WorkSpaces.
\nThis operation is asynchronous and returns before the WorkSpaces are created.
\nThe MANUAL
running mode value is only supported by Amazon WorkSpaces\n Core. Contact your account team to be allow-listed to use this value. For more\n information, see Amazon WorkSpaces\n Core.
You don't need to specify the PCOIP
protocol for Linux bundles\n because WSP
is the default protocol for those bundles.
User-decoupled WorkSpaces are only supported by Amazon WorkSpaces\n Core.
\nCreates a pool of WorkSpaces.
" + } + }, + "com.amazonaws.workspaces#CreateWorkspacesPoolRequest": { + "type": "structure", + "members": { + "PoolName": { + "target": "com.amazonaws.workspaces#WorkspacesPoolName", + "traits": { + "smithy.api#documentation": "The name of the WorkSpaces pool.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.workspaces#UpdateDescription", + "traits": { + "smithy.api#documentation": "The WorkSpaces pool description.
", + "smithy.api#required": {} + } + }, + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "The identifier of the bundle for the WorkSpaces pool.
", + "smithy.api#required": {} + } + }, + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier of the directory for the WorkSpaces pool.
", + "smithy.api#required": {} + } + }, + "Capacity": { + "target": "com.amazonaws.workspaces#Capacity", + "traits": { + "smithy.api#documentation": "The user capacity of the WorkSpaces pool.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.workspaces#TagList", + "traits": { + "smithy.api#documentation": "The tags for the WorkSpaces pool.
" + } + }, + "ApplicationSettings": { + "target": "com.amazonaws.workspaces#ApplicationSettingsRequest", + "traits": { + "smithy.api#documentation": "Indicates the application settings of the WorkSpaces pool.
" + } + }, + "TimeoutSettings": { + "target": "com.amazonaws.workspaces#TimeoutSettings", + "traits": { + "smithy.api#documentation": "Indicates the timeout settings of the WorkSpaces pool.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#CreateWorkspacesPoolResult": { + "type": "structure", + "members": { + "WorkspacesPool": { + "target": "com.amazonaws.workspaces#WorkspacesPool", + "traits": { + "smithy.api#documentation": "Indicates the WorkSpaces pool to create.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#CreateWorkspacesRequest": { "type": "structure", "members": { @@ -2586,6 +2866,12 @@ "traits": { "smithy.api#documentation": "Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see\n WorkSpace\n Maintenance.
" } + }, + "InstanceIamRoleArn": { + "target": "com.amazonaws.workspaces#ARN", + "traits": { + "smithy.api#documentation": "Indicates the IAM role ARN of the instance.
" + } } }, "traits": { @@ -4203,6 +4489,12 @@ "smithy.api#documentation": "The identifiers of the directories. If the value is null, all directories are\n retrieved.
" } }, + "WorkspaceDirectoryNames": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryNameList", + "traits": { + "smithy.api#documentation": "The names of the WorkSpace directories.
" + } + }, "Limit": { "target": "com.amazonaws.workspaces#Limit", "traits": { @@ -4526,35 +4818,47 @@ "smithy.api#output": {} } }, - "com.amazonaws.workspaces#DescribeWorkspacesRequest": { - "type": "structure", - "members": { - "WorkspaceIds": { - "target": "com.amazonaws.workspaces#WorkspaceIdList", - "traits": { - "smithy.api#documentation": "The identifiers of the WorkSpaces. You cannot combine this parameter with any other\n filter.
\nBecause the CreateWorkspaces operation is asynchronous, the identifier\n it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
" - } + "com.amazonaws.workspaces#DescribeWorkspacesPoolSessions": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolSessionsRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolSessionsResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" }, - "DirectoryId": { - "target": "com.amazonaws.workspaces#DirectoryId", - "traits": { - "smithy.api#documentation": "The identifier of the directory. In addition, you can optionally specify a specific\n directory user (see UserName
). You cannot combine this parameter with any\n other filter.
Retrieves a list that describes the streaming sessions for a specified WorkSpaces pool.
" + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesPoolSessionsRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.workspaces#WorkspacesPoolId", "traits": { - "smithy.api#documentation": "The name of the directory user. You must specify this parameter with\n DirectoryId
.
The identifier of the WorkSpaces pool.
", + "smithy.api#required": {} } }, - "BundleId": { - "target": "com.amazonaws.workspaces#BundleId", + "UserId": { + "target": "com.amazonaws.workspaces#WorkspacesPoolUserId", "traits": { - "smithy.api#documentation": "The identifier of the bundle. All WorkSpaces that are created from this bundle are\n retrieved. You cannot combine this parameter with any other filter.
" + "smithy.api#documentation": "The identifier of the user.
" } }, "Limit": { - "target": "com.amazonaws.workspaces#Limit", + "target": "com.amazonaws.workspaces#Limit50", "traits": { "smithy.api#documentation": "The maximum number of items to return.
" } @@ -4562,13 +4866,255 @@ "NextToken": { "target": "com.amazonaws.workspaces#PaginationToken", "traits": { - "smithy.api#documentation": "If you received a NextToken
from a previous call that was paginated,\n provide this token to receive the next set of results.
The name of the user-decoupled WorkSpace.
" + "smithy.api#documentation": "If you received a NextToken
from a previous call that was paginated, \n provide this token to receive the next set of results.
Describes the WorkSpaces pool sessions.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a NextToken
from a previous call that was paginated, \n provide this token to receive the next set of results.
Describes the specified WorkSpaces pool.
" + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterName", + "traits": { + "smithy.api#documentation": "The name of the pool to filter.
", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterValues", + "traits": { + "smithy.api#documentation": "The values for filtering WorkSpaces pools.
", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterOperator", + "traits": { + "smithy.api#documentation": "The operator values for filtering WorkSpaces pools.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the filter conditions for the WorkSpaces pool to return.
" + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterName": { + "type": "enum", + "members": { + "POOLNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PoolName" + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterOperator": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "NOTEQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOTEQUALS" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "NOTCONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOTCONTAINS" + } + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]+$" + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterValues": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilterValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#DescribeWorkspacesPoolsRequest": { + "type": "structure", + "members": { + "PoolIds": { + "target": "com.amazonaws.workspaces#WorkspacesPoolIds", + "traits": { + "smithy.api#documentation": "The identifier of the WorkSpaces pool.
" + } + }, + "Filters": { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolsFilters", + "traits": { + "smithy.api#documentation": "The filter conditions for the WorkSpaces pool to return.
" + } + }, + "Limit": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "The maximum number of items to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a NextToken
from a previous call that was paginated, \n provide this token to receive the next set of results.
Information about the WorkSpaces pools.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a NextToken
from a previous call that was paginated, \n provide this token to receive the next set of results.
The identifiers of the WorkSpaces. You cannot combine this parameter with any other\n filter.
\nBecause the CreateWorkspaces operation is asynchronous, the identifier\n it returns is not immediately available. If you immediately call DescribeWorkspaces with this identifier, no information is returned.
" + } + }, + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier of the directory. In addition, you can optionally specify a specific\n directory user (see UserName
). You cannot combine this parameter with any\n other filter.
The name of the directory user. You must specify this parameter with\n DirectoryId
.
The identifier of the bundle. All WorkSpaces that are created from this bundle are\n retrieved. You cannot combine this parameter with any other filter.
" + } + }, + "Limit": { + "target": "com.amazonaws.workspaces#Limit", + "traits": { + "smithy.api#documentation": "The maximum number of items to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.workspaces#PaginationToken", + "traits": { + "smithy.api#documentation": "If you received a NextToken
from a previous call that was paginated,\n provide this token to receive the next set of results.
The name of the user-decoupled WorkSpace.
" } } }, @@ -4599,6 +5145,14 @@ "com.amazonaws.workspaces#Description": { "type": "string" }, + "com.amazonaws.workspaces#DesiredUserSessions": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.workspaces#DirectoryId": { "type": "string", "traits": { @@ -4606,7 +5160,7 @@ "min": 10, "max": 65 }, - "smithy.api#pattern": "^d-[0-9a-f]{8,63}$" + "smithy.api#pattern": "^(d-[0-9a-f]{8,63}$)|(wsd-[0-9a-z]{8,63}$)$" } }, "com.amazonaws.workspaces#DirectoryIdList": { @@ -4699,6 +5253,9 @@ { "target": "com.amazonaws.workspaces#InvalidResourceStateException" }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, { "target": "com.amazonaws.workspaces#ResourceNotFoundException" } @@ -4801,12 +5358,27 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#DisconnectTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 60, + "max": 36000 + } + } + }, "com.amazonaws.workspaces#DnsIpAddresses": { "type": "list", "member": { "target": "com.amazonaws.workspaces#IpAddress" } }, + "com.amazonaws.workspaces#DomainName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([a-zA-Z0-9]+[\\\\.-])+([a-zA-Z0-9])+$" + } + }, "com.amazonaws.workspaces#Ec2ImageId": { "type": "string", "traits": { @@ -4839,6 +5411,9 @@ "target": "com.amazonaws.workspaces#ErrorDetails" } }, + "com.amazonaws.workspaces#ErrorMessage": { + "type": "string" + }, "com.amazonaws.workspaces#ErrorType": { "type": "string" }, @@ -5028,6 +5603,15 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#IdleDisconnectTimeoutInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 36000 + } + } + }, "com.amazonaws.workspaces#ImageAssociatedResourceType": { "type": "enum", "members": { @@ -5595,6 +6179,15 @@ } } }, + "com.amazonaws.workspaces#Limit50": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 50 + } + } + }, "com.amazonaws.workspaces#LinkId": { "type": "string", "traits": { @@ -5790,6 +6383,23 @@ } } }, + "com.amazonaws.workspaces#MaxUserDurationInSeconds": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 600, + "max": 432000 + } + } + }, + "com.amazonaws.workspaces#MaximumLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.workspaces#MigrateWorkspace": { "type": "operation", "input": { @@ -6061,6 +6671,9 @@ { "target": "com.amazonaws.workspaces#InvalidParameterValuesException" }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, { "target": "com.amazonaws.workspaces#ResourceNotFoundException" } @@ -6173,6 +6786,9 @@ { "target": "com.amazonaws.workspaces#InvalidParameterValuesException" }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, { "target": "com.amazonaws.workspaces#ResourceNotFoundException" } @@ -6210,22 +6826,76 @@ "smithy.api#output": {} } }, - "com.amazonaws.workspaces#ModifyWorkspaceAccessProperties": { + "com.amazonaws.workspaces#ModifyStreamingProperties": { "type": "operation", "input": { - "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesRequest" + "target": "com.amazonaws.workspaces#ModifyStreamingPropertiesRequest" }, "output": { - "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesResult" + "target": "com.amazonaws.workspaces#ModifyStreamingPropertiesResult" }, "errors": [ { "target": "com.amazonaws.workspaces#AccessDeniedException" }, { - "target": "com.amazonaws.workspaces#ResourceNotFoundException" - } - ], + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the specified streaming properties.
" + } + }, + "com.amazonaws.workspaces#ModifyStreamingPropertiesRequest": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier of the resource.
", + "smithy.api#required": {} + } + }, + "StreamingProperties": { + "target": "com.amazonaws.workspaces#StreamingProperties", + "traits": { + "smithy.api#documentation": "The streaming properties to configure.
" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#ModifyStreamingPropertiesResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#ModifyWorkspaceAccessProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessPropertiesResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], "traits": { "smithy.api#documentation": "Specifies which devices and operating systems users can use to access their WorkSpaces.\n For more information, see \n Control Device Access.
" } @@ -6438,6 +7108,26 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#NetworkAccessConfiguration": { + "type": "structure", + "members": { + "EniPrivateIpAddress": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The private IP address of the elastic network interface that is attached to instances in your VPC.
" + } + }, + "EniId": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The resource identifier of the elastic network interface that is attached to instances in your \n VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the network details of a WorkSpaces pool.
" + } + }, "com.amazonaws.workspaces#NonEmptyString": { "type": "string", "traits": { @@ -6859,6 +7549,9 @@ { "target": "com.amazonaws.workspaces#OperationNotSupportedException" }, + { + "target": "com.amazonaws.workspaces#ResourceAlreadyExistsException" + }, { "target": "com.amazonaws.workspaces#ResourceLimitExceededException" }, @@ -6882,8 +7575,7 @@ "DirectoryId": { "target": "com.amazonaws.workspaces#DirectoryId", "traits": { - "smithy.api#documentation": "The identifier of the directory. You cannot register a directory if it does not have a\n status of Active. If the directory does not have a status of Active, you will receive an\n InvalidResourceStateException error. If you have already registered the maximum number of\n directories that you can register with Amazon WorkSpaces, you will receive a\n ResourceLimitExceededException error. Deregister directories that you are not using for\n WorkSpaces, and try again.
", - "smithy.api#required": {} + "smithy.api#documentation": "The identifier of the directory. You cannot register a directory if it does not have a\n status of Active. If the directory does not have a status of Active, you will receive an\n InvalidResourceStateException error. If you have already registered the maximum number of\n directories that you can register with Amazon WorkSpaces, you will receive a\n ResourceLimitExceededException error. Deregister directories that you are not using for\n WorkSpaces, and try again.
" } }, "SubnetIds": { @@ -6895,8 +7587,7 @@ "EnableWorkDocs": { "target": "com.amazonaws.workspaces#BooleanObject", "traits": { - "smithy.api#documentation": "Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this\n parameter and WorkDocs is not available in the Region, you will receive an\n OperationNotSupportedException error. Set EnableWorkDocs
to disabled, and try\n again.
Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this\n parameter and WorkDocs is not available in the Region, you will receive an\n OperationNotSupportedException error. Set EnableWorkDocs
to disabled, and try\n again.
The tags associated with the directory.
" } + }, + "WorkspaceDirectoryName": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryName", + "traits": { + "smithy.api#documentation": "The name of the directory to register.
" + } + }, + "WorkspaceDirectoryDescription": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryDescription", + "traits": { + "smithy.api#documentation": "Description of the directory to register.
" + } + }, + "UserIdentityType": { + "target": "com.amazonaws.workspaces#UserIdentityType", + "traits": { + "smithy.api#documentation": "The type of identity management the user is using.
" + } + }, + "WorkspaceType": { + "target": "com.amazonaws.workspaces#WorkspaceType", + "traits": { + "smithy.api#documentation": "Indicates whether the directory's WorkSpace type is personal or pools.
" + } + }, + "ActiveDirectoryConfig": { + "target": "com.amazonaws.workspaces#ActiveDirectoryConfig", + "traits": { + "smithy.api#documentation": "The active directory config of the directory.
" + } } }, "traits": { @@ -6924,7 +7645,20 @@ }, "com.amazonaws.workspaces#RegisterWorkspaceDirectoryResult": { "type": "structure", - "members": {}, + "members": { + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier of the directory.
" + } + }, + "State": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryState", + "traits": { + "smithy.api#documentation": "The registration status of the WorkSpace directory.
" + } + } + }, "traits": { "smithy.api#output": {} } @@ -7309,6 +8043,16 @@ "com.amazonaws.workspaces#RunningModeAutoStopTimeoutInMinutes": { "type": "integer" }, + "com.amazonaws.workspaces#S3BucketName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + }, + "smithy.api#pattern": "^[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]$" + } + }, "com.amazonaws.workspaces#SamlProperties": { "type": "structure", "members": { @@ -7368,6 +8112,12 @@ "smithy.api#pattern": "^(http|https)\\://\\S+$" } }, + "com.amazonaws.workspaces#SecretsManagerArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws[a-z-]{0,7}:secretsmanager:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:secret:[A-Za-z0-9][A-za-z0-9_/.-]{8,519}$" + } + }, "com.amazonaws.workspaces#SecurityGroupId": { "type": "string", "traits": { @@ -7416,6 +8166,39 @@ "smithy.api#documentation": "Describes the self-service permissions for a directory. For more information, see Enable Self-Service WorkSpace Management Capabilities for Your Users.
" } }, + "com.amazonaws.workspaces#SessionConnectionState": { + "type": "enum", + "members": { + "CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTED" + } + }, + "NOT_CONNECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOT_CONNECTED" + } + } + } + }, + "com.amazonaws.workspaces#SessionInstanceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^i-[a-f0-9]{8}(?:[a-f0-9]{9})?$" + } + }, + "com.amazonaws.workspaces#SettingsGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + }, + "smithy.api#pattern": "^[A-Za-z0-9_./()!*'-]+$" + } + }, "com.amazonaws.workspaces#Snapshot": { "type": "structure", "members": { @@ -7569,6 +8352,63 @@ "smithy.api#documentation": "Starts the specified WorkSpaces.
\nYou cannot start a WorkSpace unless it has a running mode of AutoStop
and a\n state of STOPPED
.
Starts the specified WorkSpaces pool.
\nYou cannot start a WorkSpace pool unless it has a running mode of \n AutoStop
and a state of STOPPED
.
The identifier of the WorkSpaces pool.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#StartWorkspacesPoolResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#StartWorkspacesRequest": { "type": "structure", "members": { @@ -7636,6 +8476,57 @@ "smithy.api#documentation": "Stops the specified WorkSpaces.
\nYou cannot stop a WorkSpace unless it has a running mode of AutoStop
and a\n state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or\n ERROR
.
Stops the specifiedWorkSpaces pool.
\nYou cannot stop a WorkSpace pool unless it has a running mode of AutoStop
\n and a state of AVAILABLE
, IMPAIRED
, UNHEALTHY
, or ERROR
.
The identifier of the WorkSpaces pool.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#StopWorkspacesPoolResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#StopWorkspacesRequest": { "type": "structure", "members": { @@ -7665,32 +8556,136 @@ "smithy.api#output": {} } }, - "com.amazonaws.workspaces#String2048": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 + "com.amazonaws.workspaces#StorageConnector": { + "type": "structure", + "members": { + "ConnectorType": { + "target": "com.amazonaws.workspaces#StorageConnectorTypeEnum", + "traits": { + "smithy.api#documentation": "The type of connector used to save user files.
", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.workspaces#StorageConnectorStatusEnum", + "traits": { + "smithy.api#documentation": "Indicates if the storage connetor is enabled or disabled.
", + "smithy.api#required": {} + } } - } - }, - "com.amazonaws.workspaces#SubnetId": { - "type": "string", + }, "traits": { - "smithy.api#length": { - "min": 15, - "max": 24 - }, - "smithy.api#pattern": "^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$" + "smithy.api#documentation": "Describes the storage connector.
" } }, - "com.amazonaws.workspaces#SubnetIds": { - "type": "list", - "member": { - "target": "com.amazonaws.workspaces#SubnetId" - }, - "traits": { - "smithy.api#length": { + "com.amazonaws.workspaces#StorageConnectorStatusEnum": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.workspaces#StorageConnectorTypeEnum": { + "type": "enum", + "members": { + "HOME_FOLDER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOME_FOLDER" + } + } + } + }, + "com.amazonaws.workspaces#StorageConnectors": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#StorageConnector" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.workspaces#StreamingExperiencePreferredProtocolEnum": { + "type": "enum", + "members": { + "TCP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TCP" + } + }, + "UDP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UDP" + } + } + } + }, + "com.amazonaws.workspaces#StreamingProperties": { + "type": "structure", + "members": { + "StreamingExperiencePreferredProtocol": { + "target": "com.amazonaws.workspaces#StreamingExperiencePreferredProtocolEnum", + "traits": { + "smithy.api#documentation": "Indicates the type of preferred protocol for the streaming experience.
" + } + }, + "UserSettings": { + "target": "com.amazonaws.workspaces#UserSettings", + "traits": { + "smithy.api#documentation": "Indicates the permission settings asscoiated with the user.
" + } + }, + "StorageConnectors": { + "target": "com.amazonaws.workspaces#StorageConnectors", + "traits": { + "smithy.api#documentation": "Indicates the storage connector used
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the streaming properties.
" + } + }, + "com.amazonaws.workspaces#String2048": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, + "com.amazonaws.workspaces#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 15, + "max": 24 + }, + "smithy.api#pattern": "^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$" + } + }, + "com.amazonaws.workspaces#SubnetIds": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#SubnetId" + }, + "traits": { + "smithy.api#length": { "min": 0, "max": 2 } @@ -7820,6 +8815,108 @@ "smithy.api#documentation": "Terminates the specified WorkSpaces.
\nTerminating a WorkSpace is a permanent action and cannot be undone. The user's data\n is destroyed. If you need to archive any user data, contact Amazon Web Services Support before\n terminating the WorkSpace.
\nYou can terminate a WorkSpace that is in any state except SUSPENDED
.
This operation is asynchronous and returns before the WorkSpaces have been completely\n terminated. After a WorkSpace is terminated, the TERMINATED
state is returned\n only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely\n returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using\n \n DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has\n been successfully terminated.
Simple AD and AD Connector are made available to you free of charge to use with\n WorkSpaces. If there are no WorkSpaces being used with your Simple AD or AD Connector\n directory for 30 consecutive days, this directory will be automatically deregistered for\n use with Amazon WorkSpaces, and you will be charged for this directory as per the Directory Service pricing\n terms.
\nTo delete empty directories, see Delete the\n Directory for Your WorkSpaces. If you delete your Simple AD or AD Connector\n directory, you can always create a new one when you want to start using WorkSpaces\n again.
\nTerminates the specified WorkSpaces pool.
" + } + }, + "com.amazonaws.workspaces#TerminateWorkspacesPoolRequest": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.workspaces#WorkspacesPoolId", + "traits": { + "smithy.api#documentation": "The identifier of the WorkSpaces pool.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#TerminateWorkspacesPoolResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#TerminateWorkspacesPoolSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#TerminateWorkspacesPoolSessionRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#TerminateWorkspacesPoolSessionResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#OperationInProgressException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Terminates the WorkSpaces pool session.
" + } + }, + "com.amazonaws.workspaces#TerminateWorkspacesPoolSessionRequest": { + "type": "structure", + "members": { + "SessionId": { + "target": "com.amazonaws.workspaces#AmazonUuid", + "traits": { + "smithy.api#documentation": "The identifier of the WorkSpaces pool session.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.workspaces#TerminateWorkspacesPoolSessionResult": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.workspaces#TerminateWorkspacesRequest": { "type": "structure", "members": { @@ -7849,6 +8946,32 @@ "smithy.api#output": {} } }, + "com.amazonaws.workspaces#TimeoutSettings": { + "type": "structure", + "members": { + "DisconnectTimeoutInSeconds": { + "target": "com.amazonaws.workspaces#DisconnectTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. \n If users try to reconnect to the streaming session after a disconnection or network interruption \n within the time set, they are connected to their previous session. Otherwise, they are connected \n to a new session with a new streaming instance.
" + } + }, + "IdleDisconnectTimeoutInSeconds": { + "target": "com.amazonaws.workspaces#IdleDisconnectTimeoutInSeconds", + "traits": { + "smithy.api#documentation": "The amount of time in seconds a connection will stay active while idle.
" + } + }, + "MaxUserDurationInSeconds": { + "target": "com.amazonaws.workspaces#MaxUserDurationInSeconds", + "traits": { + "smithy.api#documentation": "Specifies the maximum amount of time, in seconds, that a streaming session can remain active. \n If users are still connected to a streaming instance five minutes before this limit is reached, \n they are prompted to save any open documents before being disconnected. After this time elapses, \n the instance is terminated and replaced by a new instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the timeout settings for a WorkSpaces pool.
" + } + }, "com.amazonaws.workspaces#Timestamp": { "type": "timestamp" }, @@ -8213,36 +9336,238 @@ "smithy.api#output": {} } }, - "com.amazonaws.workspaces#UserName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 63 + "com.amazonaws.workspaces#UpdateWorkspacesPool": { + "type": "operation", + "input": { + "target": "com.amazonaws.workspaces#UpdateWorkspacesPoolRequest" + }, + "output": { + "target": "com.amazonaws.workspaces#UpdateWorkspacesPoolResult" + }, + "errors": [ + { + "target": "com.amazonaws.workspaces#AccessDeniedException" + }, + { + "target": "com.amazonaws.workspaces#InvalidParameterValuesException" + }, + { + "target": "com.amazonaws.workspaces#InvalidResourceStateException" + }, + { + "target": "com.amazonaws.workspaces#OperationInProgressException" + }, + { + "target": "com.amazonaws.workspaces#OperationNotSupportedException" + }, + { + "target": "com.amazonaws.workspaces#ResourceLimitExceededException" + }, + { + "target": "com.amazonaws.workspaces#ResourceNotFoundException" } + ], + "traits": { + "smithy.api#documentation": "Updates the specified WorkSpaces pool.
" } }, - "com.amazonaws.workspaces#UserStorage": { + "com.amazonaws.workspaces#UpdateWorkspacesPoolRequest": { "type": "structure", "members": { + "PoolId": { + "target": "com.amazonaws.workspaces#WorkspacesPoolId", + "traits": { + "smithy.api#documentation": "The identifier of the specified WorkSpaces pool to update.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.workspaces#UpdateDescription", + "traits": { + "smithy.api#documentation": "Describes the specified WorkSpaces pool to update.
" + } + }, + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "The identifier of the bundle.
" + } + }, + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier of the directory.
" + } + }, "Capacity": { - "target": "com.amazonaws.workspaces#NonEmptyString", + "target": "com.amazonaws.workspaces#Capacity", "traits": { - "smithy.api#documentation": "The size of the user volume.
" + "smithy.api#documentation": "The desired capacity for the WorkSpaces pool.
" + } + }, + "ApplicationSettings": { + "target": "com.amazonaws.workspaces#ApplicationSettingsRequest", + "traits": { + "smithy.api#documentation": "The persistent application settings for users in the pool.
" + } + }, + "TimeoutSettings": { + "target": "com.amazonaws.workspaces#TimeoutSettings", + "traits": { + "smithy.api#documentation": "Indicates the timeout settings of the specified WorkSpaces pool.
" } } }, "traits": { - "smithy.api#documentation": "Describes the user volume for a WorkSpace bundle.
" + "smithy.api#input": {} } }, - "com.amazonaws.workspaces#UserVolumeSizeGib": { - "type": "integer" - }, - "com.amazonaws.workspaces#ValidationException": { + "com.amazonaws.workspaces#UpdateWorkspacesPoolResult": { "type": "structure", "members": { - "message": { + "WorkspacesPool": { + "target": "com.amazonaws.workspaces#WorkspacesPool", + "traits": { + "smithy.api#documentation": "Describes the specified WorkSpaces pool.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.workspaces#UserIdentityType": { + "type": "enum", + "members": { + "CUSTOMER_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED" + } + }, + "AWS_DIRECTORY_SERVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_DIRECTORY_SERVICE" + } + } + } + }, + "com.amazonaws.workspaces#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 63 + } + } + }, + "com.amazonaws.workspaces#UserSetting": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.workspaces#UserSettingActionEnum", + "traits": { + "smithy.api#documentation": "Indicates the type of action.
", + "smithy.api#required": {} + } + }, + "Permission": { + "target": "com.amazonaws.workspaces#UserSettingPermissionEnum", + "traits": { + "smithy.api#documentation": "Indicates if the setting is enabled or disabled.
", + "smithy.api#required": {} + } + }, + "MaximumLength": { + "target": "com.amazonaws.workspaces#MaximumLength", + "traits": { + "smithy.api#documentation": "Indicates the maximum character length for the specified user setting.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the user's permission settings.
" + } + }, + "com.amazonaws.workspaces#UserSettingActionEnum": { + "type": "enum", + "members": { + "CLIPBOARD_COPY_FROM_LOCAL_DEVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIPBOARD_COPY_FROM_LOCAL_DEVICE" + } + }, + "CLIPBOARD_COPY_TO_LOCAL_DEVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLIPBOARD_COPY_TO_LOCAL_DEVICE" + } + }, + "PRINTING_TO_LOCAL_DEVICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRINTING_TO_LOCAL_DEVICE" + } + }, + "SMART_CARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMART_CARD" + } + } + } + }, + "com.amazonaws.workspaces#UserSettingPermissionEnum": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.workspaces#UserSettings": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#UserSetting" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.workspaces#UserStorage": { + "type": "structure", + "members": { + "Capacity": { + "target": "com.amazonaws.workspaces#NonEmptyString", + "traits": { + "smithy.api#documentation": "The size of the user volume.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the user volume for a WorkSpace bundle.
" + } + }, + "com.amazonaws.workspaces#UserVolumeSizeGib": { + "type": "integer" + }, + "com.amazonaws.workspaces#ValidationException": { + "type": "structure", + "members": { + "message": { "target": "com.amazonaws.workspaces#ExceptionMessage" } }, @@ -8800,6 +10125,12 @@ "traits": { "smithy.api#documentation": "Indicates whether maintenance mode is enabled for your WorkSpaces. For more information,\n see WorkSpace\n Maintenance.
" } + }, + "InstanceIamRoleArn": { + "target": "com.amazonaws.workspaces#ARN", + "traits": { + "smithy.api#documentation": "Indicates the IAM role ARN of the instance.
" + } } }, "traits": { @@ -8916,12 +10247,78 @@ "traits": { "smithy.api#documentation": "The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP)\n user identities to Active Directory for WorkSpaces login.
" } + }, + "WorkspaceDirectoryName": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryName", + "traits": { + "smithy.api#documentation": "The name fo the WorkSpace directory.
" + } + }, + "WorkspaceDirectoryDescription": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryDescription", + "traits": { + "smithy.api#documentation": "The description of the WorkSpace directory
" + } + }, + "UserIdentityType": { + "target": "com.amazonaws.workspaces#UserIdentityType", + "traits": { + "smithy.api#documentation": "Indicates the identity type of the specifired user.
" + } + }, + "WorkspaceType": { + "target": "com.amazonaws.workspaces#WorkspaceType", + "traits": { + "smithy.api#documentation": "Indicates whether the directory's WorkSpace type is personal or pools.
" + } + }, + "ActiveDirectoryConfig": { + "target": "com.amazonaws.workspaces#ActiveDirectoryConfig", + "traits": { + "smithy.api#documentation": "Information about the Active Directory config.
" + } + }, + "StreamingProperties": { + "target": "com.amazonaws.workspaces#StreamingProperties", + "traits": { + "smithy.api#documentation": "The streaming properties to configure.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.workspaces#Description", + "traits": { + "smithy.api#documentation": "The error message returned.
" + } } }, "traits": { "smithy.api#documentation": "Describes a directory that is used with Amazon WorkSpaces.
" } }, + "com.amazonaws.workspaces#WorkspaceDirectoryDescription": { + "type": "string", + "traits": { + "smithy.api#pattern": "^([a-zA-Z0-9_])[\\\\a-zA-Z0-9_@#%*+=:?./!\\s-]{1,255}$" + } + }, + "com.amazonaws.workspaces#WorkspaceDirectoryName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.\\s-]{1,64}$" + } + }, + "com.amazonaws.workspaces#WorkspaceDirectoryNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspaceDirectoryName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, "com.amazonaws.workspaces#WorkspaceDirectoryState": { "type": "enum", "members": { @@ -8971,6 +10368,12 @@ "traits": { "smithy.api#enumValue": "AD_CONNECTOR" } + }, + "CUSTOMER_MANAGED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_MANAGED" + } } } }, @@ -9672,6 +11075,23 @@ } } }, + "com.amazonaws.workspaces#WorkspaceType": { + "type": "enum", + "members": { + "PERSONAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERSONAL" + } + }, + "POOLS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POOLS" + } + } + } + }, "com.amazonaws.workspaces#WorkspacesDefaultRoleNotFoundException": { "type": "structure", "members": { @@ -9722,48 +11142,564 @@ "target": "com.amazonaws.workspaces#WorkspacesIpGroup" } }, - "com.amazonaws.workspaces#WorkspacesService": { - "type": "service", - "version": "2015-04-08", - "operations": [ - { - "target": "com.amazonaws.workspaces#AcceptAccountLinkInvitation" + "com.amazonaws.workspaces#WorkspacesPool": { + "type": "structure", + "members": { + "PoolId": { + "target": "com.amazonaws.workspaces#WorkspacesPoolId", + "traits": { + "smithy.api#documentation": "The identifier of a WorkSpaces pool.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workspaces#AssociateConnectionAlias" + "PoolArn": { + "target": "com.amazonaws.workspaces#ARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the WorkSpaces pool.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workspaces#AssociateIpGroups" + "CapacityStatus": { + "target": "com.amazonaws.workspaces#CapacityStatus", + "traits": { + "smithy.api#documentation": "The capacity status for the pool
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workspaces#AssociateWorkspaceApplication" + "PoolName": { + "target": "com.amazonaws.workspaces#WorkspacesPoolName", + "traits": { + "smithy.api#documentation": "The name of the pool,
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workspaces#AuthorizeIpRules" + "Description": { + "target": "com.amazonaws.workspaces#UpdateDescription", + "traits": { + "smithy.api#documentation": "The description of the pool.
" + } }, - { - "target": "com.amazonaws.workspaces#CopyWorkspaceImage" + "State": { + "target": "com.amazonaws.workspaces#WorkspacesPoolState", + "traits": { + "smithy.api#documentation": "The current state of the pool.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workspaces#CreateAccountLinkInvitation" + "CreatedAt": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time the pool was created.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workspaces#CreateConnectClientAddIn" + "BundleId": { + "target": "com.amazonaws.workspaces#BundleId", + "traits": { + "smithy.api#documentation": "The identifier of the bundle used by the pool.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workspaces#CreateConnectionAlias" + "DirectoryId": { + "target": "com.amazonaws.workspaces#DirectoryId", + "traits": { + "smithy.api#documentation": "The identifier of the directory used by the pool.
", + "smithy.api#required": {} + } }, - { - "target": "com.amazonaws.workspaces#CreateIpGroup" + "Errors": { + "target": "com.amazonaws.workspaces#WorkspacesPoolErrors", + "traits": { + "smithy.api#documentation": "The pool errors.
" + } }, - { - "target": "com.amazonaws.workspaces#CreateStandbyWorkspaces" + "ApplicationSettings": { + "target": "com.amazonaws.workspaces#ApplicationSettingsResponse", + "traits": { + "smithy.api#documentation": "The persistent application settings for users of the pool.
" + } }, - { - "target": "com.amazonaws.workspaces#CreateTags" + "TimeoutSettings": { + "target": "com.amazonaws.workspaces#TimeoutSettings", + "traits": { + "smithy.api#documentation": "The amount of time that a pool session remains active after users disconnect. \n If they try to reconnect to the pool session after a disconnection or network interruption \n within this time interval, they are connected to their previous session. \n Otherwise, they are connected to a new session with a new pool instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a WorkSpaces pool.
" + } + }, + "com.amazonaws.workspaces#WorkspacesPoolError": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.workspaces#WorkspacesPoolErrorCode", + "traits": { + "smithy.api#documentation": "The error code.
" + } }, - { - "target": "com.amazonaws.workspaces#CreateUpdatedWorkspaceImage" + "ErrorMessage": { + "target": "com.amazonaws.workspaces#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a WorkSpaces pool error.
" + } + }, + "com.amazonaws.workspaces#WorkspacesPoolErrorCode": { + "type": "enum", + "members": { + "IAM_SERVICE_ROLE_IS_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_IS_MISSING" + } + }, + "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION" + } + }, + "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION" + } + }, + "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION" + } + }, + "NETWORK_INTERFACE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NETWORK_INTERFACE_LIMIT_EXCEEDED" + } + }, + "INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + } + }, + "MACHINE_ROLE_IS_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MACHINE_ROLE_IS_MISSING" + } + }, + "STS_DISABLED_IN_REGION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STS_DISABLED_IN_REGION" + } + }, + "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES" + } + }, + "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION" + } + }, + "SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_NOT_FOUND" + } + }, + "IMAGE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE_NOT_FOUND" + } + }, + "INVALID_SUBNET_CONFIGURATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_SUBNET_CONFIGURATION" + } + }, + "SECURITY_GROUPS_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECURITY_GROUPS_NOT_FOUND" + } + }, + "IGW_NOT_ATTACHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IGW_NOT_ATTACHED" + } + }, + "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION" + } + }, + "WORKSPACES_POOL_STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKSPACES_POOL_STOPPED" + } + }, + "WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WORKSPACES_POOL_INSTANCE_PROVISIONING_FAILURE" + } + }, + "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_FILE_NOT_FOUND" + } + }, + "DOMAIN_JOIN_ERROR_ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_ACCESS_DENIED" + } + }, + "DOMAIN_JOIN_ERROR_LOGON_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_LOGON_FAILURE" + } + }, + "DOMAIN_JOIN_ERROR_INVALID_PARAMETER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_INVALID_PARAMETER" + } + }, + "DOMAIN_JOIN_ERROR_MORE_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_MORE_DATA" + } + }, + "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN" + } + }, + "DOMAIN_JOIN_ERROR_NOT_SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_NOT_SUPPORTED" + } + }, + "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME" + } + }, + "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED" + } + }, + "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED" + } + }, + "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_NERR_PASSWORD_EXPIRED" + } + }, + "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_INTERNAL_SERVICE_ERROR" + } + }, + "DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_SECRET_ACTION_PERMISSION_IS_MISSING" + } + }, + "DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_SECRET_DECRYPTION_FAILURE" + } + }, + "DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_SECRET_STATE_INVALID" + } + }, + "DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_SECRET_NOT_FOUND" + } + }, + "DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_SECRET_VALUE_KEY_NOT_FOUND" + } + }, + "DOMAIN_JOIN_ERROR_SECRET_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOMAIN_JOIN_ERROR_SECRET_INVALID" + } + }, + "BUNDLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BUNDLE_NOT_FOUND" + } + }, + "DIRECTORY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECTORY_NOT_FOUND" + } + }, + "INSUFFICIENT_PERMISSIONS_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSUFFICIENT_PERMISSIONS_ERROR" + } + }, + "DEFAULT_OU_IS_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT_OU_IS_MISSING" + } + } + } + }, + "com.amazonaws.workspaces#WorkspacesPoolErrors": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspacesPoolError" + } + }, + "com.amazonaws.workspaces#WorkspacesPoolId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^wspool-[0-9a-z]{9}$" + } + }, + "com.amazonaws.workspaces#WorkspacesPoolIds": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspacesPoolId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25 + } + } + }, + "com.amazonaws.workspaces#WorkspacesPoolName": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,63}$" + } + }, + "com.amazonaws.workspaces#WorkspacesPoolSession": { + "type": "structure", + "members": { + "AuthenticationType": { + "target": "com.amazonaws.workspaces#AuthenticationType", + "traits": { + "smithy.api#documentation": "The authentication method. The user is authenticated using a WorkSpaces \n pool URL (API) or SAML 2.0 federation (SAML).
" + } + }, + "ConnectionState": { + "target": "com.amazonaws.workspaces#SessionConnectionState", + "traits": { + "smithy.api#documentation": "Specifies whether a user is connected to the pool session.
" + } + }, + "SessionId": { + "target": "com.amazonaws.workspaces#AmazonUuid", + "traits": { + "smithy.api#documentation": "The identifier of the session.
", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.workspaces#SessionInstanceId", + "traits": { + "smithy.api#documentation": "The identifier for the instance hosting the session.
" + } + }, + "PoolId": { + "target": "com.amazonaws.workspaces#WorkspacesPoolId", + "traits": { + "smithy.api#documentation": "The identifier of the pool.
", + "smithy.api#required": {} + } + }, + "ExpirationTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the pool session ended.
" + } + }, + "NetworkAccessConfiguration": { + "target": "com.amazonaws.workspaces#NetworkAccessConfiguration", + "traits": { + "smithy.api#documentation": "Describes the network details of the pool.
" + } + }, + "StartTime": { + "target": "com.amazonaws.workspaces#Timestamp", + "traits": { + "smithy.api#documentation": "The time that the pool sission started.
" + } + }, + "UserId": { + "target": "com.amazonaws.workspaces#WorkspacesPoolUserId", + "traits": { + "smithy.api#documentation": "The identifier of the user.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a WorkSpaces pool session.
" + } + }, + "com.amazonaws.workspaces#WorkspacesPoolSessions": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspacesPoolSession" + } + }, + "com.amazonaws.workspaces#WorkspacesPoolState": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "STARTING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTING" + } + }, + "STOPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPED" + } + }, + "STOPPING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STOPPING" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + } + } + }, + "com.amazonaws.workspaces#WorkspacesPoolUserId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 128 + } + } + }, + "com.amazonaws.workspaces#WorkspacesPools": { + "type": "list", + "member": { + "target": "com.amazonaws.workspaces#WorkspacesPool" + } + }, + "com.amazonaws.workspaces#WorkspacesService": { + "type": "service", + "version": "2015-04-08", + "operations": [ + { + "target": "com.amazonaws.workspaces#AcceptAccountLinkInvitation" + }, + { + "target": "com.amazonaws.workspaces#AssociateConnectionAlias" + }, + { + "target": "com.amazonaws.workspaces#AssociateIpGroups" + }, + { + "target": "com.amazonaws.workspaces#AssociateWorkspaceApplication" + }, + { + "target": "com.amazonaws.workspaces#AuthorizeIpRules" + }, + { + "target": "com.amazonaws.workspaces#CopyWorkspaceImage" + }, + { + "target": "com.amazonaws.workspaces#CreateAccountLinkInvitation" + }, + { + "target": "com.amazonaws.workspaces#CreateConnectClientAddIn" + }, + { + "target": "com.amazonaws.workspaces#CreateConnectionAlias" + }, + { + "target": "com.amazonaws.workspaces#CreateIpGroup" + }, + { + "target": "com.amazonaws.workspaces#CreateStandbyWorkspaces" + }, + { + "target": "com.amazonaws.workspaces#CreateTags" + }, + { + "target": "com.amazonaws.workspaces#CreateUpdatedWorkspaceImage" }, { "target": "com.amazonaws.workspaces#CreateWorkspaceBundle" @@ -9774,6 +11710,9 @@ { "target": "com.amazonaws.workspaces#CreateWorkspaces" }, + { + "target": "com.amazonaws.workspaces#CreateWorkspacesPool" + }, { "target": "com.amazonaws.workspaces#DeleteAccountLinkInvitation" }, @@ -9867,6 +11806,12 @@ { "target": "com.amazonaws.workspaces#DescribeWorkspaceSnapshots" }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPools" + }, + { + "target": "com.amazonaws.workspaces#DescribeWorkspacesPoolSessions" + }, { "target": "com.amazonaws.workspaces#DisassociateConnectionAlias" }, @@ -9909,6 +11854,9 @@ { "target": "com.amazonaws.workspaces#ModifySelfservicePermissions" }, + { + "target": "com.amazonaws.workspaces#ModifyStreamingProperties" + }, { "target": "com.amazonaws.workspaces#ModifyWorkspaceAccessProperties" }, @@ -9942,12 +11890,24 @@ { "target": "com.amazonaws.workspaces#StartWorkspaces" }, + { + "target": "com.amazonaws.workspaces#StartWorkspacesPool" + }, { "target": "com.amazonaws.workspaces#StopWorkspaces" }, + { + "target": "com.amazonaws.workspaces#StopWorkspacesPool" + }, { "target": "com.amazonaws.workspaces#TerminateWorkspaces" }, + { + "target": "com.amazonaws.workspaces#TerminateWorkspacesPool" + }, + { + "target": "com.amazonaws.workspaces#TerminateWorkspacesPoolSession" + }, { "target": "com.amazonaws.workspaces#UpdateConnectClientAddIn" }, @@ -9962,6 +11922,9 @@ }, { "target": "com.amazonaws.workspaces#UpdateWorkspaceImagePermission" + }, + { + "target": "com.amazonaws.workspaces#UpdateWorkspacesPool" } ], "traits": {