From 41717ba2c04d3fd03f94d09ea984a10899574935 Mon Sep 17 00:00:00 2001 From: aws-sdk-go-automation <43143561+aws-sdk-go-automation@users.noreply.github.com> Date: Fri, 10 Feb 2023 11:24:20 -0800 Subject: [PATCH] Release v1.44.199 (2023-02-10) (#4721) Release v1.44.199 (2023-02-10) === ### Service Client Updates * `service/autoscaling`: Updates service API and documentation * You can now either terminate/replace, ignore, or wait for EC2 Auto Scaling instances on standby or protected from scale in. Also, you can also roll back changes from a failed instance refresh. * `service/connect`: Updates service API and documentation * `service/ec2`: Updates service API, documentation, and waiters * Adds support for waiters that automatically poll for an imported snapshot until it reaches the completed state. * `service/polly`: Updates service API * Amazon Polly adds two new neural Japanese voices - Kazuha, Tomoko * `service/sagemaker`: Updates service API and documentation * Amazon SageMaker Autopilot adds support for selecting algorithms in CreateAutoMLJob API. * `service/sns`: Updates service documentation * This release adds support for SNS X-Ray active tracing as well as other updates. --- CHANGELOG.md | 16 + aws/endpoints/defaults.go | 72 +- aws/version.go | 2 +- models/apis/autoscaling/2011-01-01/api-2.json | 82 +- .../apis/autoscaling/2011-01-01/docs-2.json | 110 +- .../2011-01-01/endpoint-rule-set-1.json | 412 +++-- .../2011-01-01/endpoint-tests-1.json | 1583 ++-------------- models/apis/connect/2017-08-08/api-2.json | 9 +- models/apis/connect/2017-08-08/docs-2.json | 13 +- .../2017-08-08/endpoint-rule-set-1.json | 398 ++-- .../connect/2017-08-08/endpoint-tests-1.json | 127 +- models/apis/ec2/2016-11-15/api-2.json | 11 +- models/apis/ec2/2016-11-15/docs-2.json | 218 +-- .../ec2/2016-11-15/endpoint-rule-set-1.json | 474 ++--- .../apis/ec2/2016-11-15/endpoint-tests-1.json | 215 ++- models/apis/ec2/2016-11-15/waiters-2.json | 19 + models/apis/polly/2016-06-10/api-2.json | 4 +- .../polly/2016-06-10/endpoint-rule-set-1.json | 392 ++-- .../polly/2016-06-10/endpoint-tests-1.json | 909 ++------- models/apis/sagemaker/2017-07-24/api-2.json | 38 +- models/apis/sagemaker/2017-07-24/docs-2.json | 79 +- .../2017-07-24/endpoint-rule-set-1.json | 432 ++--- .../2017-07-24/endpoint-tests-1.json | 193 +- models/apis/sns/2010-03-31/docs-2.json | 6 +- .../sns/2010-03-31/endpoint-rule-set-1.json | 442 +++-- .../apis/sns/2010-03-31/endpoint-tests-1.json | 1617 ++--------------- models/endpoints/endpoints.json | 50 +- service/autoscaling/api.go | 662 +++++-- .../autoscaling/autoscalingiface/interface.go | 4 + service/autoscaling/errors.go | 17 +- service/connect/api.go | 48 +- service/ec2/api.go | 541 +++--- service/ec2/ec2iface/interface.go | 3 + service/ec2/waiters.go | 51 + service/polly/api.go | 8 + service/sagemaker/api.go | 255 ++- service/sns/api.go | 36 +- 37 files changed, 3974 insertions(+), 5574 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 96890cb9692..61db655a384 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,19 @@ +Release v1.44.199 (2023-02-10) +=== + +### Service Client Updates +* `service/autoscaling`: Updates service API and documentation + * You can now either terminate/replace, ignore, or wait for EC2 Auto Scaling instances on standby or protected from scale in. Also, you can also roll back changes from a failed instance refresh. +* `service/connect`: Updates service API and documentation +* `service/ec2`: Updates service API, documentation, and waiters + * Adds support for waiters that automatically poll for an imported snapshot until it reaches the completed state. +* `service/polly`: Updates service API + * Amazon Polly adds two new neural Japanese voices - Kazuha, Tomoko +* `service/sagemaker`: Updates service API and documentation + * Amazon SageMaker Autopilot adds support for selecting algorithms in CreateAutoMLJob API. +* `service/sns`: Updates service documentation + * This release adds support for SNS X-Ray active tracing as well as other updates. + Release v1.44.198 (2023-02-09) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index bdf7ae528a1..bbdac18ebb9 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -2605,6 +2605,9 @@ var awsPartition = partition{ endpointKey{ Region: "ap-southeast-2", }: endpoint{}, + endpointKey{ + Region: "ap-southeast-3", + }: endpoint{}, endpointKey{ Region: "ca-central-1", }: endpoint{}, @@ -30306,6 +30309,21 @@ var awscnPartition = partition{ }, }, }, + "servicequotas": service{ + Defaults: endpointDefaults{ + defaultKey{}: endpoint{ + Protocols: []string{"https"}, + }, + }, + Endpoints: serviceEndpoints{ + endpointKey{ + Region: "cn-north-1", + }: endpoint{}, + endpointKey{ + Region: "cn-northwest-1", + }: endpoint{}, + }, + }, "sms": service{ Endpoints: serviceEndpoints{ endpointKey{ @@ -32916,21 +32934,43 @@ var awsusgovPartition = partition{ "glacier": service{ Endpoints: serviceEndpoints{ endpointKey{ - Region: "us-gov-east-1", + Region: "fips-us-gov-east-1", }: endpoint{ Hostname: "glacier.us-gov-east-1.amazonaws.com", CredentialScope: credentialScope{ Region: "us-gov-east-1", }, + Deprecated: boxedTrue, }, endpointKey{ - Region: "us-gov-west-1", + Region: "fips-us-gov-west-1", }: endpoint{ - Hostname: "glacier.us-gov-west-1.amazonaws.com", - Protocols: []string{"http", "https"}, + Hostname: "glacier.us-gov-west-1.amazonaws.com", CredentialScope: credentialScope{ Region: "us-gov-west-1", }, + Deprecated: boxedTrue, + }, + endpointKey{ + Region: "us-gov-east-1", + }: endpoint{}, + endpointKey{ + Region: "us-gov-east-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "glacier.us-gov-east-1.amazonaws.com", + }, + endpointKey{ + Region: "us-gov-west-1", + }: endpoint{ + Protocols: []string{"http", "https"}, + }, + endpointKey{ + Region: "us-gov-west-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "glacier.us-gov-west-1.amazonaws.com", + Protocols: []string{"http", "https"}, }, }, }, @@ -34151,20 +34191,40 @@ var awsusgovPartition = partition{ "outposts": service{ Endpoints: serviceEndpoints{ endpointKey{ - Region: "us-gov-east-1", + Region: "fips-us-gov-east-1", }: endpoint{ Hostname: "outposts.us-gov-east-1.amazonaws.com", CredentialScope: credentialScope{ Region: "us-gov-east-1", }, + Deprecated: boxedTrue, }, endpointKey{ - Region: "us-gov-west-1", + Region: "fips-us-gov-west-1", }: endpoint{ Hostname: "outposts.us-gov-west-1.amazonaws.com", CredentialScope: credentialScope{ Region: "us-gov-west-1", }, + Deprecated: boxedTrue, + }, + endpointKey{ + Region: "us-gov-east-1", + }: endpoint{}, + endpointKey{ + Region: "us-gov-east-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "outposts.us-gov-east-1.amazonaws.com", + }, + endpointKey{ + Region: "us-gov-west-1", + }: endpoint{}, + endpointKey{ + Region: "us-gov-west-1", + Variant: fipsVariant, + }: endpoint{ + Hostname: "outposts.us-gov-west-1.amazonaws.com", }, }, }, diff --git a/aws/version.go b/aws/version.go index d700e620596..3632d1b24db 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.44.198" +const SDKVersion = "1.44.199" diff --git a/models/apis/autoscaling/2011-01-01/api-2.json b/models/apis/autoscaling/2011-01-01/api-2.json index 4b7660714bb..37c46890098 100644 --- a/models/apis/autoscaling/2011-01-01/api-2.json +++ b/models/apis/autoscaling/2011-01-01/api-2.json @@ -844,6 +844,24 @@ {"shape":"ResourceContentionFault"} ] }, + "RollbackInstanceRefresh":{ + "name":"RollbackInstanceRefresh", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RollbackInstanceRefreshType"}, + "output":{ + "shape":"RollbackInstanceRefreshAnswer", + "resultWrapper":"RollbackInstanceRefreshResult" + }, + "errors":[ + {"shape":"LimitExceededFault"}, + {"shape":"ResourceContentionFault"}, + {"shape":"ActiveInstanceRefreshNotFoundFault"}, + {"shape":"IrreversibleInstanceRefreshFault"} + ] + }, "SetDesiredCapacity":{ "name":"SetDesiredCapacity", "http":{ @@ -1163,6 +1181,7 @@ "TrafficSources":{"shape":"TrafficSources"} } }, + "AutoRollback":{"type":"boolean"}, "AutoScalingGroup":{ "type":"structure", "required":[ @@ -2125,7 +2144,8 @@ "InstancesToUpdate":{"shape":"InstancesToUpdate"}, "ProgressDetails":{"shape":"InstanceRefreshProgressDetails"}, "Preferences":{"shape":"RefreshPreferences"}, - "DesiredConfiguration":{"shape":"DesiredConfiguration"} + "DesiredConfiguration":{"shape":"DesiredConfiguration"}, + "RollbackDetails":{"shape":"RollbackDetails"} } }, "InstanceRefreshIds":{ @@ -2166,7 +2186,10 @@ "Successful", "Failed", "Cancelling", - "Cancelled" + "Cancelled", + "RollbackInProgress", + "RollbackFailed", + "RollbackSuccessful" ] }, "InstanceRefreshWarmPoolProgress":{ @@ -2254,6 +2277,18 @@ }, "exception":true }, + "IrreversibleInstanceRefreshFault":{ + "type":"structure", + "members":{ + "message":{"shape":"XmlStringMaxLen255"} + }, + "error":{ + "code":"IrreversibleInstanceRefresh", + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, "LaunchConfiguration":{ "type":"structure", "required":[ @@ -3005,7 +3040,10 @@ "InstanceWarmup":{"shape":"RefreshInstanceWarmup"}, "CheckpointPercentages":{"shape":"CheckpointPercentages"}, "CheckpointDelay":{"shape":"CheckpointDelay"}, - "SkipMatching":{"shape":"SkipMatching"} + "SkipMatching":{"shape":"SkipMatching"}, + "AutoRollback":{"shape":"AutoRollback"}, + "ScaleInProtectedInstances":{"shape":"ScaleInProtectedInstances"}, + "StandbyInstances":{"shape":"StandbyInstances"} } }, "RefreshStrategy":{ @@ -3044,6 +3082,36 @@ }, "ReturnData":{"type":"boolean"}, "ReuseOnScaleIn":{"type":"boolean"}, + "RollbackDetails":{ + "type":"structure", + "members":{ + "RollbackReason":{"shape":"XmlStringMaxLen1023"}, + "RollbackStartTime":{"shape":"TimestampType"}, + "PercentageCompleteOnRollback":{"shape":"IntPercent"}, + "InstancesToUpdateOnRollback":{"shape":"InstancesToUpdate"}, + "ProgressDetailsOnRollback":{"shape":"InstanceRefreshProgressDetails"} + } + }, + "RollbackInstanceRefreshAnswer":{ + "type":"structure", + "members":{ + "InstanceRefreshId":{"shape":"XmlStringMaxLen255"} + } + }, + "RollbackInstanceRefreshType":{ + "type":"structure", + "members":{ + "AutoScalingGroupName":{"shape":"XmlStringMaxLen255"} + } + }, + "ScaleInProtectedInstances":{ + "type":"string", + "enum":[ + "Refresh", + "Ignore", + "Wait" + ] + }, "ScalingActivityInProgressFault":{ "type":"structure", "members":{ @@ -3223,6 +3291,14 @@ "max":255, "min":1 }, + "StandbyInstances":{ + "type":"string", + "enum":[ + "Terminate", + "Ignore", + "Wait" + ] + }, "StartInstanceRefreshAnswer":{ "type":"structure", "members":{ diff --git a/models/apis/autoscaling/2011-01-01/docs-2.json b/models/apis/autoscaling/2011-01-01/docs-2.json index 2e8b9b18fe0..338f0f8d4f4 100644 --- a/models/apis/autoscaling/2011-01-01/docs-2.json +++ b/models/apis/autoscaling/2011-01-01/docs-2.json @@ -8,7 +8,7 @@ "AttachTrafficSources": "
Reserved for use with Amazon VPC Lattice, which is in preview and subject to change. Do not use this API for production workloads. This API is also subject to change.
Attaches one or more traffic sources to the specified Auto Scaling group.
To describe the traffic sources for an Auto Scaling group, call the DescribeTrafficSources API. To detach a traffic source from the Auto Scaling group, call the DetachTrafficSources API.
This operation is additive and does not detach existing traffic sources from the Auto Scaling group.
", "BatchDeleteScheduledAction": "Deletes one or more scheduled actions for the specified Auto Scaling group.
", "BatchPutScheduledUpdateGroupAction": "Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
", - "CancelInstanceRefresh": "Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
", + "CancelInstanceRefresh": "Cancels an instance refresh or rollback that is in progress. If an instance refresh or rollback is not in progress, an ActiveInstanceRefreshNotFound
error occurs.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
When you cancel an instance refresh, this does not roll back any changes that it made. Use the RollbackInstanceRefresh API to roll back instead.
", "CompleteLifecycleAction": "Completes the lifecycle action for the specified token or instance with the specified result.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
", "CreateAutoScalingGroup": "We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For introductory exercises for creating an Auto Scaling group, see Getting started with Amazon EC2 Auto Scaling and Tutorial: Set up a scaled and load-balanced application in the Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling groups in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (DesiredCapacity
, MaxSize
, and MinSize
). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.
Creates a launch configuration.
If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the DescribeAccountLimits API. For information about updating this limit, see Quotas for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
For more information, see Launch configurations in the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
", "DescribeAutoScalingInstances": "Gets information about the Auto Scaling instances in the account and Region.
", "DescribeAutoScalingNotificationTypes": "Describes the notification types that are supported by Amazon EC2 Auto Scaling.
", - "DescribeInstanceRefreshes": "Gets information about the instance refreshes for the specified Auto Scaling group.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, this operation returns information about the instance refreshes you previously initiated, including their status, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete.
The following are the possible statuses:
Pending
- The request was created, but the operation has not started.
InProgress
- The operation is in progress.
Successful
- The operation completed successfully.
Failed
- The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
Cancelling
- An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
Cancelled
- The operation is cancelled.
Gets information about the instance refreshes for the specified Auto Scaling group.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
To help you determine the status of an instance refresh, Amazon EC2 Auto Scaling returns information about the instance refreshes you previously initiated, including their status, start time, end time, the percentage of the instance refresh that is complete, and the number of instances remaining to update before the instance refresh is complete. If a rollback is initiated while an instance refresh is in progress, Amazon EC2 Auto Scaling also returns information about the rollback of the instance refresh.
", "DescribeLaunchConfigurations": "Gets information about the launch configurations in the account and Region.
", "DescribeLifecycleHookTypes": "Describes the available types of lifecycle hooks.
The following hook types are supported:
autoscaling:EC2_INSTANCE_LAUNCHING
autoscaling:EC2_INSTANCE_TERMINATING
Gets information about the lifecycle hooks for the specified Auto Scaling group.
", @@ -59,10 +59,11 @@ "PutWarmPool": "Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new desired capacity. For more information and example configurations, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
This operation must be called from the Region in which the Auto Scaling group was created. This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a launch template or launch configuration that requests Spot Instances.
You can view the instances in the warm pool using the DescribeWarmPool API call. If you are no longer using a warm pool, you can delete it by calling the DeleteWarmPool API.
", "RecordLifecycleActionHeartbeat": "Records a heartbeat for the lifecycle action associated with the specified token or instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:
(Optional) Create a launch template or launch configuration with a user data script that runs while an instance is in a wait state due to a lifecycle hook.
(Optional) Create a Lambda function and a rule that allows Amazon EventBridge to invoke your Lambda function when an instance is put into a wait state due to a lifecycle hook.
(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to publish lifecycle notifications to the target.
Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.
If you need more time, record the lifecycle action heartbeat to keep the instance in a wait state.
If you finish before the timeout period ends, send a callback by using the CompleteLifecycleAction API call.
For more information, see Amazon EC2 Auto Scaling lifecycle hooks in the Amazon EC2 Auto Scaling User Guide.
", "ResumeProcesses": "Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
", + "RollbackInstanceRefresh": "Cancels an instance refresh that is in progress and rolls back any changes that it made. Amazon EC2 Auto Scaling replaces any instances that were replaced during the instance refresh. This restores your Auto Scaling group to the configuration that it was using before the start of the instance refresh.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group after you make configuration changes.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId
property.
The Auto Scaling group uses the launch template's $Latest
or $Default
version.
When you receive a successful response from this operation, Amazon EC2 Auto Scaling immediately begins replacing instances. You can check the status of this operation through the DescribeInstanceRefreshes API operation.
", "SetDesiredCapacity": "Sets the size of the specified Auto Scaling group.
If a scale-in activity occurs as a result of a new DesiredCapacity
value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.
For more information, see Manual scaling in the Amazon EC2 Auto Scaling User Guide.
", "SetInstanceHealth": "Sets the health status of the specified instance.
For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
", "SetInstanceProtection": "Updates the instance protection settings of the specified instances. This operation cannot be called on instances in a warm pool.
For more information about preventing instances that are part of an Auto Scaling group from terminating on scale in, see Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call fails.
", - "StartInstanceRefresh": "Starts a new instance refresh operation. An instance refresh performs a rolling replacement of all or some instances in an Auto Scaling group. Each instance is terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If the call succeeds, it creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh operation in progress, use the CancelInstanceRefresh API.
", + "StartInstanceRefresh": "Starts an instance refresh. During an instance refresh, Amazon EC2 Auto Scaling performs a rolling update of instances in an Auto Scaling group. Instances are terminated first and then replaced, which temporarily reduces the capacity available within your Auto Scaling group.
This operation is part of the instance refresh feature in Amazon EC2 Auto Scaling, which helps you update instances in your Auto Scaling group. This feature is helpful, for example, when you have a new AMI or a new user data script. You just need to create a new launch template that specifies the new AMI or user data script. Then start an instance refresh to immediately begin the process of updating instances in the group.
If successful, the request's response contains a unique ID that you can use to track the progress of the instance refresh. To query its status, call the DescribeInstanceRefreshes API. To describe the instance refreshes that have already run, call the DescribeInstanceRefreshes API. To cancel an instance refresh that is in progress, use the CancelInstanceRefresh API.
An instance refresh might fail for several reasons, such as EC2 launch failures, misconfigured health checks, or not ignoring or allowing the termination of instances that are in Standby
state or protected from scale in. You can monitor for failed EC2 launches using the scaling activities. To find the scaling activities, call the DescribeScalingActivities API.
If you enable auto rollback, your Auto Scaling group will be rolled back automatically when the instance refresh fails. You can enable this feature before starting an instance refresh by specifying the AutoRollback
property in the instance refresh preferences. Otherwise, to roll back an instance refresh before it finishes, use the RollbackInstanceRefresh API.
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
If you suspend either the Launch
or Terminate
process types, it can prevent other process types from functioning properly. For more information, see Suspending and resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
", "TerminateInstanceInAutoScalingGroup": "Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.
This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated
. You can't connect to or start an instance after you've terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.
By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
", "UpdateAutoScalingGroup": "We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing DesiredCapacity
, MaxSize
, or MinSize
:
If a scale-in activity occurs as a result of a new DesiredCapacity
value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.
If you specify a new value for MinSize
without specifying a value for DesiredCapacity
, and the new MinSize
is larger than the current size of the group, this sets the group's DesiredCapacity
to the new MinSize
value.
If you specify a new value for MaxSize
without specifying a value for DesiredCapacity
, and the new MaxSize
is smaller than the current size of the group, this sets the group's DesiredCapacity
to the new MaxSize
value.
To see which properties have been set, call the DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
" @@ -117,7 +118,7 @@ } }, "ActiveInstanceRefreshNotFoundFault": { - "base": "The request failed because an active instance refresh for the specified Auto Scaling group was not found.
", + "base": "The request failed because an active instance refresh or rollback for the specified Auto Scaling group was not found.
", "refs": { } }, @@ -249,6 +250,12 @@ "refs": { } }, + "AutoRollback": { + "base": null, + "refs": { + "RefreshPreferences$AutoRollback": "(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the instance refresh fails. The default is false
.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the ImageId
property.
The Auto Scaling group uses the launch template's $Latest
or $Default
version.
Describes an Auto Scaling group.
", "refs": { @@ -471,13 +478,13 @@ "CheckpointDelay": { "base": null, "refs": { - "RefreshPreferences$CheckpointDelay": "The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages
. If you specify a value for CheckpointPercentages
and not for CheckpointDelay
, the CheckpointDelay
defaults to 3600
(1 hour).
(Optional) The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages
. If you specify a value for CheckpointPercentages
and not for CheckpointDelay
, the CheckpointDelay
defaults to 3600
(1 hour).
Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100
.
For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.
" + "RefreshPreferences$CheckpointPercentages": "(Optional) Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100
.
For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.
" } }, "ClassicLinkVPCSecurityGroups": { @@ -552,8 +559,8 @@ "base": null, "refs": { "AutoScalingGroup$DefaultInstanceWarmup": "The duration of the default instance warmup, in seconds.
", - "CreateAutoScalingGroupType$DefaultInstanceWarmup": "The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService
state. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage your warm-up settings at the group level, we recommend that you set the default instance warmup, even if its value is set to 0 seconds. This also optimizes the performance of scaling policies that scale continuously, such as target tracking and step scaling policies.
If you need to remove a value that you previously set, include the property but specify -1
for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a minimum value of 0
.
Default: None
", - "UpdateAutoScalingGroupType$DefaultInstanceWarmup": "The amount of time, in seconds, until a newly launched instance can contribute to the Amazon CloudWatch metrics. This delay lets an instance finish initializing before Amazon EC2 Auto Scaling aggregates instance metrics, resulting in more reliable usage data. Set this value equal to the amount of time that it takes for resource consumption to become stable after an instance reaches the InService
state. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage your warm-up settings at the group level, we recommend that you set the default instance warmup, even if its value is set to 0 seconds. This also optimizes the performance of scaling policies that scale continuously, such as target tracking and step scaling policies.
If you need to remove a value that you previously set, include the property but specify -1
for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a minimum value of 0
.
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService
state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1
for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0
or other nominal value.
Default: None
", + "UpdateAutoScalingGroupType$DefaultInstanceWarmup": "The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService
state.
During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1
for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0
or other nominal value.
Describes the desired configuration for an instance refresh.
If you specify a desired configuration, you must specify either a LaunchTemplate
or a MixedInstancesPolicy
.
Describes the specific update you want to deploy.
", - "StartInstanceRefreshType$DesiredConfiguration": "The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.
Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.
When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the SkipMatching
property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and version. This can help you reduce the number of replacements that are required to apply updates.
Describes the desired configuration for the instance refresh.
", + "StartInstanceRefreshType$DesiredConfiguration": "The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.
Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.
When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the SkipMatching
property in preferences. If it's enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and instance types. This can help you reduce the number of replacements that are required to apply updates.
The request failed because an active instance refresh operation already exists for the specified Auto Scaling group.
", + "base": "The request failed because an active instance refresh already exists for the specified Auto Scaling group.
", "refs": { } }, "InstanceRefreshLivePoolProgress": { - "base": "Reports the progress of an instance refresh on instances that are in the Auto Scaling group.
", + "base": "Reports progress on replacing instances that are in the Auto Scaling group.
", "refs": { - "InstanceRefreshProgressDetails$LivePoolProgress": "Indicates the progress of an instance refresh on instances that are in the Auto Scaling group.
" + "InstanceRefreshProgressDetails$LivePoolProgress": "Reports progress on replacing instances that are in the Auto Scaling group.
" } }, "InstanceRefreshProgressDetails": { - "base": "Reports the progress of an instance refresh on an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto Scaling group (the live pool).
", + "base": "Reports progress on replacing instances in an Auto Scaling group that has a warm pool. This includes separate details for instances in the warm pool and instances in the Auto Scaling group (the live pool).
", "refs": { - "InstanceRefresh$ProgressDetails": "Additional progress details for an Auto Scaling group that has a warm pool.
" + "InstanceRefresh$ProgressDetails": "Additional progress details for an Auto Scaling group that has a warm pool.
", + "RollbackDetails$ProgressDetailsOnRollback": null } }, "InstanceRefreshStatus": { "base": null, "refs": { - "InstanceRefresh$Status": "The current status for the instance refresh operation:
Pending
- The request was created, but the operation has not started.
InProgress
- The operation is in progress.
Successful
- The operation completed successfully.
Failed
- The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
Cancelling
- An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
Cancelled
- The operation is cancelled.
The current status for the instance refresh operation:
Pending
- The request was created, but the instance refresh has not started.
InProgress
- An instance refresh is in progress.
Successful
- An instance refresh completed successfully.
Failed
- An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
Cancelling
- An ongoing instance refresh is being cancelled.
Cancelled
- The instance refresh is cancelled.
RollbackInProgress
- An instance refresh is being rolled back.
RollbackFailed
- The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.
RollbackSuccessful
- The rollback completed successfully.
Reports the progress of an instance refresh on instances that are in the warm pool.
", + "base": "Reports progress on replacing instances that are in the warm pool.
", "refs": { - "InstanceRefreshProgressDetails$WarmPoolProgress": "Indicates the progress of an instance refresh on instances that are in the warm pool.
" + "InstanceRefreshProgressDetails$WarmPoolProgress": "Reports progress on replacing instances that are in the warm pool.
" } }, "InstanceRefreshes": { @@ -1083,18 +1091,20 @@ "InstancesToUpdate": { "base": null, "refs": { - "InstanceRefresh$InstancesToUpdate": "The number of instances remaining to update before the instance refresh is complete.
", + "InstanceRefresh$InstancesToUpdate": "The number of instances remaining to update before the instance refresh is complete.
If you roll back the instance refresh, InstancesToUpdate
shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
The number of instances remaining to update.
", - "InstanceRefreshWarmPoolProgress$InstancesToUpdate": "The number of instances remaining to update.
" + "InstanceRefreshWarmPoolProgress$InstancesToUpdate": "The number of instances remaining to update.
", + "RollbackDetails$InstancesToUpdateOnRollback": "Indicates the value of InstancesToUpdate
at the time the rollback started.
The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
", + "InstanceRefresh$PercentageComplete": "The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
PercentageComplete
does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
The percentage of instances in the Auto Scaling group that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
", "InstanceRefreshWarmPoolProgress$PercentageComplete": "The percentage of instances in the warm pool that have been replaced. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
", - "RefreshPreferences$MinHealthyPercentage": "The amount of capacity in the Auto Scaling group that must pass your group's health checks to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90
.
Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.
" + "RefreshPreferences$MinHealthyPercentage": "The amount of capacity in the Auto Scaling group that must pass your group's health checks to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90
.
Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.
", + "RollbackDetails$PercentageCompleteOnRollback": "Indicates the value of PercentageComplete
at the time the rollback started.
The request failed because a desired configuration was not found or an incompatible launch template (uses a Systems Manager parameter instead of an AMI ID) or launch template version ($Latest
or $Default
) is present on the Auto Scaling group.
Describes a launch configuration.
", "refs": { @@ -1863,20 +1878,20 @@ "RefreshInstanceWarmup": { "base": null, "refs": { - "RefreshPreferences$InstanceWarmup": "Not needed if the default instance warmup is defined for the group.
The duration of the instance warmup, in seconds.
The default is to use the value for the default instance warmup defined for the group. If default instance warmup is null, then InstanceWarmup
falls back to the value of the health check grace period.
A time period, in seconds, during which an instance refresh waits before moving on to replacing the next instance after a new instance enters the InService
state.
This property is not required for normal usage. Instead, use the DefaultInstanceWarmup
property of the Auto Scaling group. The InstanceWarmup
and DefaultInstanceWarmup
properties work the same way. Only specify this property if you must override the DefaultInstanceWarmup
property.
If you do not specify this property, the instance warmup by default is the value of the DefaultInstanceWarmup
property, if defined (which is recommended in all cases), or the HealthCheckGracePeriod
property otherwise.
Describes the preferences for an instance refresh.
", "refs": { "InstanceRefresh$Preferences": null, - "StartInstanceRefreshType$Preferences": "Set of preferences associated with the instance refresh request. If not provided, the default values are used.
" + "StartInstanceRefreshType$Preferences": "Sets your preferences for the instance refresh so that it performs as expected when you start it. Includes the instance warmup time, the minimum healthy percentage, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in Standby
state or protected from scale in are found. You can also choose to enable additional features, such as the following:
Auto rollback
Checkpoints
Skip matching
The strategy to use for the instance refresh. The only valid value is Rolling
.
A rolling update helps you update your instances gradually. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that are replaced are not rolled back to their previous configuration.
" + "StartInstanceRefreshType$Strategy": "The strategy to use for the instance refresh. The only valid value is Rolling
.
Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.
" } }, + "RollbackDetails": { + "base": "Details about an instance refresh rollback.
", + "refs": { + "InstanceRefresh$RollbackDetails": "The rollback details.
" + } + }, + "RollbackInstanceRefreshAnswer": { + "base": null, + "refs": { + } + }, + "RollbackInstanceRefreshType": { + "base": null, + "refs": { + } + }, + "ScaleInProtectedInstances": { + "base": null, + "refs": { + "RefreshPreferences$ScaleInProtectedInstances": "Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
The following lists the valid values:
Amazon EC2 Auto Scaling replaces instances that are protected from scale in.
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.
The operation can't be performed because there are scaling activities in progress.
", "refs": { @@ -2042,7 +2079,7 @@ "SkipMatching": { "base": null, "refs": { - "RefreshPreferences$SkipMatching": "A boolean value that indicates whether skip matching is enabled. If true, then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same configuration that is already set on the group. The default is false
.
(Optional) Indicates whether skip matching is enabled. If enabled (true
), then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same launch template and instance types that the Auto Scaling group was using before the start of the instance refresh. The default is false
.
For more information, see Use an instance refresh with skip matching in the Amazon EC2 Auto Scaling User Guide.
" } }, "SpotInstancePools": { @@ -2058,6 +2095,12 @@ "LaunchConfiguration$SpotPrice": "The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see Requesting Spot Instances in the Amazon EC2 Auto Scaling User Guide.
" } }, + "StandbyInstances": { + "base": null, + "refs": { + "RefreshPreferences$StandbyInstances": "Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby
state are found.
The following lists the valid values:
Amazon EC2 Auto Scaling terminates instances that are in Standby
.
Amazon EC2 Auto Scaling ignores instances that are in Standby
and continues to replace instances that are in the InService
state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
This property is no longer used.
", "PutScheduledUpdateGroupActionType$StartTime": "The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, \"2021-06-01T00:00:00Z\"
).
If you specify Recurrence
and StartTime
, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.
The date and time for the recurring schedule to end, in UTC. For example, \"2021-06-01T00:00:00Z\"
.
The date and time at which the rollback began.
", "ScheduledUpdateGroupAction$Time": "This property is no longer used.
", "ScheduledUpdateGroupAction$StartTime": "The date and time in UTC for this action to start. For example, \"2019-06-01T00:00:00Z\"
.
The date and time in UTC for the recurring schedule to end. For example, \"2019-06-01T00:00:00Z\"
.
The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources.
Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice target group. Amazon EC2 Auto Scaling registers the running instances with the attached target groups. The target groups receive incoming traffic and route requests to one or more registered targets.
", - "AutoScalingGroup$TrafficSources": "The unique identifiers of the traffic sources.
", + "AutoScalingGroup$TrafficSources": "Reserved for use with Amazon VPC Lattice, which is in preview release and is subject to change. Do not use this parameter for production workloads. It is also subject to change.
The unique identifiers of the traffic sources.
", "CreateAutoScalingGroupType$TrafficSources": "Reserved for use with Amazon VPC Lattice, which is in preview release and is subject to change. Do not use this parameter for production workloads. It is also subject to change.
The unique identifiers of one or more traffic sources.
Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice target group. Amazon EC2 Auto Scaling registers the running instances with the attached target groups. The target groups receive incoming traffic and route requests to one or more registered targets.
", "DetachTrafficSourcesType$TrafficSources": "The unique identifiers of one or more traffic sources you are detaching. You can specify up to 10 traffic sources.
Currently, you must specify an Amazon Resource Name (ARN) for an existing VPC Lattice target group. When you detach a target group, it enters the Removing
state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the target group using the DescribeTrafficSources API call. The instances continue to run.
The reason the activity began.
", - "InstanceRefresh$StatusReason": "Provides more details about the current status of the instance refresh.
", + "InstanceRefresh$StatusReason": "The explanation for the specific status assigned to this operation.
", "LifecycleHook$NotificationMetadata": "Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the notification target.
", "LifecycleHookSpecification$NotificationMetadata": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
", "MetricDataQuery$Expression": "The math expression to perform on the returned data, if this object is performing a math expression. This expression can use the Id
of the other metrics to refer to those metrics, and can also use the Id
of other expressions to use the result of those expressions.
Conditional: Within each MetricDataQuery
object, you must specify either Expression
or MetricStat
, but not both.
A label that uniquely identifies a specific Application Load Balancer target group from which to determine the request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff
.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
", "PredictiveScalingPredefinedMetricPair$ResourceLabel": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine the total and average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff
.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
", "PredictiveScalingPredefinedScalingMetric$ResourceLabel": "A label that uniquely identifies a specific Application Load Balancer target group from which to determine the average request count served by your Auto Scaling group. You can't specify a resource label unless the target group is attached to the Auto Scaling group.
You create the resource label by appending the final portion of the load balancer ARN and the final portion of the target group ARN into a single value, separated by a forward slash (/). The format of the resource label is:
app/my-alb/778d41231b141a0f/targetgroup/my-alb-target-group/943f017f100becff
.
Where:
app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN
targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.
To find the ARN for an Application Load Balancer, use the DescribeLoadBalancers API operation. To find the ARN for the target group, use the DescribeTargetGroups API operation.
", - "PutLifecycleHookType$NotificationMetadata": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
" + "PutLifecycleHookType$NotificationMetadata": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
", + "RollbackDetails$RollbackReason": "The reason for this instance refresh rollback (for example, whether a manual or automatic rollback was initiated).
" } }, "XmlStringMaxLen1600": { @@ -2415,7 +2460,7 @@ "BatchPutScheduledUpdateGroupActionType$AutoScalingGroupName": "The name of the Auto Scaling group.
", "BlockDeviceMapping$VirtualName": "The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeralX where X is a number starting from zero (0), for example, ephemeral0
.
The device name assigned to the volume (for example, /dev/sdh
or xvdh
). For more information, see Device naming on Linux instances in the Amazon EC2 User Guide for Linux Instances.
To define a block device mapping, set the device name and exactly one of the following properties: Ebs
, NoDevice
, or VirtualName
.
The instance refresh ID.
", + "CancelInstanceRefreshAnswer$InstanceRefreshId": "The instance refresh ID associated with the request. This is the unique ID assigned to the instance refresh when it was started.
", "CancelInstanceRefreshType$AutoScalingGroupName": "The name of the Auto Scaling group.
", "ClassicLinkVPCSecurityGroups$member": null, "CreateAutoScalingGroupType$AutoScalingGroupName": "The name of the Auto Scaling group. This name must be unique per Region per account.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
The name of the launch configuration.
", "LaunchConfiguration$ImageId": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Find a Linux AMI in the Amazon EC2 User Guide for Linux Instances.
", "LaunchConfiguration$KeyName": "The name of the key pair.
For more information, see Amazon EC2 Key Pairs in the Amazon EC2 User Guide for Linux Instances.
", @@ -2514,6 +2560,8 @@ "PutWarmPoolType$AutoScalingGroupName": "The name of the Auto Scaling group.
", "ResourceContentionFault$message": "", "ResourceInUseFault$message": "", + "RollbackInstanceRefreshAnswer$InstanceRefreshId": "The instance refresh ID associated with the request. This is the unique ID assigned to the instance refresh when it was started.
", + "RollbackInstanceRefreshType$AutoScalingGroupName": "The name of the Auto Scaling group.
", "ScalingActivityInProgressFault$message": "", "ScalingPolicy$AutoScalingGroupName": "The name of the Auto Scaling group.
", "ScalingPolicy$PolicyName": "The name of the scaling policy.
", @@ -2530,7 +2578,7 @@ "ServiceLinkedRoleFailure$message": null, "SetDesiredCapacityType$AutoScalingGroupName": "The name of the Auto Scaling group.
", "SetInstanceProtectionQuery$AutoScalingGroupName": "The name of the Auto Scaling group.
", - "StartInstanceRefreshAnswer$InstanceRefreshId": "A unique ID for tracking the progress of the request.
", + "StartInstanceRefreshAnswer$InstanceRefreshId": "A unique ID for tracking the progress of the instance refresh.
", "StartInstanceRefreshType$AutoScalingGroupName": "The name of the Auto Scaling group.
", "SuspendedProcess$ProcessName": "The name of the suspended process.
", "SuspendedProcess$SuspensionReason": "The reason that the process was suspended.
", diff --git a/models/apis/autoscaling/2011-01-01/endpoint-rule-set-1.json b/models/apis/autoscaling/2011-01-01/endpoint-rule-set-1.json index 2b28ede2cc1..ca4fa951141 100644 --- a/models/apis/autoscaling/2011-01-01/endpoint-rule-set-1.json +++ b/models/apis/autoscaling/2011-01-01/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,14 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -62,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -131,199 +111,263 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" + }, + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] }, - "supportsDualStack" + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://autoscaling-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "stringEquals", + "fn": "booleanEquals", "argv": [ - "aws-us-gov", + true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "name" + "supportsFIPS" ] } ] } ], - "endpoint": { - "url": "https://autoscaling.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://autoscaling.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] }, { "conditions": [], - "endpoint": { - "url": "https://autoscaling-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], - "endpoint": { - "url": "https://autoscaling.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://autoscaling.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "endpoint": { - "url": "https://autoscaling.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/autoscaling/2011-01-01/endpoint-tests-1.json b/models/apis/autoscaling/2011-01-01/endpoint-tests-1.json index 233daccc4fb..8c71920721f 100644 --- a/models/apis/autoscaling/2011-01-01/endpoint-tests-1.json +++ b/models/apis/autoscaling/2011-01-01/endpoint-tests-1.json @@ -1,1182 +1,16 @@ { "testCases": [ { - "documentation": "For region ap-south-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-south-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-south-2" - } - }, - { - "documentation": "For region ap-south-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-south-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-south-2" - } - }, - { - "documentation": "For region ap-south-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-south-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-south-2" - } - }, - { - "documentation": "For region ap-south-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-south-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-south-2" - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-south-1" - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-south-1" - } - }, - { - "documentation": "For region eu-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-south-1" - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-south-1" - } - }, - { - "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-south-1" - } - }, - { - "documentation": "For region eu-south-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-south-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-south-2" - } - }, - { - "documentation": "For region eu-south-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-south-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-south-2" - } - }, - { - "documentation": "For region eu-south-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-south-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-south-2" - } - }, - { - "documentation": "For region eu-south-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-south-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-south-2" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-gov-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-gov-east-1" - } - }, - { - "documentation": "For region me-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.me-central-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "me-central-1" - } - }, - { - "documentation": "For region me-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.me-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "me-central-1" - } - }, - { - "documentation": "For region me-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.me-central-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "me-central-1" - } - }, - { - "documentation": "For region me-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.me-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "me-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ca-central-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ca-central-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ca-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ca-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-central-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-central-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-central-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-central-1" - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-west-1" - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-iso-west-1" - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-west-1" - } - }, - { - "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-iso-west-1.c2s.ic.gov" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-iso-west-1" - } - }, - { - "documentation": "For region eu-central-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-central-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region eu-central-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-central-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region eu-central-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-central-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region eu-central-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-central-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-central-2" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.us-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.us-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-1" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-west-2" - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.us-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "us-west-2" - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.af-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.af-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.af-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "af-south-1" - } - }, - { - "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.af-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "af-south-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-north-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-north-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-north-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-north-1" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-west-3.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-west-3.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-west-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-3" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-west-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-west-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-2" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-west-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.eu-west-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "eu-west-1" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-northeast-3.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-northeast-3.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-northeast-3.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-3" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-northeast-2.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-2" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-northeast-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "ap-northeast-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.me-south-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.me-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.me-south-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "me-south-1" - } - }, - { - "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.me-south-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "me-south-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.sa-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.sa-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.sa-east-1.amazonaws.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Region": "sa-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.ap-east-1.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region af-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.ap-east-1.amazonaws.com" + "url": "https://autoscaling.af-south-1.amazonaws.com" } }, "params": { - "UseFIPS": true, + "Region": "af-south-1", "UseDualStack": false, - "Region": "ap-east-1" - } - }, - { - "documentation": "For region ap-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-east-1.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-east-1" + "UseFIPS": false } }, { @@ -1187,536 +21,490 @@ } }, "params": { - "UseFIPS": false, + "Region": "ap-east-1", "UseDualStack": false, - "Region": "ap-east-1" + "UseFIPS": false } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://autoscaling.ap-northeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "cn-north-1" + "Region": "ap-northeast-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.cn-north-1.amazonaws.com.cn" + "url": "https://autoscaling.ap-northeast-2.amazonaws.com" } }, "params": { - "UseFIPS": true, + "Region": "ap-northeast-2", "UseDualStack": false, - "Region": "cn-north-1" + "UseFIPS": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-northeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.cn-north-1.api.amazonwebservices.com.cn" + "url": "https://autoscaling.ap-northeast-3.amazonaws.com" } }, "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-north-1" + "Region": "ap-northeast-3", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.cn-north-1.amazonaws.com.cn" + "url": "https://autoscaling.ap-south-1.amazonaws.com" } }, "params": { - "UseFIPS": false, + "Region": "ap-south-1", "UseDualStack": false, - "Region": "cn-north-1" + "UseFIPS": false } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.us-gov-west-1.api.aws" + "url": "https://autoscaling.ap-southeast-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-gov-west-1" + "Region": "ap-southeast-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.us-gov-west-1.amazonaws.com" + "url": "https://autoscaling.ap-southeast-2.amazonaws.com" } }, "params": { - "UseFIPS": true, + "Region": "ap-southeast-2", "UseDualStack": false, - "Region": "us-gov-west-1" + "UseFIPS": false } }, { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", + "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.us-gov-west-1.api.aws" + "url": "https://autoscaling.ap-southeast-3.amazonaws.com" } }, "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-gov-west-1" + "Region": "ap-southeast-3", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.us-gov-west-1.amazonaws.com" + "url": "https://autoscaling.ca-central-1.amazonaws.com" } }, "params": { - "UseFIPS": false, + "Region": "ca-central-1", "UseDualStack": false, - "Region": "us-gov-west-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.ap-southeast-1.api.aws" + "url": "https://autoscaling.eu-central-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-1" + "Region": "eu-central-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-1 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.ap-southeast-1.amazonaws.com" + "url": "https://autoscaling.eu-north-1.amazonaws.com" } }, "params": { - "UseFIPS": true, + "Region": "eu-north-1", "UseDualStack": false, - "Region": "ap-southeast-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack enabled", + "documentation": "For region eu-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.ap-southeast-1.api.aws" + "url": "https://autoscaling.eu-south-1.amazonaws.com" } }, "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-1" + "Region": "eu-south-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.ap-southeast-1.amazonaws.com" + "url": "https://autoscaling.eu-west-1.amazonaws.com" } }, "params": { - "UseFIPS": false, + "Region": "eu-west-1", "UseDualStack": false, - "Region": "ap-southeast-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack enabled", + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.ap-southeast-2.api.aws" + "url": "https://autoscaling.eu-west-2.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-2" + "Region": "eu-west-2", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-2 with FIPS enabled and DualStack disabled", + "documentation": "For region eu-west-3 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.ap-southeast-2.amazonaws.com" + "url": "https://autoscaling.eu-west-3.amazonaws.com" } }, "params": { - "UseFIPS": true, + "Region": "eu-west-3", "UseDualStack": false, - "Region": "ap-southeast-2" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack enabled", + "documentation": "For region me-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.ap-southeast-2.api.aws" + "url": "https://autoscaling.me-south-1.amazonaws.com" } }, "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-2" + "Region": "me-south-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.ap-southeast-2.amazonaws.com" + "url": "https://autoscaling.sa-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, + "Region": "sa-east-1", "UseDualStack": false, - "Region": "ap-southeast-2" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-iso-east-1" + "UseFIPS": false } }, { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.us-iso-east-1.c2s.ic.gov" + "url": "https://autoscaling.us-east-1.amazonaws.com" } }, "params": { - "UseFIPS": true, + "Region": "us-east-1", "UseDualStack": false, - "Region": "us-iso-east-1" - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-iso-east-1" + "UseFIPS": false } }, { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.us-iso-east-1.c2s.ic.gov" + "url": "https://autoscaling.us-east-2.amazonaws.com" } }, "params": { - "UseFIPS": false, + "Region": "us-east-2", "UseDualStack": false, - "Region": "us-iso-east-1" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack enabled", + "documentation": "For region us-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.ap-southeast-3.api.aws" + "url": "https://autoscaling.us-west-1.amazonaws.com" } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "ap-southeast-3" + "Region": "us-west-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-3 with FIPS enabled and DualStack disabled", + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.ap-southeast-3.amazonaws.com" + "url": "https://autoscaling.us-west-2.amazonaws.com" } }, "params": { - "UseFIPS": true, + "Region": "us-west-2", "UseDualStack": false, - "Region": "ap-southeast-3" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://autoscaling.ap-southeast-3.api.aws" + "url": "https://autoscaling-fips.us-east-1.api.aws" } }, "params": { - "UseFIPS": false, + "Region": "us-east-1", "UseDualStack": true, - "Region": "ap-southeast-3" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-3 with FIPS disabled and DualStack disabled", + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.ap-southeast-3.amazonaws.com" + "url": "https://autoscaling-fips.us-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, + "Region": "us-east-1", "UseDualStack": false, - "Region": "ap-southeast-3" + "UseFIPS": true } }, { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack enabled", + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.ap-southeast-4.api.aws" + "url": "https://autoscaling.us-east-1.api.aws" } }, "params": { - "UseFIPS": true, + "Region": "us-east-1", "UseDualStack": true, - "Region": "ap-southeast-4" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-4 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.ap-southeast-4.amazonaws.com" + "url": "https://autoscaling.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": true, + "Region": "cn-north-1", "UseDualStack": false, - "Region": "ap-southeast-4" - } - }, - { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling.ap-southeast-4.api.aws" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "ap-southeast-4" + "UseFIPS": false } }, { - "documentation": "For region ap-southeast-4 with FIPS disabled and DualStack disabled", + "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.ap-southeast-4.amazonaws.com" + "url": "https://autoscaling.cn-northwest-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": false, + "Region": "cn-northwest-1", "UseDualStack": false, - "Region": "ap-southeast-4" + "UseFIPS": false } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.us-east-1.api.aws" + "url": "https://autoscaling-fips.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseFIPS": true, + "Region": "cn-north-1", "UseDualStack": true, - "Region": "us-east-1" + "UseFIPS": true } }, { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.us-east-1.amazonaws.com" + "url": "https://autoscaling-fips.cn-north-1.amazonaws.com.cn" } }, "params": { - "UseFIPS": true, + "Region": "cn-north-1", "UseDualStack": false, - "Region": "us-east-1" + "UseFIPS": true } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://autoscaling.us-east-1.api.aws" + "url": "https://autoscaling.cn-north-1.api.amazonwebservices.com.cn" } }, "params": { - "UseFIPS": false, + "Region": "cn-north-1", "UseDualStack": true, - "Region": "us-east-1" + "UseFIPS": false } }, { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.us-east-1.amazonaws.com" + "url": "https://autoscaling.us-gov-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, + "Region": "us-gov-east-1", "UseDualStack": false, - "Region": "us-east-1" - } - }, - { - "documentation": "For region us-east-2 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://autoscaling-fips.us-east-2.api.aws" - } - }, - "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-east-2" + "UseFIPS": false } }, { - "documentation": "For region us-east-2 with FIPS enabled and DualStack disabled", + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.us-east-2.amazonaws.com" + "url": "https://autoscaling.us-gov-west-1.amazonaws.com" } }, "params": { - "UseFIPS": true, + "Region": "us-gov-west-1", "UseDualStack": false, - "Region": "us-east-2" + "UseFIPS": false } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://autoscaling.us-east-2.api.aws" + "url": "https://autoscaling-fips.us-gov-east-1.api.aws" } }, "params": { - "UseFIPS": false, + "Region": "us-gov-east-1", "UseDualStack": true, - "Region": "us-east-2" + "UseFIPS": true } }, { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.us-east-2.amazonaws.com" + "url": "https://autoscaling.us-gov-east-1.amazonaws.com" } }, "params": { - "UseFIPS": false, + "Region": "us-gov-east-1", "UseDualStack": false, - "Region": "us-east-2" + "UseFIPS": true } }, { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.cn-northwest-1.api.amazonwebservices.com.cn" + "url": "https://autoscaling.us-gov-east-1.api.aws" } }, "params": { - "UseFIPS": true, + "Region": "us-gov-east-1", "UseDualStack": true, - "Region": "cn-northwest-1" + "UseFIPS": false } }, { - "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling-fips.cn-northwest-1.amazonaws.com.cn" + "url": "https://autoscaling.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseFIPS": true, + "Region": "us-iso-east-1", "UseDualStack": false, - "Region": "cn-northwest-1" + "UseFIPS": false } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", + "documentation": "For region us-iso-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.cn-northwest-1.api.amazonwebservices.com.cn" + "url": "https://autoscaling.us-iso-west-1.c2s.ic.gov" } }, "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "cn-northwest-1" + "Region": "us-iso-west-1", + "UseDualStack": false, + "UseFIPS": false } }, { - "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.cn-northwest-1.amazonaws.com.cn" + "url": "https://autoscaling-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { - "UseFIPS": false, + "Region": "us-iso-east-1", "UseDualStack": false, - "Region": "cn-northwest-1" + "UseFIPS": true } }, { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + "endpoint": { + "url": "https://autoscaling.us-isob-east-1.sc2s.sgov.gov" + } }, "params": { - "UseFIPS": true, - "UseDualStack": true, - "Region": "us-isob-east-1" + "Region": "us-isob-east-1", + "UseDualStack": false, + "UseFIPS": false } }, { @@ -1727,46 +515,35 @@ } }, "params": { - "UseFIPS": true, + "Region": "us-isob-east-1", "UseDualStack": false, - "Region": "us-isob-east-1" - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "UseFIPS": false, - "UseDualStack": true, - "Region": "us-isob-east-1" + "UseFIPS": true } }, { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", "expect": { "endpoint": { - "url": "https://autoscaling.us-isob-east-1.sc2s.sgov.gov" + "url": "https://example.com" } }, "params": { - "UseFIPS": false, + "Region": "us-east-1", "UseDualStack": false, - "Region": "us-isob-east-1" + "UseFIPS": false, + "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { - "UseFIPS": false, "UseDualStack": false, - "Region": "us-east-1", + "UseFIPS": false, "Endpoint": "https://example.com" } }, @@ -1776,9 +553,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { - "UseFIPS": true, - "UseDualStack": false, "Region": "us-east-1", + "UseDualStack": false, + "UseFIPS": true, "Endpoint": "https://example.com" } }, @@ -1788,9 +565,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { - "UseFIPS": false, - "UseDualStack": true, "Region": "us-east-1", + "UseDualStack": true, + "UseFIPS": false, "Endpoint": "https://example.com" } } diff --git a/models/apis/connect/2017-08-08/api-2.json b/models/apis/connect/2017-08-08/api-2.json index 8521710d618..522a25fd69b 100644 --- a/models/apis/connect/2017-08-08/api-2.json +++ b/models/apis/connect/2017-08-08/api-2.json @@ -3304,7 +3304,8 @@ "DisconnectTimestamp":{"shape":"timestamp"}, "LastUpdateTimestamp":{"shape":"timestamp"}, "ScheduledTimestamp":{"shape":"timestamp"}, - "RelatedContactId":{"shape":"ContactId"} + "RelatedContactId":{"shape":"ContactId"}, + "WisdomInfo":{"shape":"WisdomInfo"} } }, "ContactFilter":{ @@ -10390,6 +10391,12 @@ "ALL" ] }, + "WisdomInfo":{ + "type":"structure", + "members":{ + "SessionArn":{"shape":"ARN"} + } + }, "timestamp":{"type":"timestamp"} } } diff --git a/models/apis/connect/2017-08-08/docs-2.json b/models/apis/connect/2017-08-08/docs-2.json index ec490f5e7f9..9686e123fc5 100644 --- a/models/apis/connect/2017-08-08/docs-2.json +++ b/models/apis/connect/2017-08-08/docs-2.json @@ -7,7 +7,7 @@ "AssociateDefaultVocabulary": "Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language.
", "AssociateInstanceStorageConfig": "This API is in preview release for Amazon Connect and is subject to change.
Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts.
This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association.
", "AssociateLambdaFunction": "This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Lambda function.
", - "AssociateLexBot": "This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex bot.
", + "AssociateLexBot": "This API is in preview release for Amazon Connect and is subject to change.
Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots.
", "AssociatePhoneNumberContactFlow": "Associates a flow with a phone number claimed to your Amazon Connect instance.
If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the PhoneNumberId
URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a ResourceNotFoundException
.
This API is in preview release for Amazon Connect and is subject to change.
Associates a set of quick connects with a queue.
", "AssociateRoutingProfileQueues": "Associates a set of queues with a routing profile.
", @@ -256,7 +256,8 @@ "UserSearchSummary$Arn": "The Amazon Resource Name (ARN) of the user.
", "UserSummary$Arn": "The Amazon Resource Name (ARN) of the user account.
", "Vocabulary$Arn": "The Amazon Resource Name (ARN) of the custom vocabulary.
", - "VocabularySummary$Arn": "The Amazon Resource Name (ARN) of the custom vocabulary.
" + "VocabularySummary$Arn": "The Amazon Resource Name (ARN) of the custom vocabulary.
", + "WisdomInfo$SessionArn": "The Amazon Resource Name (ARN) of the Wisdom session.
" } }, "AccessDeniedException": { @@ -3920,7 +3921,7 @@ "base": null, "refs": { "AssociateRoutingProfileQueuesRequest$QueueConfigs": "The queues to associate with this routing profile.
", - "CreateRoutingProfileRequest$QueueConfigs": "The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
", + "CreateRoutingProfileRequest$QueueConfigs": "The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.
The limit of 10 array members applies to the maximum number of RoutingProfileQueueConfig
objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in Amazon Connect service quotas.
The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.
" } }, @@ -5446,6 +5447,12 @@ "VoiceRecordingConfiguration$VoiceRecordingTrack": "Identifies which track is being recorded.
" } }, + "WisdomInfo": { + "base": "Information about Amazon Connect Wisdom.
", + "refs": { + "Contact$WisdomInfo": "Information about Amazon Connect Wisdom.
" + } + }, "timestamp": { "base": null, "refs": { diff --git a/models/apis/connect/2017-08-08/endpoint-rule-set-1.json b/models/apis/connect/2017-08-08/endpoint-rule-set-1.json index 965d920a6a4..57834595dab 100644 --- a/models/apis/connect/2017-08-08/endpoint-rule-set-1.json +++ b/models/apis/connect/2017-08-08/endpoint-rule-set-1.json @@ -3,7 +3,7 @@ "parameters": { "Region": { "builtIn": "AWS::Region", - "required": true, + "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "String" }, @@ -32,13 +32,12 @@ { "conditions": [ { - "fn": "aws.partition", + "fn": "isSet", "argv": [ { - "ref": "Region" + "ref": "Endpoint" } - ], - "assign": "PartitionResult" + ] } ], "type": "tree", @@ -46,14 +45,20 @@ { "conditions": [ { - "fn": "isSet", + "fn": "booleanEquals", "argv": [ { - "ref": "Endpoint" - } + "ref": "UseFIPS" + }, + true ] } ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" + }, + { + "conditions": [], "type": "tree", "rules": [ { @@ -62,67 +67,42 @@ "fn": "booleanEquals", "argv": [ { - "ref": "UseFIPS" + "ref": "UseDualStack" }, true ] } ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" + "endpoint": { + "url": { + "ref": "Endpoint" }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "properties": {}, + "headers": {} + }, + "type": "endpoint" } ] - }, + } + ] + }, + { + "conditions": [], + "type": "tree", + "rules": [ { "conditions": [ { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", + "fn": "isSet", "argv": [ { - "ref": "UseDualStack" - }, - true + "ref": "Region" + } ] } ], @@ -131,179 +111,240 @@ { "conditions": [ { - "fn": "booleanEquals", + "fn": "aws.partition", "argv": [ - true, { - "fn": "getAttr", + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, + }, { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, { "conditions": [], - "endpoint": { - "url": "https://connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseFIPS" }, - "supportsFIPS" + true ] } - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [], + ], "type": "tree", "rules": [ { "conditions": [ { - "fn": "stringEquals", + "fn": "booleanEquals", "argv": [ - "aws-us-gov", + true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, - "name" + "supportsFIPS" ] } ] } ], - "endpoint": { - "url": "https://connect.{Region}.amazonaws.com", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "stringEquals", + "argv": [ + "aws-us-gov", + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "name" + ] + } + ] + } + ], + "endpoint": { + "url": "https://connect.{Region}.amazonaws.com", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + }, + { + "conditions": [], + "endpoint": { + "url": "https://connect-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] }, { "conditions": [], - "endpoint": { - "url": "https://connect-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" } ] - } - ] - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ] - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" }, - true - ] - } - ], - "type": "tree", - "rules": [ - { - "conditions": [ { - "fn": "booleanEquals", - "argv": [ - true, + "conditions": [ { - "fn": "getAttr", + "fn": "booleanEquals", "argv": [ { - "ref": "PartitionResult" + "ref": "UseDualStack" }, - "supportsDualStack" + true ] } + ], + "type": "tree", + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "type": "tree", + "rules": [ + { + "conditions": [], + "type": "tree", + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://connect.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ] + } + ] + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } ] - } - ], - "type": "tree", - "rules": [ + }, { "conditions": [], "type": "tree", @@ -311,7 +352,7 @@ { "conditions": [], "endpoint": { - "url": "https://connect.{Region}.{PartitionResult#dualStackDnsSuffix}", + "url": "https://connect.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, @@ -320,28 +361,13 @@ ] } ] - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" } ] }, { "conditions": [], - "type": "tree", - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://connect.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ] + "error": "Invalid Configuration: Missing Region", + "type": "error" } ] } diff --git a/models/apis/connect/2017-08-08/endpoint-tests-1.json b/models/apis/connect/2017-08-08/endpoint-tests-1.json index f021fa49e2a..ea61651d6f8 100644 --- a/models/apis/connect/2017-08-08/endpoint-tests-1.json +++ b/models/apis/connect/2017-08-08/endpoint-tests-1.json @@ -8,9 +8,9 @@ } }, "params": { + "Region": "af-south-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "af-south-1" + "UseFIPS": false } }, { @@ -21,9 +21,9 @@ } }, "params": { + "Region": "ap-northeast-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-1" + "UseFIPS": false } }, { @@ -34,9 +34,9 @@ } }, "params": { + "Region": "ap-northeast-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-northeast-2" + "UseFIPS": false } }, { @@ -47,9 +47,9 @@ } }, "params": { + "Region": "ap-southeast-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-1" + "UseFIPS": false } }, { @@ -60,9 +60,9 @@ } }, "params": { + "Region": "ap-southeast-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "ap-southeast-2" + "UseFIPS": false } }, { @@ -73,9 +73,9 @@ } }, "params": { + "Region": "ca-central-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "ca-central-1" + "UseFIPS": false } }, { @@ -86,9 +86,9 @@ } }, "params": { + "Region": "eu-central-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-central-1" + "UseFIPS": false } }, { @@ -99,9 +99,9 @@ } }, "params": { + "Region": "eu-west-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "eu-west-2" + "UseFIPS": false } }, { @@ -112,9 +112,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-east-1" + "UseFIPS": false } }, { @@ -125,9 +125,9 @@ } }, "params": { + "Region": "us-west-2", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-west-2" + "UseFIPS": false } }, { @@ -138,9 +138,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-east-1" + "UseFIPS": true } }, { @@ -151,9 +151,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-east-1" + "UseFIPS": true } }, { @@ -164,9 +164,9 @@ } }, "params": { + "Region": "us-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-east-1" + "UseFIPS": false } }, { @@ -177,9 +177,9 @@ } }, "params": { + "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "cn-north-1" + "UseFIPS": true } }, { @@ -190,9 +190,9 @@ } }, "params": { + "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "cn-north-1" + "UseFIPS": true } }, { @@ -203,9 +203,9 @@ } }, "params": { + "Region": "cn-north-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "cn-north-1" + "UseFIPS": false } }, { @@ -216,9 +216,9 @@ } }, "params": { + "Region": "cn-north-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "cn-north-1" + "UseFIPS": false } }, { @@ -229,9 +229,9 @@ } }, "params": { + "Region": "us-gov-west-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-west-1" + "UseFIPS": false } }, { @@ -242,9 +242,9 @@ } }, "params": { + "Region": "us-gov-west-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-gov-west-1" + "UseFIPS": true } }, { @@ -255,9 +255,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseDualStack": true, - "UseFIPS": true, - "Region": "us-gov-east-1" + "UseFIPS": true } }, { @@ -268,9 +268,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-gov-east-1" + "UseFIPS": true } }, { @@ -281,9 +281,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseDualStack": true, - "UseFIPS": false, - "Region": "us-gov-east-1" + "UseFIPS": false } }, { @@ -294,9 +294,9 @@ } }, "params": { + "Region": "us-gov-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-gov-east-1" + "UseFIPS": false } }, { @@ -307,9 +307,9 @@ } }, "params": { + "Region": "us-iso-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-iso-east-1" + "UseFIPS": true } }, { @@ -320,9 +320,9 @@ } }, "params": { + "Region": "us-iso-east-1", "UseDualStack": false, - "UseFIPS": false, - "Region": "us-iso-east-1" + "UseFIPS": false } }, { @@ -333,9 +333,9 @@ } }, "params": { + "Region": "us-isob-east-1", "UseDualStack": false, - "UseFIPS": true, - "Region": "us-isob-east-1" + "UseFIPS": true } }, { @@ -346,13 +346,27 @@ } }, "params": { + "Region": "us-isob-east-1", + "UseDualStack": false, + "UseFIPS": false + } + }, + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", "UseDualStack": false, "UseFIPS": false, - "Region": "us-isob-east-1" + "Endpoint": "https://example.com" } }, { - "documentation": "For custom endpoint with fips disabled and dualstack disabled", + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", "expect": { "endpoint": { "url": "https://example.com" @@ -361,7 +375,6 @@ "params": { "UseDualStack": false, "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -371,9 +384,9 @@ "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseDualStack": false, "UseFIPS": true, - "Region": "us-east-1", "Endpoint": "https://example.com" } }, @@ -383,9 +396,9 @@ "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { + "Region": "us-east-1", "UseDualStack": true, "UseFIPS": false, - "Region": "us-east-1", "Endpoint": "https://example.com" } } diff --git a/models/apis/ec2/2016-11-15/api-2.json b/models/apis/ec2/2016-11-15/api-2.json index 9640a40921d..52c02936959 100755 --- a/models/apis/ec2/2016-11-15/api-2.json +++ b/models/apis/ec2/2016-11-15/api-2.json @@ -28437,7 +28437,7 @@ "type":"structure", "members":{ "UserData":{ - "shape":"String", + "shape":"SensitiveUserData", "locationName":"userData" }, "SecurityGroups":{ @@ -35597,7 +35597,7 @@ "locationName":"subnetId" }, "UserData":{ - "shape":"String", + "shape":"SensitiveUserData", "locationName":"userData" } } @@ -36433,7 +36433,7 @@ "locationName":"instanceInitiatedShutdownBehavior" }, "UserData":{ - "shape":"String", + "shape":"SensitiveUserData", "locationName":"userData" }, "TagSpecifications":{ @@ -37436,7 +37436,8 @@ }, "SubnetId":{"shape":"SubnetId"}, "UserData":{"shape":"String"} - } + }, + "sensitive":true }, "ScheduledInstancesMonitoring":{ "type":"structure", @@ -38496,7 +38497,7 @@ "locationName":"subnetId" }, "UserData":{ - "shape":"String", + "shape":"SensitiveUserData", "locationName":"userData" }, "WeightedCapacity":{ diff --git a/models/apis/ec2/2016-11-15/docs-2.json b/models/apis/ec2/2016-11-15/docs-2.json index 95c30a88e8c..c37fc78cfee 100755 --- a/models/apis/ec2/2016-11-15/docs-2.json +++ b/models/apis/ec2/2016-11-15/docs-2.json @@ -47,7 +47,7 @@ "CancelCapacityReservationFleets": "Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens:
The Capacity Reservation Fleet's status changes to cancelled
.
The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity.
The Fleet stops creating new Capacity Reservations.
Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.
For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
", "CancelExportTask": "Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.
", - "CancelImageLaunchPermission": "Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
", + "CancelImageLaunchPermission": "Removes your Amazon Web Services account from the launch permissions for the specified AMI. For more information, see Cancel having an AMI shared with your Amazon Web Services account in the Amazon EC2 User Guide.
", "CancelImportTask": "Cancels an in-process import virtual machine or import snapshot task.
", "CancelReservedInstancesListing": "Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
", "CancelSpotFleetRequests": "Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you terminate the instances, the Spot Fleet request enters the cancelled_terminating
state. Otherwise, the Spot Fleet request enters the cancelled_running
state and the instances continue to run until they are interrupted or you terminate them manually.
Describes the specified security groups or all of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.
We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
", "DescribeSnapshotTierStatus": "Describes the storage tier status of one or more Amazon EBS snapshots.
", - "DescribeSnapshots": "Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all
group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds
option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon
for snapshots owned by Amazon, or self
for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self
for snapshots for which you own or have explicit permissions, or all
for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. The MaxResults
parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults
value, then that number of results is returned along with a NextToken
value that can be passed to a subsequent DescribeSnapshots
request to retrieve the remaining results.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
", + "DescribeSnapshots": "Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you.
The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other Amazon Web Services accounts for which you have explicit create volume permissions.
The create volume permissions fall into the following categories:
public: The owner of the snapshot granted create volume permissions for the snapshot to the all
group. All Amazon Web Services accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific Amazon Web Services account.
implicit: An Amazon Web Services account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or Amazon Web Services accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners using the OwnerIds
option, only snapshots from the specified owners and for which you have access are returned. The results can include the Amazon Web Services account IDs of the specified owners, amazon
for snapshots owned by Amazon, or self
for snapshots that you own.
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify Amazon Web Services account IDs (if you own the snapshots), self
for snapshots for which you own or have explicit permissions, or all
for public snapshots.
If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
To get the state of fast snapshot restores for a snapshot, use DescribeFastSnapshotRestores.
For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon Elastic Compute Cloud User Guide.
", "DescribeSpotDatafeedSubscription": "Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.
", "DescribeSpotFleetInstances": "Describes the running instances for the specified Spot Fleet.
", "DescribeSpotFleetRequestHistory": "Describes the events for the specified Spot Fleet request during the specified time.
Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours.
For more information, see Monitor fleet events using Amazon EventBridge in the Amazon EC2 User Guide.
", @@ -346,7 +346,7 @@ "DescribeVerifiedAccessTrustProviders": "Describe details of existing Verified Access trust providers.
", "DescribeVolumeAttribute": "Describes the specified attribute of the specified volume. You can specify only one attribute at a time.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
", "DescribeVolumeStatus": "Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event.
The DescribeVolumeStatus
operation provides the following information about the specified volumes:
Status: Reflects the current status of the volume. The possible values are ok
, impaired
, warning
, or insufficient-data
. If all checks pass, the overall status of the volume is ok
. If the check fails, the overall status is impaired
. If the status is insufficient-data
, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitor the status of your volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an impaired
status, then the volume event might be potential-data-inconsistency
. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data.
Actions: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is impaired
and the volume event shows potential-data-inconsistency
, then the action shows enable-volume-io
. This means that you may want to enable the I/O operations for the volume by calling the EnableVolumeIO action and then check the volume for data consistency.
Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the error
state (for example, when a volume is incapable of accepting I/O.)
Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. The MaxResults
parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults
value, then that number of results is returned along with a NextToken
value that can be passed to a subsequent DescribeVolumes
request to retrieve the remaining results.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
", + "DescribeVolumes": "Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see Pagination.
For more information about EBS volumes, see Amazon EBS volumes in the Amazon Elastic Compute Cloud User Guide.
", "DescribeVolumesModifications": "Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.
", "DescribeVpcAttribute": "Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
", "DescribeVpcClassicLink": "Describes the ClassicLink status of one or more VPCs.
We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.
Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.
If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.
If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
The specified instances that are in the same Availability Zone as the protected instance are not terminated.
The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.
For example, say you have the following instances:
Instance A: us-east-1a
; Not protected
Instance B: us-east-1a
; Not protected
Instance C: us-east-1b
; Protected
Instance D: us-east-1b
; not protected
If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
Instance A and Instance B are successfully terminated because none of the specified instances in us-east-1a
are enabled for termination protection.
Instance C and Instance D fail to terminate because at least one of the specified instances in us-east-1b
(Instance C) is enabled for termination protection.
Terminated instances remain visible after termination (for approximately one hour).
By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.
You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination
block device mapping parameter set to true
are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon EC2 User Guide.
", "UnassignIpv6Addresses": "Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface.
", "UnassignPrivateIpAddresses": "Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.
", - "UnassignPrivateNatGatewayAddress": "Unassigns secondary private NAT gateway IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon Virtual Private Cloud User Guide.
While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.
A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses get released.
", + "UnassignPrivateNatGatewayAddress": "Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see Edit secondary IP address associations in the Amazon Virtual Private Cloud User Guide.
While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.
A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses get released.
", "UnmonitorInstances": "Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.
", "UpdateSecurityGroupRuleDescriptionsEgress": "[VPC only] Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.
", "UpdateSecurityGroupRuleDescriptionsIngress": "Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.
", @@ -2294,7 +2294,7 @@ "DisassociateTrunkInterfaceResult$Return": "Returns true
if the request succeeds; otherwise, it returns an error.
Indicates whether DNS servers should be used. Specify False
to delete the existing DNS servers.
Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.
", - "EbsBlockDevice$Encrypted": "Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true
depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, you can specify this parameter only for block device mappings that result in new, empty volumes when instances are launched from the image. Omit this parameter on block device mappings that include an existing volume or snapshot. If you include this parameter, and specify an encryption setting that is different from the existing volume or snapshot, the request will fail.
", + "EbsBlockDevice$Encrypted": "Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true
depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true
for an encrypted volume, or false
for an unencrypted volume. If you omit this parameter, it defaults to false
(unencrypted).
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false
. If you specify true
, the request will fail. In this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true
or false
. However, if you specify false
, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Indicates whether the volume is deleted on instance termination.
", "EbsInstanceBlockDeviceSpecification$DeleteOnTermination": "Indicates whether the volume is deleted on instance termination.
", "EnaSrdSpecification$EnaSrdEnabled": "Indicates whether ENA Express is enabled for the network interface.
", @@ -4742,13 +4742,13 @@ "DITMaxResults": { "base": null, "refs": { - "DescribeInstanceTypesRequest$MaxResults": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value.
" + "DescribeInstanceTypesRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DITOMaxResults": { "base": null, "refs": { - "DescribeInstanceTypeOfferingsRequest$MaxResults": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the next token value.
" + "DescribeInstanceTypeOfferingsRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DataQueries": { @@ -5876,7 +5876,7 @@ "DescribeClassicLinkInstancesMaxResults": { "base": null, "refs": { - "DescribeClassicLinkInstancesRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
Constraint: If the value is greater than 1000, we return only 1000 items.
" + "DescribeClassicLinkInstancesRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Constraint: If the value is greater than 1000, we return only 1000 items.
" } }, "DescribeClassicLinkInstancesRequest": { @@ -6008,7 +6008,7 @@ "DescribeDhcpOptionsMaxResults": { "base": null, "refs": { - "DescribeDhcpOptionsRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeDhcpOptionsRequest": { @@ -6024,7 +6024,7 @@ "DescribeEgressOnlyInternetGatewaysMaxResults": { "base": null, "refs": { - "DescribeEgressOnlyInternetGatewaysRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeEgressOnlyInternetGatewaysRequest": { @@ -6122,7 +6122,7 @@ "DescribeFastSnapshotRestoresMaxResults": { "base": null, "refs": { - "DescribeFastSnapshotRestoresRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeFastSnapshotRestoresRequest": { @@ -6264,7 +6264,7 @@ "DescribeIamInstanceProfileAssociationsMaxResults": { "base": null, "refs": { - "DescribeIamInstanceProfileAssociationsRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeIamInstanceProfileAssociationsRequest": { @@ -6340,7 +6340,7 @@ "DescribeInstanceCreditSpecificationsMaxResults": { "base": null, "refs": { - "DescribeInstanceCreditSpecificationsRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. For more information, see Pagination.
" } }, "DescribeInstanceCreditSpecificationsRequest": { @@ -6416,7 +6416,7 @@ "DescribeInternetGatewaysMaxResults": { "base": null, "refs": { - "DescribeInternetGatewaysRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeInternetGatewaysRequest": { @@ -6614,7 +6614,7 @@ "DescribeNatGatewaysMaxResults": { "base": null, "refs": { - "DescribeNatGatewaysRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeNatGatewaysRequest": { @@ -6630,7 +6630,7 @@ "DescribeNetworkAclsMaxResults": { "base": null, "refs": { - "DescribeNetworkAclsRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeNetworkAclsRequest": { @@ -6696,7 +6696,7 @@ "DescribeNetworkInterfacePermissionsMaxResults": { "base": null, "refs": { - "DescribeNetworkInterfacePermissionsRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value. If this parameter is not specified, up to 50 results are returned by default.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. If this parameter is not specified, up to 50 results are returned by default. For more information, see Pagination.
" } }, "DescribeNetworkInterfacePermissionsRequest": { @@ -6712,7 +6712,7 @@ "DescribeNetworkInterfacesMaxResults": { "base": null, "refs": { - "DescribeNetworkInterfacesRequest$MaxResults": "The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. You cannot specify this parameter and the network interface IDs parameter in the same request.
" + "DescribeNetworkInterfacesRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.
" } }, "DescribeNetworkInterfacesRequest": { @@ -6721,7 +6721,7 @@ } }, "DescribeNetworkInterfacesResult": { - "base": "Contains the output of DescribeNetworkInterfaces.
", + "base": null, "refs": { } }, @@ -6784,7 +6784,7 @@ "DescribeReplaceRootVolumeTasksMaxResults": { "base": null, "refs": { - "DescribeReplaceRootVolumeTasksRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeReplaceRootVolumeTasksRequest": { @@ -6840,7 +6840,7 @@ "DescribeRouteTablesMaxResults": { "base": null, "refs": { - "DescribeRouteTablesRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeRouteTablesRequest": { @@ -6892,7 +6892,7 @@ "DescribeSecurityGroupRulesMaxResults": { "base": null, "refs": { - "DescribeSecurityGroupRulesRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken
value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.
" } }, "DescribeSecurityGroupRulesRequest": { @@ -6908,7 +6908,7 @@ "DescribeSecurityGroupsMaxResults": { "base": null, "refs": { - "DescribeSecurityGroupsRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken
value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.
" } }, "DescribeSecurityGroupsRequest": { @@ -6934,7 +6934,7 @@ "DescribeSnapshotTierStatusMaxResults": { "base": null, "refs": { - "DescribeSnapshotTierStatusRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeSnapshotTierStatusRequest": { @@ -7032,13 +7032,13 @@ "DescribeStaleSecurityGroupsMaxResults": { "base": null, "refs": { - "DescribeStaleSecurityGroupsRequest$MaxResults": "The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
" + "DescribeStaleSecurityGroupsRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeStaleSecurityGroupsNextToken": { "base": null, "refs": { - "DescribeStaleSecurityGroupsRequest$NextToken": "The token for the next set of items to return. (You received this token from a prior call.)
" + "DescribeStaleSecurityGroupsRequest$NextToken": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
" } }, "DescribeStaleSecurityGroupsRequest": { @@ -7070,7 +7070,7 @@ "DescribeSubnetsMaxResults": { "base": null, "refs": { - "DescribeSubnetsRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeSubnetsRequest": { @@ -7372,14 +7372,14 @@ "DescribeVpcClassicLinkDnsSupportMaxResults": { "base": null, "refs": { - "DescribeVpcClassicLinkDnsSupportRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeVpcClassicLinkDnsSupportNextToken": { "base": null, "refs": { - "DescribeVpcClassicLinkDnsSupportRequest$NextToken": "The token for the next page of results.
", - "DescribeVpcClassicLinkDnsSupportResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeVpcClassicLinkDnsSupportResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeVpcPeeringConnectionsRequest": { @@ -7481,7 +7481,7 @@ "DescribeVpcsMaxResults": { "base": null, "refs": { - "DescribeVpcsRequest$MaxResults": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "DescribeVpcsRequest": { @@ -8893,7 +8893,7 @@ "base": null, "refs": { "DescribeAddressesRequest$Filters": "One or more filters. Filter names and values are case-sensitive.
allocation-id
- [EC2-VPC] The allocation ID for the address.
association-id
- [EC2-VPC] The association ID for the address.
domain
- Indicates whether the address is for use in EC2-Classic (standard
) or in a VPC (vpc
).
instance-id
- The ID of the instance the address is associated with, if any.
network-border-group
- A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id
- [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id
- The Amazon Web Services account ID of the owner.
private-ip-address
- [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip
- The Elastic IP address, or the carrier IP address.
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
group-name
- For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1
) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1
).
message
- The Zone message.
opt-in-status
- The opt-in status (opted-in
, and not-opted-in
| opt-in-not-required
).
parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name
- The name of the Region for the Zone (for example, us-east-1
).
state
- The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available
).
zone-id
- The ID of the Availability Zone (for example, use1-az1
), the Local Zone (for example, usw2-lax1-az1
), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1
).
zone-type
- The type of zone, for example, local-zone
.
zone-name
- The name of the Availability Zone (for example, us-east-1a
), the Local Zone (for example, us-west-2-lax-1a
), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1
).
zone-type
- The type of zone, for example, local-zone
.
The filters.
group-name
- For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1
) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1
).
message
- The Zone message.
opt-in-status
- The opt-in status (opted-in
| not-opted-in
| opt-in-not-required
).
parent-zoneID
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName
- The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name
- The name of the Region for the Zone (for example, us-east-1
).
state
- The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available
).
zone-id
- The ID of the Availability Zone (for example, use1-az1
), the Local Zone (for example, usw2-lax1-az1
), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1
).
zone-name
- The name of the Availability Zone (for example, us-east-1a
), the Local Zone (for example, us-west-2-lax-1a
), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1
).
zone-type
- The type of zone (availability-zone
| local-zone
| wavelength-zone
).
One or more filters.
", "DescribeBundleTasksRequest$Filters": "The filters.
bundle-id
- The ID of the bundle task.
error-code
- If the task failed, the error code returned.
error-message
- If the task failed, the error message returned.
instance-id
- The ID of the instance.
progress
- The level of task completion, as a percentage (for example, 20%).
s3-bucket
- The Amazon S3 bucket to store the AMI.
s3-prefix
- The beginning of the AMI name.
start-time
- The time the task started (for example, 2013-09-15T17:15:20.000Z).
state
- The state of the task (pending
| waiting-for-shutdown
| bundling
| storing
| cancelling
| complete
| failed
).
update-time
- The time of the most recent update for the task.
One or more filters.
state
- The state of the Fleet (submitted
| modifying
| active
| partially_fulfilled
| expiring
| expired
| cancelling
| cancelled
| failed
).
instance-match-criteria
- The instance matching criteria for the Fleet. Only open
is supported.
tenancy
- The tenancy of the Fleet (default
| dedicated
).
allocation-strategy
- The allocation strategy used by the Fleet. Only prioritized
is supported.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", "DescribeHostReservationOfferingsRequest$MaxDuration": "This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
", "DescribeHostReservationOfferingsRequest$MinDuration": "This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
", "DescribeHostReservationsRequest$MaxResults": "The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken
value. This value can be between 5 and 500. If maxResults
is given a larger value than 500, you receive an error.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of results to return in a single call.
", "DescribeImportSnapshotTasksRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
The maximum number of items to return for this request. To retrieve the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call. For more information, see Pagination.
", + "DescribeInstancesRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same request. For more information, see Pagination.
", "DescribeLaunchTemplateVersionsRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken
value. This value can be between 1 and 200.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of instances to filter when searching for offerings.
Default: 20
", @@ -11417,14 +11417,14 @@ "DescribeScheduledInstanceAvailabilityRequest$MaxSlotDurationInHours": "The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours
and less than 1,720.
The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.
", "DescribeScheduledInstancesRequest$MaxResults": "The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of snapshot results returned by DescribeSnapshots
in paginated output. When this parameter is used, DescribeSnapshots
only returns MaxResults
results in a single page along with a NextToken
response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots
request with the returned NextToken
value. This value can be between 5 and 1,000; if MaxResults
is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots
returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.
The maximum number of snapshots to return for this request. This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then the request returns all snapshots. You cannot specify this parameter and the snapshot IDs parameter in the same request. For more information, see Pagination.
", "DescribeSpotFleetRequestsRequest$MaxResults": "The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of results to return in a single call. This value can be between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken
value.
The maximum number of volume results returned by DescribeVolumeStatus
in paginated output. When this parameter is used, the request only returns MaxResults
results in a single page along with a NextToken
response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken
value. This value can be between 5 and 1,000; if MaxResults
is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeVolumeStatus
returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
The maximum number of results (up to a limit of 500) to be returned in a paginated request.
", - "DescribeVolumesRequest$MaxResults": "The maximum number of volume results returned by DescribeVolumes
in paginated output. When this parameter is used, DescribeVolumes
only returns MaxResults
results in a single page along with a NextToken
response element. The remaining results of the initial request can be seen by sending another DescribeVolumes
request with the returned NextToken
value. This value can be between 5 and 500; if MaxResults
is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes
returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
", + "DescribeVolumeStatusRequest$MaxResults": "The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1,000; if the value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
", + "DescribeVolumesModificationsRequest$MaxResults": "The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see Pagination.
", + "DescribeVolumesRequest$MaxResults": "The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.
", "DescribeVpcEndpointConnectionNotificationsRequest$MaxResults": "The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken
value.
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken
value. This value can be between 5 and 1,000; if MaxResults
is given a value larger than 1,000, only 1,000 results are returned.
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken
value. This value can be between 5 and 1,000; if MaxResults
is given a value larger than 1,000, only 1,000 results are returned.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
" } }, "ListSnapshotsInRecycleBinRequest": { @@ -14915,16 +14915,16 @@ "DescribeExportImageTasksResult$NextToken": "The token to use to get the next page of results. This value is null
when there are no more results to return.
The token for the next set of results.
", "DescribeFastLaunchImagesResult$NextToken": "The token to use for the next set of results. This value is null when there are no more results to return.
", - "DescribeFastSnapshotRestoresRequest$NextToken": "The token for the next page of results.
", - "DescribeFastSnapshotRestoresResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeFastSnapshotRestoresResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token to retrieve the next page of results.
", "DescribeFpgaImagesResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to request the next page of results.
", - "DescribeIamInstanceProfileAssociationsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to retrieve the next page of results.
", - "DescribeInstanceTypeOfferingsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to retrieve the next page of results.
", - "DescribeInstanceTypesResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeIamInstanceProfileAssociationsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeInstanceTypeOfferingsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeInstanceTypesResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token for the next page of results.
", "DescribeIpamPoolsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
Specify the pagination token from a previous request to retrieve the next page of results.
", @@ -14944,7 +14944,7 @@ "DescribeNetworkInsightsAnalysesRequest$NextToken": "The token for the next page of results.
", "DescribeNetworkInsightsPathsRequest$NextToken": "The token for the next page of results.
", "DescribePublicIpv4PoolsRequest$NextToken": "The token for the next page of results.
", - "DescribeReplaceRootVolumeTasksRequest$NextToken": "The token for the next page of results.
", + "DescribeReplaceRootVolumeTasksRequest$NextToken": "The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", "DescribeTrafficMirrorFiltersRequest$NextToken": "The token for the next page of results.
", "DescribeTrafficMirrorSessionsRequest$NextToken": "The token for the next page of results.
", "DescribeTrafficMirrorTargetsRequest$NextToken": "The token for the next page of results.
", @@ -17329,7 +17329,11 @@ "SensitiveUserData": { "base": null, "refs": { - "KeyPair$KeyMaterial": "An unencrypted PEM encoded RSA or ED25519 private key.
" + "KeyPair$KeyMaterial": "An unencrypted PEM encoded RSA or ED25519 private key.
", + "LaunchSpecification$UserData": "The Base64-encoded user data for the instance.
", + "RequestSpotLaunchSpecification$UserData": "The Base64-encoded user data for the instance. User data is limited to 16 KB.
", + "ResponseLaunchTemplateData$UserData": "The user data for the instance.
", + "SpotFleetLaunchSpecification$UserData": "The Base64-encoded user data that instances use when starting up.
" } }, "ServiceConfiguration": { @@ -18384,14 +18388,14 @@ "DescribeCapacityReservationsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", "DescribeCarrierGatewaysResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeClassicLinkInstancesResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeClassicLinkInstancesResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token for the next page of results.
", "DescribeCoipPoolsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeDhcpOptionsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeEgressOnlyInternetGatewaysResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeDhcpOptionsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeEgressOnlyInternetGatewaysResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token to request the next page of results.
", "DescribeElasticGpusResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The owner ID for the fast-launch enabled Windows AMI.
", @@ -18409,8 +18413,8 @@ "DescribeFleetInstancesResult$NextToken": "The token for the next set of results.
", "DescribeFleetsRequest$NextToken": "The token for the next set of results.
", "DescribeFleetsResult$NextToken": "The token for the next set of results.
", - "DescribeFlowLogsRequest$NextToken": "The token for the next page of results.
", - "DescribeFlowLogsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to request the next page of items. Pagination continues from the end of the items returned by the previous request.
", + "DescribeFlowLogsResult$NextToken": "The token to request the next page of items. This value is null
when there are no more items to return.
The token to use to retrieve the next page of results.
", "DescribeHostReservationOfferingsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to use to retrieve the next page of results.
", @@ -18426,16 +18430,16 @@ "DescribeImportImageTasksResult$NextToken": "The token to use to get the next page of results. This value is null
when there are no more results to return.
A token that indicates the next page of results.
", "DescribeImportSnapshotTasksResult$NextToken": "The token to use to get the next page of results. This value is null
when there are no more results to return.
The token to retrieve the next page of results.
", - "DescribeInstanceCreditSpecificationsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeInstanceCreditSpecificationsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token to request the next page of results.
", "DescribeInstanceEventWindowsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to retrieve the next page of results.
", - "DescribeInstanceStatusResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to request the next page of results.
", - "DescribeInstancesResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeInternetGatewaysResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeInstanceStatusResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeInstancesResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeInternetGatewaysResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The version number after which to describe launch template versions.
", "DescribeLaunchTemplateVersionsRequest$MaxVersion": "The version number up to which to describe launch template versions.
", "DescribeLaunchTemplateVersionsRequest$NextToken": "The token to request the next page of results.
", @@ -18456,45 +18460,45 @@ "DescribeLocalGatewaysResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", "DescribeMovingAddressesResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeNatGatewaysResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeNetworkAclsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeNatGatewaysResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeNetworkAclsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The ID of the network interface.
", - "DescribeNetworkInterfacePermissionsRequest$NextToken": "The token to request the next page of results.
", - "DescribeNetworkInterfacePermissionsResult$NextToken": "The token to use to retrieve the next page of results.
", - "DescribeNetworkInterfacesRequest$NextToken": "The token to retrieve the next page of results.
", - "DescribeNetworkInterfacesResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeNetworkInterfacePermissionsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeNetworkInterfacesResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token for the next page of results.
", "DescribePrefixListsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to request the next page of results.
", "DescribePrincipalIdFormatResult$NextToken": "The token to use to retrieve the next page of results. This value is null when there are no more results to return.
", "DescribePublicIpv4PoolsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token to retrieve the next page of results.
", "DescribeReservedInstancesModificationsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The Availability Zone in which the Reserved Instance can be used.
", "DescribeReservedInstancesOfferingsRequest$NextToken": "The token to retrieve the next page of results.
", "DescribeReservedInstancesOfferingsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeRouteTablesResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeRouteTablesResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token for the next set of results.
", "DescribeScheduledInstanceAvailabilityResult$NextToken": "The token required to retrieve the next set of results. This value is null
when there are no more results to return.
The token for the next set of results.
", "DescribeScheduledInstancesResult$NextToken": "The token required to retrieve the next set of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeSecurityGroupRulesResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to request the next page of results.
", - "DescribeSecurityGroupsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeSecurityGroupRulesResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeSecurityGroupsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The ID of the EBS snapshot.
", - "DescribeSnapshotTierStatusRequest$NextToken": "The token for the next page of results.
", - "DescribeSnapshotTierStatusResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The NextToken
value returned from a previous paginated DescribeSnapshots
request where MaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken
value. This value is null
when there are no more results to return.
The NextToken
value to include in a future DescribeSnapshots
request. When the results of a DescribeSnapshots
request exceed MaxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeSnapshotTierStatusResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeSnapshotsResult$NextToken": "The token to include in another request to return the next page of snapshots. This value is null
when there are no more snapshots to return.
The token for the next set of results.
", "DescribeSpotFleetInstancesResponse$NextToken": "The token required to retrieve the next set of results. This value is null
when there are no more results to return.
The ID of the Spot Fleet request.
", @@ -18508,13 +18512,13 @@ "DescribeSpotPriceHistoryRequest$AvailabilityZone": "Filters the results by the specified Availability Zone.
", "DescribeSpotPriceHistoryRequest$NextToken": "The token for the next set of results.
", "DescribeSpotPriceHistoryResult$NextToken": "The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.
", - "DescribeStaleSecurityGroupsResult$NextToken": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", + "DescribeStaleSecurityGroupsResult$NextToken": "The token to include in another request to get the next page of items. If there are no additional items to return, the string is empty.
", "DescribeStoreImageTasksRequest$NextToken": "The token for the next page of results.
", "DescribeStoreImageTasksResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeSubnetsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to retrieve the next page of results.
", - "DescribeTagsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeSubnetsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeTagsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token to use to retrieve the next page of results. The value is null
when there are no more results to return.
The token to use to retrieve the next page of results. The value is null
when there are no more results to return.
The token to use to retrieve the next page of results. The value is null
when there are no more results to return.
The token for the next page of results.
", "DescribeTrunkInterfaceAssociationsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The ID of the volume.
", - "DescribeVolumeStatusRequest$NextToken": "The NextToken
value to include in a future DescribeVolumeStatus
request. When the results of the request exceed MaxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The nextToken
value returned by a previous paginated request.
Token for pagination, null if there are no more results
", - "DescribeVolumesRequest$NextToken": "The NextToken
value returned from a previous paginated DescribeVolumes
request where MaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken
value. This value is null
when there are no more results to return.
The NextToken
value to include in a future DescribeVolumes
request. When the results of a DescribeVolumes
request exceed MaxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeVolumeStatusResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned by a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeVolumesModificationsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
if there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
", + "DescribeVolumesResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The ID of the VPC.
", "DescribeVpcEndpointConnectionNotificationsRequest$NextToken": "The token to request the next page of results.
", "DescribeVpcEndpointConnectionNotificationsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", "DescribeVpcEndpointsRequest$NextToken": "The token for the next set of items to return. (You received this token from a prior call.)
", "DescribeVpcEndpointsResult$NextToken": "The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.
", - "DescribeVpcPeeringConnectionsRequest$NextToken": "The token for the next page of results.
", - "DescribeVpcPeeringConnectionsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "DescribeVpcsResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeVpcPeeringConnectionsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "DescribeVpcsResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
", "DetachVolumeRequest$Device": "The device name.
", "DeviceOptions$TenantId": "The ID of the tenant application with the device-identity provider.
", @@ -19036,7 +19040,6 @@ "LaunchPermission$UserId": "The Amazon Web Services account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
", "LaunchPermission$OrganizationArn": "The Amazon Resource Name (ARN) of an organization.
", "LaunchPermission$OrganizationalUnitArn": "The Amazon Resource Name (ARN) of an organizational unit (OU).
", - "LaunchSpecification$UserData": "The Base64-encoded user data for the instance.
", "LaunchSpecification$AddressingType": "Deprecated.
", "LaunchSpecification$ImageId": "The ID of the AMI.
", "LaunchSpecification$KernelId": "The ID of the kernel.
", @@ -19087,8 +19090,8 @@ "LicenseConfigurationRequest$LicenseConfigurationArn": "The Amazon Resource Name (ARN) of the license configuration.
", "ListImagesInRecycleBinRequest$NextToken": "The token for the next page of results.
", "ListImagesInRecycleBinResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token for the next page of results.
", - "ListSnapshotsInRecycleBinResult$NextToken": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
", + "ListSnapshotsInRecycleBinResult$NextToken": "The token to include in another request to get the next page of items. This value is null
when there are no more items to return.
The Amazon Web Services account ID.
", "LoadPermissionRequest$UserId": "The Amazon Web Services account ID.
", "LocalGateway$OutpostArn": "The Amazon Resource Name (ARN) of the Outpost.
", @@ -19386,7 +19389,6 @@ "RequestSpotInstancesRequest$LaunchGroup": "The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
", "RequestSpotInstancesRequest$SpotPrice": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
Deprecated.
", - "RequestSpotLaunchSpecification$UserData": "The Base64-encoded user data for the instance. User data is limited to 16 KB.
", "RequestSpotLaunchSpecificationSecurityGroupList$member": null, "Reservation$OwnerId": "The ID of the Amazon Web Services account that owns the reservation.
", "Reservation$RequesterId": "The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).
", @@ -19423,7 +19425,6 @@ "ResponseLaunchTemplateData$ImageId": "The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch.
The value depends on what you specified in the request. The possible values are:
If an AMI ID was specified in the request, then this is the AMI ID.
If a Systems Manager parameter was specified in the request, and ResolveAlias
was configured as true
, then this is the AMI ID that the parameter is mapped to in the Parameter Store.
If a Systems Manager parameter was specified in the request, and ResolveAlias
was configured as false
, then this is the parameter value.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
", "ResponseLaunchTemplateData$KeyName": "The name of the key pair.
", "ResponseLaunchTemplateData$RamDiskId": "The ID of the RAM disk, if applicable.
", - "ResponseLaunchTemplateData$UserData": "The user data for the instance.
", "RestorableByStringList$member": null, "RestoreAddressToClassicRequest$PublicIp": "The Elastic IP address.
", "RestoreAddressToClassicResult$PublicIp": "The Elastic IP address.
", @@ -19582,7 +19583,6 @@ "SpotFleetLaunchSpecification$KernelId": "The ID of the kernel.
", "SpotFleetLaunchSpecification$RamdiskId": "The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the Amazon Web Services Resource Center and search for the kernel ID.
", "SpotFleetLaunchSpecification$SpotPrice": "The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The Base64-encoded user data that instances use when starting up.
", "SpotFleetRequestConfig$SpotFleetRequestId": "The ID of the Spot Fleet request.
", "SpotFleetRequestConfigData$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.
", "SpotFleetRequestConfigData$IamFleetRole": "The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration
.
The tags to apply to a resource when the resource is being created.
The Valid Values
lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
The Valid Values
lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.
Creates a context. A context is a lineage tracking entity that represents a logical grouping of other tracking or experiment entities. Some examples are an endpoint and a model package. For more information, see Amazon SageMaker ML Lineage Tracking.
", "CreateDataQualityJobDefinition": "Creates a definition for a job that monitors data quality and drift. For information about model monitor, see Amazon SageMaker Model Monitor.
", "CreateDeviceFleet": "Creates a device fleet.
", - "CreateDomain": "Creates a Domain
used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. An Amazon Web Services account is limited to one domain per region. Users within a domain can share notebook files and other artifacts with each other.
EFS storage
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType
parameter. AppNetworkAccessType
corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly
- Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly
- All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.
NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
", + "CreateDomain": "Creates a Domain
used by Amazon SageMaker Studio. A domain consists of an associated Amazon Elastic File System (EFS) volume, a list of authorized users, and a variety of security, application, policy, and Amazon Virtual Private Cloud (VPC) configurations. Users within a domain can share notebook files and other artifacts with each other.
EFS storage
When a domain is created, an EFS volume is created for use by all of the users within the domain. Each user receives a private home directory within the EFS volume for notebooks, Git repositories, and data files.
SageMaker uses the Amazon Web Services Key Management Service (Amazon Web Services KMS) to encrypt the EFS volume attached to the domain with an Amazon Web Services managed key by default. For more control, you can specify a customer managed key. For more information, see Protect Data at Rest Using Encryption.
VPC configuration
All SageMaker Studio traffic between the domain and the EFS volume is through the specified VPC and subnets. For other Studio traffic, you can specify the AppNetworkAccessType
parameter. AppNetworkAccessType
corresponds to the network access type that you choose when you onboard to Studio. The following options are available:
PublicInternetOnly
- Non-EFS traffic goes through a VPC managed by Amazon SageMaker, which allows internet access. This is the default value.
VpcOnly
- All Studio traffic is through the specified VPC and subnets. Internet access is disabled by default. To allow internet access, you must specify a NAT gateway.
When internet access is disabled, you won't be able to run a Studio notebook or to train or host models unless your VPC has an interface endpoint to the SageMaker API and runtime or a NAT gateway and your security groups allow outbound connections.
NFS traffic over TCP on port 2049 needs to be allowed in both inbound and outbound rules in order to launch a SageMaker Studio app successfully.
For more information, see Connect SageMaker Studio Notebooks to Resources in a VPC.
", "CreateEdgeDeploymentPlan": "Creates an edge deployment plan, consisting of multiple stages. Each stage may have a different deployment configuration and devices.
", "CreateEdgeDeploymentStage": "Creates a new stage in an existing edge deployment plan.
", "CreateEdgePackagingJob": "Starts a SageMaker Edge Manager model packaging job. Edge Manager will use the model artifacts from the Amazon Simple Storage Service bucket that you specify. After the model has been packaged, Amazon SageMaker saves the resulting artifacts to an S3 bucket that you specify.
", - "CreateEndpoint": "Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using SageMaker hosting services.
For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook.
You must not delete an EndpointConfig
that is in use by an endpoint that is live or while the UpdateEndpoint
or CreateEndpoint
operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig
.
The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.
When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads
, the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to Creating
. After it creates the endpoint, it sets the status to InService
. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess
policy.
Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
\"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]
\"Resource\": [
\"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"
\"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"
]
For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
Creates an endpoint using the endpoint configuration specified in the request. SageMaker uses the endpoint to provision resources and deploy models. You create the endpoint configuration with the CreateEndpointConfig API.
Use this API to deploy models using SageMaker hosting services.
For an example that calls this method when deploying a model to SageMaker hosting services, see the Create Endpoint example notebook.
You must not delete an EndpointConfig
that is in use by an endpoint that is live or while the UpdateEndpoint
or CreateEndpoint
operations are being performed on the endpoint. To update an endpoint, you must create a new EndpointConfig
.
The endpoint name must be unique within an Amazon Web Services Region in your Amazon Web Services account.
When it receives the request, SageMaker creates the endpoint, launches the resources (ML compute instances), and deploys the model(s) on them.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads
, the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
When SageMaker receives the request, it sets the endpoint status to Creating
. After it creates the endpoint, it sets the status to InService
. SageMaker can then process incoming requests for inferences. To check the status of an endpoint, use the DescribeEndpoint API.
If any of the models hosted at this endpoint get model data from an Amazon S3 location, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provided. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
To add the IAM role policies for using this API operation, go to the IAM console, and choose Roles in the left navigation pane. Search the IAM role that you want to grant access to use the CreateEndpoint and CreateEndpointConfig API operations, add the following policies to the role.
Option 1: For a full SageMaker access, search and attach the AmazonSageMakerFullAccess
policy.
Option 2: For granting a limited access to an IAM role, paste the following Action elements manually into the JSON file of the IAM role:
\"Action\": [\"sagemaker:CreateEndpoint\", \"sagemaker:CreateEndpointConfig\"]
\"Resource\": [
\"arn:aws:sagemaker:region:account-id:endpoint/endpointName\"
\"arn:aws:sagemaker:region:account-id:endpoint-config/endpointConfigName\"
]
For more information, see SageMaker API Permissions: Actions, Permissions, and Resources Reference.
Creates an endpoint configuration that SageMaker hosting services uses to deploy models. In the configuration, you identify one or more models, created using the CreateModel
API, to deploy and the resources that you want SageMaker to provision. Then you call the CreateEndpoint API.
Use this API if you want to use SageMaker hosting services to deploy models into production.
In the request, you define a ProductionVariant
, for each model that you want to deploy. Each ProductionVariant
parameter also describes the resources that you want SageMaker to provision. This includes the number and type of ML compute instances to deploy.
If you are hosting multiple models, you also assign a VariantWeight
to specify how much traffic you want to allocate to each model. For example, suppose that you want to host two models, A and B, and you assign traffic weight 2 for model A and 1 for model B. SageMaker distributes two-thirds of the traffic to Model A, and one-third to model B.
When you call CreateEndpoint, a load call is made to DynamoDB to verify that your endpoint configuration exists. When you read data from a DynamoDB table supporting Eventually Consistent Reads
, the response might not reflect the results of a recently completed write operation. The response might include some stale data. If the dependent entities are not yet in DynamoDB, this causes a validation error. If you repeat your read request after a short time, the response should return the latest data. So retry logic is recommended to handle these possible issues. We also recommend that customers call DescribeEndpointConfig before calling CreateEndpoint to minimize the potential impact of a DynamoDB eventually consistent read.
Creates a SageMaker experiment. An experiment is a collection of trials that are observed, compared and evaluated as a group. A trial is a set of steps, called trial components, that produce a machine learning model.
In the Studio UI, trials are referred to as run groups and trial components are referred to as runs.
The goal of an experiment is to determine the components that produce the best model. Multiple trials are performed, each one isolating and measuring the impact of a change to one or more inputs, while keeping the remaining inputs constant.
When you use SageMaker Studio or the SageMaker Python SDK, all experiments, trials, and trial components are automatically tracked, logged, and indexed. When you use the Amazon Web Services SDK for Python (Boto), you must use the logging APIs provided by the SDK.
You can add tags to experiments, trials, trial components and then use the Search API to search for the tags.
To add a description to an experiment, specify the optional Description
parameter. To add a description later, or to change the description, call the UpdateExperiment API.
To get a list of all your experiments, call the ListExperiments API. To view an experiment's properties, call the DescribeExperiment API. To get a list of all the trials associated with an experiment, call the ListTrials API. To create a trial call the CreateTrial API.
", "CreateFeatureGroup": "Create a new FeatureGroup
. A FeatureGroup
is a group of Features
defined in the FeatureStore
to describe a Record
.
The FeatureGroup
defines the schema and features contained in the FeatureGroup. A FeatureGroup
definition is composed of a list of Features
, a RecordIdentifierFeatureName
, an EventTimeFeatureName
and configurations for its OnlineStore
and OfflineStore
. Check Amazon Web Services service quotas to see the FeatureGroup
s quota for your Amazon Web Services account.
You must include at least one of OnlineStoreConfig
and OfflineStoreConfig
to create a FeatureGroup
.
Creates a flow definition.
", - "CreateHub": "Create a hub.
", + "CreateHub": "Create a hub.
Hub APIs are only callable through SageMaker Studio.
Defines the settings you will use for the human review workflow user interface. Reviewers will see a three-panel interface with an instruction area, the item to review, and an input area.
", "CreateHyperParameterTuningJob": "Starts a hyperparameter tuning job. A hyperparameter tuning job finds the best version of a model by running many training jobs on your dataset using the algorithm you choose and values for hyperparameters within ranges that you specify. It then chooses the hyperparameter values that result in a model that performs the best, as measured by an objective metric that you choose.
A hyperparameter tuning job automatically creates Amazon SageMaker experiments, trials, and trial components for each training job that it runs. You can view these entities in Amazon SageMaker Studio. For more information, see View Experiments, Trials, and Trial Components.
Do not include any security-sensitive information including account access IDs, secrets or tokens in any hyperparameter field. If the use of security-sensitive credentials are detected, SageMaker will reject your training job request and return an exception error.
Creates a custom SageMaker image. A SageMaker image is a set of image versions. Each image version represents a container image stored in Amazon Elastic Container Registry (ECR). For more information, see Bring your own SageMaker image.
", @@ -77,8 +77,8 @@ "DeleteExperiment": "Deletes an SageMaker experiment. All trials associated with the experiment must be deleted first. Use the ListTrials API to get a list of the trials associated with the experiment.
", "DeleteFeatureGroup": "Delete the FeatureGroup
and any data that was written to the OnlineStore
of the FeatureGroup
. Data cannot be accessed from the OnlineStore
immediately after DeleteFeatureGroup
is called.
Data written into the OfflineStore
will not be deleted. The Amazon Web Services Glue database and tables that are automatically created for your OfflineStore
are not deleted.
Deletes the specified flow definition.
", - "DeleteHub": "Delete a hub.
", - "DeleteHubContent": "Delete the contents of a hub.
", + "DeleteHub": "Delete a hub.
Hub APIs are only callable through SageMaker Studio.
Delete the contents of a hub.
Hub APIs are only callable through SageMaker Studio.
Use this operation to delete a human task user interface (worker task template).
To see a list of human task user interfaces (work task templates) in your account, use . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis
.
Deletes a SageMaker image and all versions of the image. The container images aren't deleted.
", "DeleteImageVersion": "Deletes a version of a SageMaker image. The container image the version represents isn't deleted.
", @@ -126,8 +126,8 @@ "DescribeFeatureGroup": "Use this operation to describe a FeatureGroup
. The response includes information on the creation time, FeatureGroup
name, the unique identifier for each FeatureGroup
, and more.
Shows the metadata for a feature within a feature group.
", "DescribeFlowDefinition": "Returns information about the specified flow definition.
", - "DescribeHub": "Describe a hub.
", - "DescribeHubContent": "Describe the content of a hub.
", + "DescribeHub": "Describe a hub.
Hub APIs are only callable through SageMaker Studio.
Describe the content of a hub.
Hub APIs are only callable through SageMaker Studio.
Returns information about the requested human task user interface (worker task template).
", "DescribeHyperParameterTuningJob": "Gets a description of a hyperparameter tuning job.
", "DescribeImage": "Describes a SageMaker image.
", @@ -170,7 +170,7 @@ "GetModelPackageGroupPolicy": "Gets a resource policy that manages access for a model group. For information about resource policies, see Identity-based policies and resource-based policies in the Amazon Web Services Identity and Access Management User Guide..
", "GetSagemakerServicecatalogPortfolioStatus": "Gets the status of Service Catalog in SageMaker. Service Catalog is used to create SageMaker projects.
", "GetSearchSuggestions": "An auto-complete API for the search functionality in the Amazon SageMaker console. It returns suggestions of possible matches for the property name to use in Search
queries. Provides suggestions for HyperParameters
, Tags
, and Metrics
.
Import hub content.
", + "ImportHubContent": "Import hub content.
Hub APIs are only callable through SageMaker Studio.
Lists the actions in your account and their properties.
", "ListAlgorithms": "Lists the machine learning algorithms that have been created.
", "ListAliases": "Lists the aliases of a specified image or image version.
", @@ -194,9 +194,9 @@ "ListExperiments": "Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.
", "ListFeatureGroups": "List FeatureGroup
s based on given filter and order.
Returns information about the flow definitions in your account.
", - "ListHubContentVersions": "List hub content versions.
", - "ListHubContents": "List the contents of a hub.
", - "ListHubs": "List all existing hubs.
", + "ListHubContentVersions": "List hub content versions.
Hub APIs are only callable through SageMaker Studio.
List the contents of a hub.
Hub APIs are only callable through SageMaker Studio.
List all existing hubs.
Hub APIs are only callable through SageMaker Studio.
Returns information about the human task user interfaces in your account.
", "ListHyperParameterTuningJobs": "Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.
", "ListImageVersions": "Lists the versions of a specified image and their properties. The list can be filtered by creation time or modified time.
", @@ -255,7 +255,7 @@ "StartMonitoringSchedule": "Starts a previously stopped monitoring schedule.
By default, when you successfully create a new schedule, the status of a monitoring schedule is scheduled
.
Launches an ML compute instance with the latest version of the libraries and attaches your ML storage volume. After configuring the notebook instance, SageMaker sets the notebook instance status to InService
. A notebook instance's status must be InService
before you can connect to your Jupyter notebook.
Starts a pipeline execution.
", - "StopAutoMLJob": "A method for forcing the termination of a running job.
", + "StopAutoMLJob": "A method for forcing a running job to shut down.
", "StopCompilationJob": "Stops a model compilation job.
To stop a job, Amazon SageMaker sends the algorithm the SIGTERM signal. This gracefully shuts the job down. If the job hasn't stopped, it sends the SIGKILL signal.
When it receives a StopCompilationJob
request, Amazon SageMaker changes the CompilationJobSummary$CompilationJobStatus of the job to Stopping
. After Amazon SageMaker stops the job, it sets the CompilationJobSummary$CompilationJobStatus to Stopped
.
Stops a stage in an edge deployment plan.
", "StopEdgePackagingJob": "Request to stop an edge packaging job.
", @@ -282,7 +282,7 @@ "UpdateExperiment": "Adds, updates, or removes the description of an experiment. Updates the display name of an experiment.
", "UpdateFeatureGroup": "Updates the feature group.
", "UpdateFeatureMetadata": "Updates the description and parameters of the feature group.
", - "UpdateHub": "Update a hub.
", + "UpdateHub": "Update a hub.
Hub APIs are only callable through SageMaker Studio.
Updates the properties of a SageMaker image. To change the image's tags, use the AddTags and DeleteTags APIs.
", "UpdateImageVersion": "Updates the properties of a SageMaker image version.
", "UpdateInferenceExperiment": " Updates an inference experiment that you created. The status of the inference experiment has to be either Created
, Running
. For more information on the status of an inference experiment, see DescribeInferenceExperimentResponse$Status.
Set to True
to automatically generate an endpoint name for a one-click Autopilot model deployment; set to False
otherwise. The default value is False
.
If you set AutoGenerateEndpointName
to True
, do not specify the EndpointName
; otherwise a 400 error is thrown.
The collection of algorithms run on a dataset for training the model candidates of an Autopilot job.
", + "refs": { + "AutoMLAlgorithmsConfig$member": null + } + }, + "AutoMLAlgorithms": { + "base": null, + "refs": { + "AutoMLAlgorithmConfig$AutoMLAlgorithms": "The selection of algorithms run on a dataset to train the model candidates of an Autopilot job.
Selected algorithms must belong to the list corresponding to the training mode set in AutoMLJobConfig.Mode
(ENSEMBLING
or HYPERPARAMETER_TUNING
). Choose a minimum of 1 algorithm.
In ENSEMBLING
mode:
\"catboost\"
\"extra-trees\"
\"fastai\"
\"lightgbm\"
\"linear-learner\"
\"nn-torch\"
\"randomforest\"
\"xgboost\"
In HYPERPARAMETER_TUNING
mode:
\"linear-learner\"
\"mlp\"
\"xgboost\"
Stores the configuration information for the selection of algorithms used to train the model candidates.
The list of available algorithms to choose from depends on the training mode set in AutoMLJobConfig.Mode
.
AlgorithmsConfig
should not be set in AUTO
training mode.
When AlgorithmsConfig
is provided, one AutoMLAlgorithms
attribute must be set and one only.
If the list of algorithms provided as values for AutoMLAlgorithms
is empty, AutoMLCandidateGenerationConfig
uses the full set of algorithms for the given training mode.
When AlgorithmsConfig
is not provided, AutoMLCandidateGenerationConfig
uses the full set of algorithms for the given training mode.
For the list of all algorithms per training mode, see .
For more information on each algorithm, see the Algorithm support section in Autopilot developer guide.
" + } + }, "AutoMLCandidate": { "base": "Information about a candidate produced by an AutoML training job, including its status, steps, and other properties.
", "refs": { @@ -889,7 +913,7 @@ } }, "AutoMLCandidateGenerationConfig": { - "base": "Stores the config information for how a candidate is generated (optional).
", + "base": "Stores the configuration information for how a candidate is generated (optional).
", "refs": { "AutoMLJobConfig$CandidateGenerationConfig": "The configuration for generating a candidate for an AutoML job (optional).
" } @@ -955,7 +979,7 @@ "base": null, "refs": { "CreateAutoMLJobRequest$InputDataConfig": "An array of channel objects that describes the input data and its location. Each channel is a named input source. Similar to InputDataConfig
supported by . Format(s) supported: CSV, Parquet. A minimum of 500 rows is required for the training dataset. There is not a minimum number of rows required for the validation dataset.
Returns the input data configuration for the AutoML job..
" + "DescribeAutoMLJobResponse$InputDataConfig": "Returns the input data configuration for the AutoML job.
" } }, "AutoMLJobArn": { @@ -997,7 +1021,7 @@ "base": null, "refs": { "AutoMLJobSummary$AutoMLJobName": "The name of the AutoML job you are requesting.
", - "CreateAutoMLJobRequest$AutoMLJobName": "Identifies an Autopilot job. The name must be unique to your account and is case-insensitive.
", + "CreateAutoMLJobRequest$AutoMLJobName": "Identifies an Autopilot job. The name must be unique to your account and is case insensitive.
", "DescribeAutoMLJobRequest$AutoMLJobName": "Requests information about an AutoML job using its unique name.
", "DescribeAutoMLJobResponse$AutoMLJobName": "Returns the name of the AutoML job.
", "ListCandidatesForAutoMLJobRequest$AutoMLJobName": "List the candidates created for the job by providing the job's name.
", @@ -1061,8 +1085,9 @@ "AutoMLMetricEnum": { "base": null, "refs": { - "AutoMLJobObjective$MetricName": "The name of the objective metric used to measure the predictive quality of a machine learning system. This metric is optimized during training to provide the best estimate for model parameter values from data.
Here are the options:
The ratio of the number of correctly classified items to the total number of (correctly and incorrectly) classified items. It is used for both binary and multiclass classification. Accuracy measures how close the predicted class values are to the actual values. Values for accuracy metrics vary between zero (0) and one (1). A value of 1 indicates perfect accuracy, and 0 indicates perfect inaccuracy.
The area under the curve (AUC) metric is used to compare and evaluate binary classification by algorithms that return probabilities, such as logistic regression. To map the probabilities into classifications, these are compared against a threshold value.
The relevant curve is the receiver operating characteristic curve (ROC curve). The ROC curve plots the true positive rate (TPR) of predictions (or recall) against the false positive rate (FPR) as a function of the threshold value, above which a prediction is considered positive. Increasing the threshold results in fewer false positives, but more false negatives.
AUC is the area under this ROC curve. Therefore, AUC provides an aggregated measure of the model performance across all possible classification thresholds. AUC scores vary between 0 and 1. A score of 1 indicates perfect accuracy, and a score of one half (0.5) indicates that the prediction is not better than a random classifier.
BalancedAccuracy
is a metric that measures the ratio of accurate predictions to all predictions. This ratio is calculated after normalizing true positives (TP) and true negatives (TN) by the total number of positive (P) and negative (N) values. It is used in both binary and multiclass classification and is defined as follows: 0.5*((TP/P)+(TN/N)), with values ranging from 0 to 1. BalancedAccuracy
gives a better measure of accuracy when the number of positives or negatives differ greatly from each other in an imbalanced dataset. For example, when only 1% of email is spam.
The F1
score is the harmonic mean of the precision and recall, defined as follows: F1 = 2 * (precision * recall) / (precision + recall). It is used for binary classification into classes traditionally referred to as positive and negative. Predictions are said to be true when they match their actual (correct) class, and false when they do not.
Precision is the ratio of the true positive predictions to all positive predictions, and it includes the false positives in a dataset. Precision measures the quality of the prediction when it predicts the positive class.
Recall (or sensitivity) is the ratio of the true positive predictions to all actual positive instances. Recall measures how completely a model predicts the actual class members in a dataset.
F1 scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.
The F1macro
score applies F1 scoring to multiclass classification problems. It does this by calculating the precision and recall, and then taking their harmonic mean to calculate the F1 score for each class. Lastly, the F1macro averages the individual scores to obtain the F1macro
score. F1macro
scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.
The mean absolute error (MAE) is a measure of how different the predicted and actual values are, when they're averaged over all values. MAE is commonly used in regression analysis to understand model prediction error. If there is linear regression, MAE represents the average distance from a predicted line to the actual value. MAE is defined as the sum of absolute errors divided by the number of observations. Values range from 0 to infinity, with smaller numbers indicating a better model fit to the data.
The mean squared error (MSE) is the average of the squared differences between the predicted and actual values. It is used for regression. MSE values are always positive. The better a model is at predicting the actual values, the smaller the MSE value is
Precision measures how well an algorithm predicts the true positives (TP) out of all of the positives that it identifies. It is defined as follows: Precision = TP/(TP+FP), with values ranging from zero (0) to one (1), and is used in binary classification. Precision is an important metric when the cost of a false positive is high. For example, the cost of a false positive is very high if an airplane safety system is falsely deemed safe to fly. A false positive (FP) reflects a positive prediction that is actually negative in the data.
The precision macro computes precision for multiclass classification problems. It does this by calculating precision for each class and averaging scores to obtain precision for several classes. PrecisionMacro
scores range from zero (0) to one (1). Higher scores reflect the model's ability to predict true positives (TP) out of all of the positives that it identifies, averaged across multiple classes.
R2, also known as the coefficient of determination, is used in regression to quantify how much a model can explain the variance of a dependent variable. Values range from one (1) to negative one (-1). Higher numbers indicate a higher fraction of explained variability. R2
values close to zero (0) indicate that very little of the dependent variable can be explained by the model. Negative values indicate a poor fit and that the model is outperformed by a constant function. For linear regression, this is a horizontal line.
Recall measures how well an algorithm correctly predicts all of the true positives (TP) in a dataset. A true positive is a positive prediction that is also an actual positive value in the data. Recall is defined as follows: Recall = TP/(TP+FN), with values ranging from 0 to 1. Higher scores reflect a better ability of the model to predict true positives (TP) in the data, and is used in binary classification.
Recall is important when testing for cancer because it's used to find all of the true positives. A false positive (FP) reflects a positive prediction that is actually negative in the data. It is often insufficient to measure only recall, because predicting every output as a true positive will yield a perfect recall score.
The RecallMacro computes recall for multiclass classification problems by calculating recall for each class and averaging scores to obtain recall for several classes. RecallMacro scores range from 0 to 1. Higher scores reflect the model's ability to predict true positives (TP) in a dataset. Whereas, a true positive reflects a positive prediction that is also an actual positive value in the data. It is often insufficient to measure only recall, because predicting every output as a true positive will yield a perfect recall score.
Root mean squared error (RMSE) measures the square root of the squared difference between predicted and actual values, and it's averaged over all values. It is used in regression analysis to understand model prediction error. It's an important metric to indicate the presence of large model errors and outliers. Values range from zero (0) to infinity, with smaller numbers indicating a better model fit to the data. RMSE is dependent on scale, and should not be used to compare datasets of different sizes.
If you do not specify a metric explicitly, the default behavior is to automatically use:
MSE
: for regression.
F1
: for binary classification
Accuracy
: for multiclass classification.
The name of the objective metric used to measure the predictive quality of a machine learning system. This metric is optimized during training to provide the best estimate for model parameter values from data.
Here are the options:
The ratio of the number of correctly classified items to the total number of (correctly and incorrectly) classified items. It is used for both binary and multiclass classification. Accuracy measures how close the predicted class values are to the actual values. Values for accuracy metrics vary between zero (0) and one (1). A value of 1 indicates perfect accuracy, and 0 indicates perfect inaccuracy.
The area under the curve (AUC) metric is used to compare and evaluate binary classification by algorithms that return probabilities, such as logistic regression. To map the probabilities into classifications, these are compared against a threshold value.
The relevant curve is the receiver operating characteristic curve (ROC curve). The ROC curve plots the true positive rate (TPR) of predictions (or recall) against the false positive rate (FPR) as a function of the threshold value, above which a prediction is considered positive. Increasing the threshold results in fewer false positives, but more false negatives.
AUC is the area under this ROC curve. Therefore, AUC provides an aggregated measure of the model performance across all possible classification thresholds. AUC scores vary between 0 and 1. A score of 1 indicates perfect accuracy, and a score of one half (0.5) indicates that the prediction is not better than a random classifier.
BalancedAccuracy
is a metric that measures the ratio of accurate predictions to all predictions. This ratio is calculated after normalizing true positives (TP) and true negatives (TN) by the total number of positive (P) and negative (N) values. It is used in both binary and multiclass classification and is defined as follows: 0.5*((TP/P)+(TN/N)), with values ranging from 0 to 1. BalancedAccuracy
gives a better measure of accuracy when the number of positives or negatives differ greatly from each other in an imbalanced dataset. For example, when only 1% of email is spam.
The F1
score is the harmonic mean of the precision and recall, defined as follows: F1 = 2 * (precision * recall) / (precision + recall). It is used for binary classification into classes traditionally referred to as positive and negative. Predictions are said to be true when they match their actual (correct) class, and false when they do not.
Precision is the ratio of the true positive predictions to all positive predictions, and it includes the false positives in a dataset. Precision measures the quality of the prediction when it predicts the positive class.
Recall (or sensitivity) is the ratio of the true positive predictions to all actual positive instances. Recall measures how completely a model predicts the actual class members in a dataset.
F1 scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.
The F1macro
score applies F1 scoring to multiclass classification problems. It does this by calculating the precision and recall, and then taking their harmonic mean to calculate the F1 score for each class. Lastly, the F1macro averages the individual scores to obtain the F1macro
score. F1macro
scores vary between 0 and 1. A score of 1 indicates the best possible performance, and 0 indicates the worst.
The mean absolute error (MAE) is a measure of how different the predicted and actual values are, when they're averaged over all values. MAE is commonly used in regression analysis to understand model prediction error. If there is linear regression, MAE represents the average distance from a predicted line to the actual value. MAE is defined as the sum of absolute errors divided by the number of observations. Values range from 0 to infinity, with smaller numbers indicating a better model fit to the data.
The mean squared error (MSE) is the average of the squared differences between the predicted and actual values. It is used for regression. MSE values are always positive. The better a model is at predicting the actual values, the smaller the MSE value is
Precision measures how well an algorithm predicts the true positives (TP) out of all of the positives that it identifies. It is defined as follows: Precision = TP/(TP+FP), with values ranging from zero (0) to one (1), and is used in binary classification. Precision is an important metric when the cost of a false positive is high. For example, the cost of a false positive is very high if an airplane safety system is falsely deemed safe to fly. A false positive (FP) reflects a positive prediction that is actually negative in the data.
The precision macro computes precision for multiclass classification problems. It does this by calculating precision for each class and averaging scores to obtain precision for several classes. PrecisionMacro
scores range from zero (0) to one (1). Higher scores reflect the model's ability to predict true positives (TP) out of all of the positives that it identifies, averaged across multiple classes.
R2, also known as the coefficient of determination, is used in regression to quantify how much a model can explain the variance of a dependent variable. Values range from one (1) to negative one (-1). Higher numbers indicate a higher fraction of explained variability. R2
values close to zero (0) indicate that very little of the dependent variable can be explained by the model. Negative values indicate a poor fit and that the model is outperformed by a constant function. For linear regression, this is a horizontal line.
Recall measures how well an algorithm correctly predicts all of the true positives (TP) in a dataset. A true positive is a positive prediction that is also an actual positive value in the data. Recall is defined as follows: Recall = TP/(TP+FN), with values ranging from 0 to 1. Higher scores reflect a better ability of the model to predict true positives (TP) in the data, and is used in binary classification.
Recall is important when testing for cancer because it's used to find all of the true positives. A false positive (FP) reflects a positive prediction that is actually negative in the data. It is often insufficient to measure only recall, because predicting every output as a true positive yield a perfect recall score.
The RecallMacro computes recall for multiclass classification problems by calculating recall for each class and averaging scores to obtain recall for several classes. RecallMacro scores range from 0 to 1. Higher scores reflect the model's ability to predict true positives (TP) in a dataset. Whereas, a true positive reflects a positive prediction that is also an actual positive value in the data. It is often insufficient to measure only recall, because predicting every output as a true positive yields a perfect recall score.
Root mean squared error (RMSE) measures the square root of the squared difference between predicted and actual values, and it's averaged over all values. It is used in regression analysis to understand model prediction error. It's an important metric to indicate the presence of large model errors and outliers. Values range from zero (0) to infinity, with smaller numbers indicating a better model fit to the data. RMSE is dependent on scale, and should not be used to compare datasets of different sizes.
If you do not specify a metric explicitly, the default behavior is to automatically use:
MSE
: for regression.
F1
: for binary classification
Accuracy
: for multiclass classification.
The name of the metric with the best result. For a description of the possible objective metrics, see AutoMLJobObjective$MetricName.
", + "FinalAutoMLJobObjectiveMetric$StandardMetricName": "The name of the standard metric. For a description of the standard metrics, see Autopilot candidate metrics.
", "MetricDatum$MetricName": "The name of the metric.
" } }, @@ -1075,7 +1100,7 @@ "AutoMLMode": { "base": null, "refs": { - "AutoMLJobConfig$Mode": "The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO
. In AUTO
mode, Autopilot chooses ENSEMBLING
for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING
for larger ones.
The ENSEMBLING
mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING
mode.
The HYPERPARAMETER_TUNING
(HPO) mode uses the best hyperparameters to train the best version of a model. HPO will automatically select an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING
mode.
The method that Autopilot uses to train the data. You can either specify the mode manually or let Autopilot choose for you based on the dataset size by selecting AUTO
. In AUTO
mode, Autopilot chooses ENSEMBLING
for datasets smaller than 100 MB, and HYPERPARAMETER_TUNING
for larger ones.
The ENSEMBLING
mode uses a multi-stack ensemble model to predict classification and regression tasks directly from your dataset. This machine learning mode combines several base models to produce an optimal predictive model. It then uses a stacking ensemble method to combine predictions from contributing members. A multi-stack ensemble model can provide better performance over a single model by combining the predictive capabilities of multiple models. See Autopilot algorithm support for a list of algorithms supported by ENSEMBLING
mode.
The HYPERPARAMETER_TUNING
(HPO) mode uses the best hyperparameters to train the best version of a model. HPO automatically selects an algorithm for the type of problem you want to solve. Then HPO finds the best hyperparameters according to your objective metric. See Autopilot algorithm support for a list of algorithms supported by HYPERPARAMETER_TUNING
mode.
Markdown files associated with the hub content to import.
", - "ImportHubContentRequest$HubContentMarkdown": "Markdown files associated with the hub content to import.
" + "DescribeHubContentResponse$HubContentMarkdown": "A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
", + "ImportHubContentRequest$HubContentMarkdown": "A string that provides a description of the hub content. This string can include links, tables, and standard markdown formating.
" } }, "HubContentName": { @@ -6077,7 +6102,7 @@ "HyperbandStrategyMinResource": { "base": null, "refs": { - "HyperbandStrategyConfig$MinResource": "The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource
has not been reached, the training job will not be stopped by Hyperband
.
The minimum number of resources (such as epochs) that can be used by a training job launched by a hyperparameter tuning job. If the value for MinResource
has not been reached, the training job is not stopped by Hyperband
.
A Key Management Service key ID to use for encrypting a model card.
", "MonitoringClusterConfig$VolumeKmsKeyId": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the model monitoring job.
", "MonitoringOutputConfig$KmsKeyId": "The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption.
", - "OnlineStoreSecurityConfig$KmsKeyId": "The ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either IAM user or IAM role) of CreateFeatureGroup
must have below permissions to the OnlineStore
KmsKeyId
:
\"kms:Encrypt\"
\"kms:Decrypt\"
\"kms:DescribeKey\"
\"kms:CreateGrant\"
\"kms:RetireGrant\"
\"kms:ReEncryptFrom\"
\"kms:ReEncryptTo\"
\"kms:GenerateDataKey\"
\"kms:ListAliases\"
\"kms:ListGrants\"
\"kms:RevokeGrant\"
The caller (either IAM user or IAM role) to all DataPlane operations (PutRecord
, GetRecord
, DeleteRecord
) must have the following permissions to the KmsKeyId
:
\"kms:Decrypt\"
The ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker Feature Store uses to encrypt the Amazon S3 objects at rest using Amazon S3 server-side encryption.
The caller (either IAM user or IAM role) of CreateFeatureGroup
must have below permissions to the OnlineStore
KmsKeyId
:
\"kms:Encrypt\"
\"kms:Decrypt\"
\"kms:DescribeKey\"
\"kms:CreateGrant\"
\"kms:RetireGrant\"
\"kms:ReEncryptFrom\"
\"kms:ReEncryptTo\"
\"kms:GenerateDataKey\"
\"kms:ListAliases\"
\"kms:ListGrants\"
\"kms:RevokeGrant\"
The caller (either user or IAM role) to all DataPlane operations (PutRecord
, GetRecord
, DeleteRecord
) must have the following permissions to the KmsKeyId
:
\"kms:Decrypt\"
The Amazon Web Services Key Management Service key (Amazon Web Services KMS) that Amazon SageMaker uses to encrypt your output models with Amazon S3 server-side encryption after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KmsKeyId can be any of the following formats:
Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
Key ARN: arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
Alias name: alias/ExampleAlias
Alias name ARN: arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId
can be any of the following formats:
// KMS Key ID
\"1234abcd-12ab-34cd-56ef-1234567890ab\"
// Amazon Resource Name (ARN) of a KMS Key
\"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
// KMS Key Alias
\"alias/ExampleAlias\"
// Amazon Resource Name (ARN) of a KMS Key Alias
\"arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias\"
If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt
. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. SageMaker uses server-side encryption with KMS-managed keys for OutputDataConfig
. If you use a bucket policy with an s3:PutObject
permission that only allows objects with server-side encryption, set the condition key of s3:x-amz-server-side-encryption
to \"aws:kms\"
. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide.
The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob
, CreateTransformJob
, or CreateHyperParameterTuningJob
requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.
The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance(s) that run the processing job.
Certain Nitro-based instances include local storage, dependent on the instance type. Local storage volumes are encrypted using a hardware module on the instance. You can't request a VolumeKmsKeyId
when using an instance type with local storage.
For a list of instance types that support local instance storage, see Instance Store Volumes.
For more information about local instance storage encryption, see SSD Instance Store Volumes.
The maximum runtime, in seconds, an AutoML job has to complete.
If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, will not be completed.
" + "AutoMLJobCompletionCriteria$MaxAutoMLJobRuntimeInSeconds": "The maximum runtime, in seconds, an AutoML job has to complete.
If an AutoML job exceeds the maximum runtime, the job is stopped automatically and its processing is ended gracefully. The AutoML job identifies the best model whose training was completed and marks it as the best-performing model. Any unfinished steps of the job, such as automatic one-click Autopilot model deployment, are not completed.
" } }, "MaxCandidates": { @@ -11308,7 +11333,7 @@ "ResolvedAttributes": { "base": "The resolved attributes.
", "refs": { - "DescribeAutoMLJobResponse$ResolvedAttributes": "This contains ProblemType
, AutoMLJobObjective
, and CompletionCriteria
. If you do not provide these values, they are auto-inferred. If you do provide them, the values used are the ones you provide.
Contains ProblemType
, AutoMLJobObjective
, and CompletionCriteria
. If you do not provide these values, they are auto-inferred. If you do provide them, the values used are the ones you provide.
The Amazon S3 output path for the hub.
" + "HubS3StorageConfig$S3OutputPath": "The Amazon S3 bucket prefix for hosting hub content.
" } }, "S3StorageConfig": { @@ -11580,7 +11605,7 @@ "base": null, "refs": { "AthenaDatasetDefinition$OutputS3Uri": "The location in Amazon S3 where Athena query results are stored.
", - "AutoMLCandidateGenerationConfig$FeatureSpecificationS3Uri": "A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames
(optional) in JSON format as shown below:
{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }
.
You can also specify the data type of the feature (optional) in the format shown below:
{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }
These column keys may not include the target column.
In ensembling mode, Autopilot will only support the following data types: numeric
, categorical
, text
and datetime
. In HPO mode, Autopilot can support numeric
, categorical
, text
, datetime
and sequence
.
If only FeatureDataTypes
is provided, the column keys (col1
, col2
,..) should be a subset of the column names in the input data.
If both FeatureDataTypes
and FeatureAttributeNames
are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames
.
The key name FeatureAttributeNames
is fixed. The values listed in [\"col1\", \"col2\", ...]
is case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.
A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames
(optional) in JSON format as shown below:
{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }
.
You can also specify the data type of the feature (optional) in the format shown below:
{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }
These column keys may not include the target column.
In ensembling mode, Autopilot only supports the following data types: numeric
, categorical
, text
, and datetime
. In HPO mode, Autopilot can support numeric
, categorical
, text
, datetime
, and sequence
.
If only FeatureDataTypes
is provided, the column keys (col1
, col2
,..) should be a subset of the column names in the input data.
If both FeatureDataTypes
and FeatureAttributeNames
are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames
.
The key name FeatureAttributeNames
is fixed. The values listed in [\"col1\", \"col2\", ...]
are case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.
The Amazon S3 output path. Must be 128 characters or less.
", "AutoMLS3DataSource$S3Uri": "The URL to the Amazon S3 data source.
", "BatchDataCaptureConfig$DestinationS3Uri": "The Amazon S3 location being used to capture the data.
", @@ -14216,7 +14241,7 @@ "refs": { "AutoMLContainerDefinition$ModelDataUrl": "The location of the model artifacts. For more information, see .
", "ClarifyShapBaselineConfig$ShapBaselineUri": "The uniform resource identifier (URI) of the S3 bucket where the SHAP baseline file is stored. The format of the SHAP baseline file should be the same format as the format of the training dataset. For example, if the training dataset is in CSV format, and each record in the training dataset has four features, and all features are numerical, then the baseline file should also have this same format. Each record should contain only the features. If you are using a virtual private cloud (VPC), the ShapBaselineUri
should be accessible to the VPC. For more information about setting up endpoints with Amazon Virtual Private Cloud, see Give SageMaker access to Resources in your Amazon Virtual Private Cloud.
The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.
The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.
If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your IAM user account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl
.
The S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix). The S3 path is required for SageMaker built-in algorithms, but not if you use your own algorithms. For more information on built-in algorithms, see Common Parameters.
The model artifacts must be in an S3 bucket that is in the same region as the model or endpoint you are creating.
If you provide a value for this parameter, SageMaker uses Amazon Web Services Security Token Service to download model artifacts from the S3 path you provide. Amazon Web Services STS is activated in your Amazon Web Services account by default. If you previously deactivated Amazon Web Services STS for a region, you need to reactivate Amazon Web Services STS for that region. For more information, see Activating and Deactivating Amazon Web Services STS in an Amazon Web Services Region in the Amazon Web Services Identity and Access Management User Guide.
If you use a built-in algorithm to create a model, SageMaker requires that you provide a S3 path to the model artifacts in ModelDataUrl
.
The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip
compressed tar archive (.tar.gz
suffix).
The model artifacts must be in an S3 bucket that is in the same region as the model package.
The Amazon S3 path where the model artifacts, which result from model training, are stored. This path must point to a single gzip
compressed tar archive (.tar.gz
suffix).
The model artifacts must be in an S3 bucket that is in the same region as the algorithm.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
FifoTopic
– Set to true to create a FIFO topic.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
is set to 1.
The following attribute applies only to server-side encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy
– The JSON serialization of the topic's delivery policy.
DisplayName
– The human-readable name used in the From
field for notifications to email
and email-json
endpoints.
EffectiveDeliveryPolicy
– The JSON serialization of the effective delivery policy, taking system defaults into account.
Owner
– The Amazon Web Services account ID of the topic's owner.
Policy
– The JSON serialization of the topic's access control policy.
SignatureVersion
– The version of the Amazon SNS signature used for the topic.
By default, SignatureVersion
is set to 1. The signature is a Base64-encoded SHA1withRSA signature.
When you set SignatureVersion
to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
If the API response does not include the SignatureVersion
attribute, it means that the SignatureVersion
for the topic has value 1.
SubscriptionsConfirmed
– The number of confirmed subscriptions for the topic.
SubscriptionsDeleted
– The number of deleted subscriptions for the topic.
SubscriptionsPending
– The number of subscriptions pending confirmation for the topic.
TopicArn
– The topic's ARN.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
- The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the CreateTopic
action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
FifoTopic
– Set to true to create a FIFO topic.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
is set to 1
.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of the topic's attributes. Attributes in this map include the following:
DeliveryPolicy
– The JSON serialization of the topic's delivery policy.
DisplayName
– The human-readable name used in the From
field for notifications to email
and email-json
endpoints.
EffectiveDeliveryPolicy
– The JSON serialization of the effective delivery policy, taking system defaults into account.
Owner
– The Amazon Web Services account ID of the topic's owner.
Policy
– The JSON serialization of the topic's access control policy.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.
By default, SignatureVersion
is set to 1. The signature is a Base64-encoded SHA1withRSA signature.
When you set SignatureVersion
to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
If the API response does not include the SignatureVersion
attribute, it means that the SignatureVersion
for the topic has value 1.
SubscriptionsConfirmed
– The number of confirmed subscriptions for the topic.
SubscriptionsDeleted
– The number of deleted subscriptions for the topic.
SubscriptionsPending
– The number of subscriptions pending confirmation for the topic.
TopicArn
– The topic's ARN.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
- The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
FifoTopic
– When this is set to true
, a FIFO topic is created.
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that this action uses:
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
FilterPolicy
– The simple JSON object that lets your subscriber receive only a subset of messages, rather than receiving every message published to the topic.
FilterPolicyScope
– This attribute lets you choose the filtering scope by using one of the following string value types:
MessageAttributes
(default) – The filter is applied on the message attributes.
MessageBody
– The filter is applied on the message body.
RawMessageDelivery
– When set to true
, enables raw message delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need for the endpoints to process JSON formatting, which is otherwise created for Amazon SNS metadata.
RedrivePolicy
– When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.
The following attribute applies only to Amazon Kinesis Data Firehose delivery stream subscriptions:
SubscriptionRoleArn
– The ARN of the IAM role that has the following:
Permission to write to the Kinesis Data Firehose delivery stream
Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes
action uses:
ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
HTTP
HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
Amazon Kinesis Data Firehose
FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
Lambda
LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
Platform application endpoint
ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.
For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
Amazon SQS
SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.
A map of attributes with their corresponding values.
The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes
action uses:
ApplicationSuccessFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to a platform application endpoint.
DeliveryPolicy
– The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.
DisplayName
– The display name to use for a topic with SMS subscriptions.
Policy
– The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.
TracingConfig
– Tracing mode of an Amazon SNS topic. By default TracingConfig
is set to PassThrough
, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active
, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
HTTP
HTTPSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
HTTPSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an HTTP endpoint.
HTTPFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an HTTP endpoint.
Amazon Kinesis Data Firehose
FirehoseSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
FirehoseSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
FirehoseFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Kinesis Data Firehose endpoint.
Lambda
LambdaSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
LambdaSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Lambda endpoint.
LambdaFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Lambda endpoint.
Platform application endpoint
ApplicationSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
ApplicationSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
ApplicationFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon Web Services application endpoint.
In addition to being able to configure topic attributes for message delivery status of notification messages sent to Amazon SNS application endpoints, you can also configure application attributes for the delivery status of push notification messages sent to push notification services.
For example, For more information, see Using Amazon SNS Application Attributes for Message Delivery Status.
Amazon SQS
SQSSuccessFeedbackRoleArn
– Indicates successful message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
SQSSuccessFeedbackSampleRate
– Indicates percentage of successful messages to sample for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
SQSFailureFeedbackRoleArn
– Indicates failed message delivery status for an Amazon SNS topic that is subscribed to an Amazon SQS endpoint.
The <ENDPOINT>SuccessFeedbackRoleArn and <ENDPOINT>FailureFeedbackRoleArn attributes are used to give Amazon SNS write access to use CloudWatch Logs on your behalf. The <ENDPOINT>SuccessFeedbackSampleRate attribute is for specifying the sample rate percentage (0-100) of successfully delivered messages. After you configure the <ENDPOINT>FailureFeedbackRoleArn attribute, then all failed message deliveries generate CloudWatch Logs.
The following attribute applies only to server-side-encryption:
KmsMasterKeyId
– The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
SignatureVersion
– The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, SignatureVersion
is set to 1
.
The following attribute applies only to FIFO topics:
ContentBasedDeduplication
– Enables content-based deduplication for FIFO topics.
By default, ContentBasedDeduplication
is set to false
. If you create a FIFO topic and this attribute is false
, you must specify a value for the MessageDeduplicationId
parameter for the Publish action.
When you set ContentBasedDeduplication
to true
, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId
using the body of the message (but not the attributes of the message).
(Optional) To override the generated value, you can specify a value for the MessageDeduplicationId
parameter for the Publish
action.