Attaches one or more EC2 instances to the specified Auto Scaling group.
\nWhen you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.
\nIf there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.
\nFor more information, see Attach EC2 instances to\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Attaches one or more EC2 instances to the specified Auto Scaling group.
\nWhen you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.
\nIf there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.
\nFor more information, see Detach\n or attach instances in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To attach an instance to an Auto Scaling group", @@ -1046,7 +1046,7 @@ "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The lifecycle state for the instance. The Quarantined state is not used.\n For information about lifecycle states, see Instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.
Valid values: Pending | Pending:Wait |\n Pending:Proceed | Quarantined | InService |\n Terminating | Terminating:Wait |\n Terminating:Proceed | Terminated | Detaching\n | Detached | EnteringStandby | Standby |\n Warmed:Pending | Warmed:Pending:Wait |\n Warmed:Pending:Proceed | Warmed:Terminating |\n Warmed:Terminating:Wait | Warmed:Terminating:Proceed |\n Warmed:Terminated | Warmed:Stopped |\n Warmed:Running\n
The lifecycle state for the instance. The Quarantined state is not used.\n For more information, see Amazon EC2 Auto Scaling instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.
Valid values: Pending | Pending:Wait |\n Pending:Proceed | Quarantined | InService |\n Terminating | Terminating:Wait |\n Terminating:Proceed | Terminated | Detaching\n | Detached | EnteringStandby | Standby |\n Warmed:Pending | Warmed:Pending:Wait |\n Warmed:Pending:Proceed | Warmed:Terminating |\n Warmed:Terminating:Wait | Warmed:Terminating:Proceed |\n Warmed:Terminated | Warmed:Stopped |\n Warmed:Running\n
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.
\nFor more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
", + "smithy.api#documentation": "Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances\n based on user-defined scaling policies, scheduled actions, and health checks.
\nFor more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
", "smithy.api#title": "Auto Scaling", "smithy.api#xmlNamespace": { "uri": "http://autoscaling.amazonaws.com/doc/2011-01-01/" @@ -2504,14 +2504,14 @@ "VirtualName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the instance store volume (virtual device) to attach to an instance at\n launch. The name must be in the form ephemeralX where\n X is a number starting from zero (0), for example,\n ephemeral0.
The name of the instance store volume (virtual device) to attach to an instance at\n launch. The name must be in the form ephemeralX where\n X is a number starting from zero (0), for example,\n ephemeral0.
The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n 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\n following properties: Ebs, NoDevice, or\n VirtualName.
The device name assigned to the volume (for example, /dev/sdh or\n xvdh). For more information, see Device naming on Linux\n 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\n following properties: Ebs, NoDevice, or\n VirtualName.
\n We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.\n
\nCreates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nIf you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started\n with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size properties (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
Information used to specify the launch template and version to use to launch\n instances.
\nConditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Creating a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nInformation used to specify the launch template and version to use to launch\n instances.
\nConditional: You must specify either a launch template (LaunchTemplate or\n MixedInstancesPolicy) or a launch configuration\n (LaunchConfigurationName or InstanceId).
The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Create a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nThe ID of the instance used to base the launch configuration on. If specified, Amazon\n EC2 Auto Scaling uses the configuration values from the specified instance to create a\n new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Creating an Auto Scaling group using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The ID of the instance used to base the launch configuration on. If specified, Amazon\n EC2 Auto Scaling uses the configuration values from the specified instance to create a\n new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Create an Auto Scaling group using parameters from an existing instance in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "MinSize": { @@ -2979,7 +2979,7 @@ "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "\n Only needed if you use simple scaling policies.\n
\nThe amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nDefault: 300 seconds
\n Only needed if you use simple scaling policies.\n
\nThe amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nDefault: 300 seconds
A comma-separated value string of one or more health check types.
\nThe valid values are EC2, ELB, and VPC_LATTICE.\n EC2 is the default health check and cannot be disabled. For more\n information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously\n set.
A comma-separated value string of one or more health check types.
\nThe valid values are EC2, ELB, and VPC_LATTICE.\n EC2 is the default health check and cannot be disabled. For more\n information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously\n set.
A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.
\nValid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n
A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nValid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "CapacityRebalance": { @@ -3063,7 +3063,7 @@ "MaxInstanceLifetime": { "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", "traits": { - "smithy.api#documentation": "The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "Context": { @@ -3075,7 +3075,7 @@ "DesiredCapacityType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.
Valid values: units | vcpu | memory-mib\n
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.
Valid values: units | vcpu | memory-mib\n
Creates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
\nAmazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
\nCreates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Quotas for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
\nAmazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a\n launch template or a launch configuration. We strongly recommend that you do not use\n launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2.\n For information about using launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
\nThe ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
\nIf you specify InstanceId, an ImageId is not\n required.
The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
\nIf you specify InstanceId, an ImageId is not\n required.
The name of the key pair. For more information, see Amazon EC2 key pairs and Linux\n instances in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The name of the key pair. For more information, see Amazon EC2 key pairs and Amazon EC2\n instances in the Amazon EC2 User Guide for Linux Instances.
" } }, "SecurityGroups": { "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { - "smithy.api#documentation": "A list that contains the security group IDs to assign to the instances in the Auto Scaling\n group. For more information, see Control traffic to\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.
" + "smithy.api#documentation": "A list that contains the security group IDs to assign to the instances in the Auto Scaling\n group. For more information, see Control traffic to your Amazon Web Services\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.
" } }, "ClassicLinkVPCId": { @@ -3180,13 +3180,13 @@ "UserData": { "target": "com.amazonaws.autoscaling#XmlStringUserData", "traits": { - "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" + "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" } }, "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.
\nTo create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.
\nFor more information, see Creating a launch\n configuration using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.
\nTo create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.
\nFor more information, see Create a launch\n configuration in the Amazon EC2 Auto Scaling User Guide.
" } }, "InstanceType": { @@ -3198,13 +3198,13 @@ "KernelId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The ID of the kernel associated with the AMI.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.
\nThe ID of the kernel associated with the AMI.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux Instances.
\nThe ID of the RAM disk to select.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux\n Instances.
\nThe ID of the RAM disk to select.
\nWe recommend that you use PV-GRUB instead of kernels and RAM disks. For more\n information, see User provided\n kernels in the Amazon EC2 User Guide for Linux Instances.
\nControls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.
The default value is true (enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.
\nControls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.
The default value is true (enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure\n monitoring for Auto Scaling instances in the\n Amazon EC2 Auto Scaling User Guide.
\nThe maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Range: Minimum value of 0.001
\nWhen you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.
\nThe maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Request Spot\n Instances for fault-tolerant and flexible applications in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Range: Minimum value of 0.001
\nWhen you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.
\nSpecifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-optimized instances in\n the Amazon EC2 User Guide for Linux Instances.
The default value is false.
Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-optimized instances\n in the Amazon EC2 User Guide for Linux Instances.
The default value is false.
Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.
\nIf you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet.
\nIf you specify true, each instance in the Auto Scaling group receives a unique\n public IPv4 address. For more information, see Provide network connectivity for\n your Auto Scaling instances using Amazon VPC in the\n Amazon EC2 Auto Scaling User Guide.
If you specify this property, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated. For more information,\n see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
Valid values: default | dedicated\n
The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC. To launch dedicated instances into a shared tenancy\n VPC (a VPC with the instance placement tenancy attribute set to default),\n you must set the value of this property to dedicated.
If you specify PlacementTenancy, you must specify at least one subnet for\n VPCZoneIdentifier when you create your group.
Valid values: default | dedicated\n
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.
" } } } @@ -3572,7 +3572,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified scaling policy.
\nDeleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.
\nFor more information, see Deleting a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Deletes the specified scaling policy.
\nDeleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.
\nFor more information, see Delete a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To delete an Auto Scaling policy", @@ -4837,7 +4837,7 @@ } ], "traits": { - "smithy.api#documentation": "Gets information about the scaling activities in the account and Region.
\nWhen scaling events occur, you see a record of the scaling activity in the scaling\n activities. For more information, see Verifying a scaling\n activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
\nIf the scaling event succeeds, the value of the StatusCode element in the\n response is Successful. If an attempt to launch instances failed, the\n StatusCode value is Failed or Cancelled and\n the StatusMessage element in the response indicates the cause of the\n failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Gets information about the scaling activities in the account and Region.
\nWhen scaling events occur, you see a record of the scaling activity in the scaling\n activities. For more information, see Verify a scaling\n activity for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
\nIf the scaling event succeeds, the value of the StatusCode element in the\n response is Successful. If an attempt to launch instances failed, the\n StatusCode value is Failed or Cancelled and\n the StatusMessage element in the response indicates the cause of the\n failure. For help interpreting the StatusMessage, see Troubleshooting Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Describes the termination policies supported by Amazon EC2 Auto Scaling.
\nFor more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Describes the termination policies supported by Amazon EC2 Auto Scaling.
\nFor more information, see Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To describe termination policy types", @@ -5355,7 +5355,7 @@ "LaunchTemplate": { "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.
" } }, "MixedInstancesPolicy": { @@ -5383,7 +5383,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes one or more instances from the specified Auto Scaling group.
\nAfter the instances are detached, you can manage them independent of the Auto Scaling\n group.
\nIf you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.
\nIf there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.
\nFor more information, see Detach EC2 instances from\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Removes one or more instances from the specified Auto Scaling group.
\nAfter the instances are detached, you can manage them independent of the Auto Scaling\n group.
\nIf you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.
\nIf there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.
\nFor more information, see Detach\n or attach instances in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To detach an instance from an Auto Scaling group", @@ -5659,7 +5659,7 @@ "Metrics": { "target": "com.amazonaws.autoscaling#Metrics", "traits": { - "smithy.api#documentation": "Identifies the metrics to disable.
\nYou can specify one or more of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you omit this property, all metrics are disabled.
\nFor more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Identifies the metrics to disable.
\nYou can specify one or more of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you omit this property, all metrics are disabled.
\nFor more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } } } @@ -5685,7 +5685,7 @@ "VolumeType": { "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType", "traits": { - "smithy.api#documentation": "The volume type. For more information, see Amazon EBS volume types in the\n Amazon EC2 User Guide for Linux Instances.
\nValid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n
The volume type. For more information, see Amazon EBS volume types in the\n Amazon EBS User Guide.
\nValid values: standard | io1 | gp2 |\n st1 | sc1 | gp3\n
The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for Instances\n built on the Nitro System. Other instance families guarantee performance up\n to 32,000 IOPS.
\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)
The number of input/output (I/O) operations per second (IOPS) to provision for the\n volume. For gp3 and io1 volumes, this represents the number of\n IOPS that are provisioned for the volume. For gp2 volumes, this represents\n the baseline performance of the volume and the rate at which the volume accumulates I/O\n credits for bursting.
The following are the supported values for each volume type:
\n\n gp3: 3,000-16,000 IOPS
\n io1: 100-64,000 IOPS
For io1 volumes, we guarantee 64,000 IOPS only for Instances built on the Amazon Web Services Nitro System. Other instance families\n guarantee performance up to 32,000 IOPS.
\n Iops is supported when the volume type is gp3 or\n io1 and required only when the volume type is io1. (Not\n used with standard, gp2, st1, or sc1\n volumes.)
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Supported instance types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.
\nIf you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.
\nFor more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.
\nSpecifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see Requirements for Amazon EBS encryption in the Amazon EBS User Guide. If your AMI uses encrypted volumes, you\n can also only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot create an unencrypted\n volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using\n a launch configuration.
\nIf you enable encryption by default, the EBS volumes that you create are always\n encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key,\n regardless of whether the snapshot was encrypted.
\nFor more information, see Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes in the\n Amazon EC2 Auto Scaling User Guide.
\nIdentifies the metrics to enable.
\nYou can specify one or more of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you specify Granularity and don't specify any metrics, all metrics are\n enabled.
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Identifies the metrics to enable.
\nYou can specify one or more of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
If you specify Granularity and don't specify any metrics, all metrics are\n enabled.
For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "Granularity": { @@ -5780,7 +5780,7 @@ "Metric": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "One of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "One of the following metrics:
\n\n GroupMinSize\n
\n GroupMaxSize\n
\n GroupDesiredCapacity\n
\n GroupInServiceInstances\n
\n GroupPendingInstances\n
\n GroupStandbyInstances\n
\n GroupTerminatingInstances\n
\n GroupTotalInstances\n
\n GroupInServiceCapacity\n
\n GroupPendingCapacity\n
\n GroupStandbyCapacity\n
\n GroupTerminatingCapacity\n
\n GroupTotalCapacity\n
\n WarmPoolDesiredCapacity\n
\n WarmPoolWarmedCapacity\n
\n WarmPoolPendingCapacity\n
\n WarmPoolTerminatingCapacity\n
\n WarmPoolTotalCapacity\n
\n GroupAndWarmPoolDesiredCapacity\n
\n GroupAndWarmPoolTotalCapacity\n
For more information, see Amazon CloudWatch metrics for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "Granularity": { @@ -5959,7 +5959,7 @@ "HonorCooldown": { "target": "com.amazonaws.autoscaling#HonorCooldown", "traits": { - "smithy.api#documentation": "Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.
\nValid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.
\nValid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
A description of the current lifecycle state. The Quarantined state is\n not used. For information about lifecycle states, see Instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.
A description of the current lifecycle state. The Quarantined state is\n not used. For more information, see Amazon EC2 Auto Scaling instance\n lifecycle in the Amazon EC2 Auto Scaling User Guide.
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#InstanceMonitoring": { @@ -6798,7 +6798,7 @@ } }, "traits": { - "smithy.api#documentation": "The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your\n specified requirements to identify instance types. Then, it uses your On-Demand and Spot\n allocation strategies to launch instances from these instance types.
\nWhen you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.
\nTo limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance\n types, you can use one of the following parameters, but not both in the same\n request:
\n\n AllowedInstanceTypes - The instance types to include in the list.\n All other instance types are ignored, even if they match your specified\n attributes.
\n ExcludedInstanceTypes - The instance types to exclude from the\n list, even if they match your specified attributes.
You must specify VCpuCount and MemoryMiB. All other\n attributes are optional. Any unspecified optional attribute is set to its\n default.
For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide. For help determining which instance types match\n your attributes before you apply them to your Auto Scaling group, see Preview instance types with specified attributes in the\n Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your\n specified requirements to identify instance types. Then, it uses your On-Demand and Spot\n allocation strategies to launch instances from these instance types.
\nWhen you specify multiple attributes, you get instance types that satisfy all of the\n specified attributes. If you specify multiple values for an attribute, you get instance\n types that satisfy any of the specified values.
\nTo limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance\n types, you can use one of the following parameters, but not both in the same\n request:
\n\n AllowedInstanceTypes - The instance types to include in the list.\n All other instance types are ignored, even if they match your specified\n attributes.
\n ExcludedInstanceTypes - The instance types to exclude from the\n list, even if they match your specified attributes.
You must specify VCpuCount and MemoryMiB. All other\n attributes are optional. Any unspecified optional attribute is set to its\n default.
For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide. For help determining\n which instance types match your attributes before you apply them to your Auto Scaling group, see\n Preview instance types with specified attributes in the\n Amazon EC2 User Guide for Linux Instances.
" } }, "com.amazonaws.autoscaling#InstanceReusePolicy": { @@ -6967,20 +6967,20 @@ "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Find a Linux AMI in the\n Amazon EC2 User Guide for Linux Instances.
", "smithy.api#required": {} } }, "KeyName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the key pair.
\nFor more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The name of the key pair.
\nFor more information, see Amazon EC2 key pairs and Amazon EC2\n instances in the Amazon EC2 User Guide for Linux Instances.
" } }, "SecurityGroups": { "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { - "smithy.api#documentation": "A list that contains the security groups to assign to the instances in the Auto Scaling group.\n For more information, see Security Groups for Your\n VPC in the Amazon Virtual Private Cloud User\n Guide.
" + "smithy.api#documentation": "A list that contains the security groups to assign to the instances in the Auto Scaling group.\n For more information, see Control traffic to your Amazon Web Services\n resources using security groups in the Amazon Virtual Private\n Cloud User Guide.
" } }, "ClassicLinkVPCId": { @@ -6998,7 +6998,7 @@ "UserData": { "target": "com.amazonaws.autoscaling#XmlStringUserData", "traits": { - "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" + "smithy.api#documentation": "The user data to make available to the launched EC2 instances. For more information,\n see Instance metadata and user data (Linux) and Instance metadata and\n user data (Windows). If you are using a command line tool, base64-encoding\n is performed for you, and you can load the text from a file. Otherwise, you must provide\n base64-encoded text. User data is limited to 16 KB.
" } }, "InstanceType": { @@ -7024,19 +7024,19 @@ "BlockDeviceMappings": { "target": "com.amazonaws.autoscaling#BlockDeviceMappings", "traits": { - "smithy.api#documentation": "The block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The block device mapping entries that define the block devices to attach to the\n instances at launch. By default, the block devices specified in the block device mapping\n for the AMI are used. For more information, see Block device\n mappings in the Amazon EC2 User Guide for Linux Instances.
" } }, "InstanceMonitoring": { "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { - "smithy.api#documentation": "Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.
For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Controls whether instances in this group are launched with detailed\n (true) or basic (false) monitoring.
For more information, see Configure\n monitoring for Auto Scaling instances in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "SpotPrice": { "target": "com.amazonaws.autoscaling#SpotPrice", "traits": { - "smithy.api#documentation": "The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Requesting Spot\n Instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Requesting Spot\n Instances for fault-tolerant and flexible applications in the Amazon EC2 Auto Scaling User Guide.
" } }, "IamInstanceProfile": { @@ -7056,25 +7056,25 @@ "EbsOptimized": { "target": "com.amazonaws.autoscaling#EbsOptimized", "traits": { - "smithy.api#documentation": "Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). For more information, see Amazon\n EBS-Optimized Instances in the Amazon EC2 User Guide for Linux Instances.
Specifies whether the launch configuration is optimized for EBS I/O\n (true) or not (false). For more information, see Amazon EBS-optimized instances in the\n Amazon EC2 User Guide for Linux Instances.
Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Specifies whether to assign a public IPv4 address to the group's instances. If the\n instance is launched into a default subnet, the default is to assign a public IPv4\n address, unless you disabled the option to assign a public IPv4 address on the subnet.\n If the instance is launched into a nondefault subnet, the default is not to assign a\n public IPv4 address, unless you enabled the option to assign a public IPv4 address on\n the subnet. For more information, see Provide network connectivity for\n your Auto Scaling instances using Amazon VPC in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "PlacementTenancy": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.
For more information, see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The tenancy of the instance, either default or dedicated. An\n instance with dedicated tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.
The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The metadata options for the instances. For more information, see Configure the instance metadata options in the\n Amazon EC2 Auto Scaling User Guide.
" } } }, @@ -7119,7 +7119,7 @@ "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
The maximum number of items to return with this call. The default value is\n 50 and the maximum value is 100.
A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken value when requesting the next set of items. This value is\n null when there are no more items to return.
The instance type, such as m3.xlarge. You must specify an instance type\n that is supported in your requested Region and Availability Zones. For more information,\n see Instance types in the Amazon Elastic Compute Cloud User\n Guide.
You can specify up to 40 instance types per Auto Scaling group.
" + "smithy.api#documentation": "The instance type, such as m3.xlarge. You must specify an instance type\n that is supported in your requested Region and Availability Zones. For more information,\n see Instance types in the Amazon EC2 User Guide for Linux Instances.
You can specify up to 40 instance types per Auto Scaling group.
" } }, "WeightedCapacity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "If you provide a list of instance types to use, you can specify the number of capacity\n units provided by each instance type in terms of virtual CPUs, memory, storage,\n throughput, or other relative performance characteristic. When a Spot or On-Demand\n Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling\n launches instances until the desired capacity is totally fulfilled, even if this results\n in an overage. For example, if there are two units remaining to fulfill capacity, and\n Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units,\n the instance is launched, and the desired capacity is exceeded by three units. For more\n information, see Configuring instance weighting for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.
If you specify a value for WeightedCapacity for one instance type, you\n must specify a value for WeightedCapacity for all of them.
Every Auto Scaling group has three size parameters (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes\n based on a specific number of instances. However, if you configure a mixed instances\n policy that defines weights for the instance types, you must specify these sizes\n with the same units that you use for weighting instances.
If you provide a list of instance types to use, you can specify the number of capacity\n units provided by each instance type in terms of virtual CPUs, memory, storage,\n throughput, or other relative performance characteristic. When a Spot or On-Demand\n Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling\n launches instances until the desired capacity is totally fulfilled, even if this results\n in an overage. For example, if there are two units remaining to fulfill capacity, and\n Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units,\n the instance is launched, and the desired capacity is exceeded by three units. For more\n information, see Configure an Auto Scaling group to use instance weights in the\n Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.
If you specify a value for WeightedCapacity for one instance type, you\n must specify a value for WeightedCapacity for all of them.
Every Auto Scaling group has three size parameters (DesiredCapacity,\n MaxSize, and MinSize). Usually, you set these sizes\n based on a specific number of instances. However, if you configure a mixed instances\n policy that defines weights for the instance types, you must specify these sizes\n with the same units that you use for weighting instances.
Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling\n uses to launch Amazon EC2 instances. For more information about launch templates, see Launch\n templates in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#LifecycleActionResult": { @@ -7369,7 +7369,7 @@ "RoleARN": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the\n Amazon EC2 Auto Scaling User Guide.
\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
" + "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target. For information about creating this role, see Prepare to\n add a lifecycle hook to your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nValid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
" } } }, @@ -8382,7 +8382,7 @@ "MaxCapacityBreachBehavior": { "target": "com.amazonaws.autoscaling#PredictiveScalingMaxCapacityBreachBehavior", "traits": { - "smithy.api#documentation": "Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity of the Auto Scaling group. Defaults to\n HonorMaxCapacity if not specified.
The following are possible values:
\n\n HonorMaxCapacity - Amazon EC2 Auto Scaling cannot scale out capacity higher than\n the maximum capacity. The maximum capacity is enforced as a hard limit.
\n IncreaseMaxCapacity - Amazon EC2 Auto Scaling can scale out capacity higher than\n the maximum capacity when the forecast capacity is close to or exceeds the\n maximum capacity. The upper limit is determined by the forecasted capacity and\n the value for MaxCapacityBuffer.
Defines the behavior that should be applied if the forecast capacity approaches or\n exceeds the maximum capacity of the Auto Scaling group. Defaults to\n HonorMaxCapacity if not specified.
The following are possible values:
\n\n HonorMaxCapacity - Amazon EC2 Auto Scaling can't increase the maximum capacity\n of the group when the forecast capacity is close to or exceeds the maximum\n capacity.
\n IncreaseMaxCapacity - Amazon EC2 Auto Scaling can increase the maximum capacity\n of the group when the forecast capacity is close to or exceeds the maximum\n capacity. The upper limit is determined by the forecasted capacity and the value\n for MaxCapacityBuffer.
Use caution when allowing the maximum capacity to be automatically increased. This\n can lead to more instances being launched than intended if the increased maximum\n capacity is not monitored and managed. The increased maximum capacity then becomes\n the new normal maximum capacity for the Auto Scaling group until you manually update\n it. The maximum capacity does not automatically decrease back to the original\n maximum.
\nDescribes a process type.
\nFor more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes a process type.
\nFor more information, see Types\n of processes in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#Processes": { @@ -8793,7 +8793,7 @@ } ], "traits": { - "smithy.api#documentation": "Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.
\nThis configuration overwrites any existing configuration.
\nFor more information, see Getting Amazon SNS\n notifications when your Auto Scaling group scales in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.
", + "smithy.api#documentation": "Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.
\nThis configuration overwrites any existing configuration.
\nFor more information, see Amazon SNS\n notification options for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.
", "smithy.api#examples": [ { "title": "To add an Auto Scaling notification", @@ -8944,7 +8944,7 @@ "Cooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "A cooldown period, in seconds, that applies to a specific simple scaling policy. When\n a cooldown period is specified here, it overrides the default cooldown.
\nValid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Default: None
" + "smithy.api#documentation": "A cooldown period, in seconds, that applies to a specific simple scaling policy. When\n a cooldown period is specified here, it overrides the default cooldown.
\nValid only if the policy type is SimpleScaling. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Default: None
" } }, "MetricAggregationType": { @@ -8974,7 +8974,7 @@ "Enabled": { "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", "traits": { - "smithy.api#documentation": "Indicates whether the scaling policy is enabled or disabled. The default is enabled.\n For more information, see Disabling a\n scaling policy for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Indicates whether the scaling policy is enabled or disabled. The default is enabled.\n For more information, see Disable a\n scaling policy for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "PredictiveScalingConfiguration": { @@ -9005,7 +9005,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a scheduled scaling action for an Auto Scaling group.
\nFor more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.
\nIf you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.
", + "smithy.api#documentation": "Creates or updates a scheduled scaling action for an Auto Scaling group.
\nFor more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nYou can view the scheduled actions for an Auto Scaling group using the DescribeScheduledActions API call. If you are no longer using a\n scheduled action, you can delete it by calling the DeleteScheduledAction API.
\nIf you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.
", "smithy.api#examples": [ { "title": "To add a scheduled action to an Auto Scaling group", @@ -9109,7 +9109,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity. For more information and example configurations, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nThis operation must be called from the Region in which the Auto Scaling group was created.\n This operation cannot be called on an Auto Scaling group that has a mixed instances policy or a\n launch template or launch configuration that requests Spot Instances.
\nYou 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\n DeleteWarmPool API.
", + "smithy.api#documentation": "Creates or updates a warm pool for the specified Auto Scaling group. A warm pool is a pool of\n pre-initialized EC2 instances that sits alongside the Auto Scaling group. Whenever your\n application needs to scale out, the Auto Scaling group can draw on the warm pool to meet its new\n desired capacity.
\nThis operation must be called from the Region in which the Auto Scaling group was\n created.
\nYou 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\n DeleteWarmPool API.
\nFor more information, see Warm pools for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To create a warm pool for an Auto Scaling group", @@ -9258,7 +9258,7 @@ "CheckpointPercentages": { "target": "com.amazonaws.autoscaling#CheckpointPercentages", "traits": { - "smithy.api#documentation": "(Optional) Threshold values for each checkpoint in ascending order. Each number must\n be unique. To replace all instances in the Auto Scaling group, the last number in the array must\n be 100.
For usage examples, see Adding\n checkpoints to an instance refresh in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "(Optional) Threshold values for each checkpoint in ascending order. Each number must\n be unique. To replace all instances in the Auto Scaling group, the last number in the array must\n be 100.
For usage examples, see Add checkpoints to an instance refresh in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "CheckpointDelay": { @@ -9386,7 +9386,7 @@ } ], "traits": { - "smithy.api#documentation": "Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.
\nFor more information, see Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.
\nFor more information, see Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To resume Auto Scaling processes", @@ -9960,7 +9960,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the size of the specified Auto Scaling group.
\nIf a scale-in activity occurs as a result of a new DesiredCapacity value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.
For more information, see Manual scaling in the\n Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Sets the size of the specified Auto Scaling group.
\nIf a scale-in activity occurs as a result of a new DesiredCapacity value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.
For more information, see Manual\n scaling in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To set the desired capacity for an Auto Scaling group", @@ -10015,7 +10015,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets the health status of the specified instance.
\nFor more information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Sets the health status of the specified instance.
\nFor more information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To set the health status of an instance", @@ -10050,7 +10050,7 @@ "ShouldRespectGracePeriod": { "target": "com.amazonaws.autoscaling#ShouldRespectGracePeriod", "traits": { - "smithy.api#documentation": "If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod\n specified for the group, by default, this call respects the grace period. Set this to\n False, to have the call not respect the grace period associated with\n the group.
For more information about the health check grace\n period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API\n Reference.
" + "smithy.api#documentation": "If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod\n specified for the group, by default, this call respects the grace period. Set this to\n False, to have the call not respect the grace period associated with\n the group.
For more information about the health check grace period, see Set the health check grace period for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } } } @@ -10072,7 +10072,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.
\nFor more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.
", + "smithy.api#documentation": "Updates the instance protection settings of the specified instances. This operation\n cannot be called on instances in a warm pool.
\nFor more information, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.
", "smithy.api#examples": [ { "title": "To enable instance protection for an instance", @@ -10321,7 +10321,7 @@ } ], "traits": { - "smithy.api#documentation": "Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.
\nIf you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
", + "smithy.api#documentation": "Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.
\nIf you suspend either the Launch or Terminate process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspend and resume\n Amazon EC2 Auto Scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
", "smithy.api#examples": [ { "title": "To suspend Auto Scaling processes", @@ -10353,7 +10353,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes an auto scaling process that has been suspended.
\nFor more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes an auto scaling process that has been suspended.
\nFor more information, see Types\n of processes in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#SuspendedProcesses": { @@ -10539,7 +10539,7 @@ "type": "structure", "members": { "Id": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "A short name that identifies the object's results in the response. This name must be\n unique among all TargetTrackingMetricDataQuery objects specified for a\n single scaling policy. If you are performing math expressions on this set of data, this\n name represents that data and can serve as a variable in the mathematical expression.\n The valid characters are letters, numbers, and underscores. The first character must be\n a lowercase letter.
Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.
\nThis call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.
\nBy default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Terminates the specified instance and optionally adjusts the desired group size. This\n operation cannot be called on instances in a warm pool.
\nThis call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated. You can't connect to or start an instance after you've\n terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.
\nBy default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Manual\n scaling in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#examples": [ { "title": "To terminate an instance in an Auto Scaling group", @@ -10843,7 +10843,7 @@ "DefaultCooldown": { "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "\n Only needed if you use simple scaling policies.\n
\nThe amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "\n Only needed if you use simple scaling policies.\n
\nThe amount of time, in seconds, between one scaling activity ending and another one\n starting due to simple scaling policies. For more information, see Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, "AvailabilityZones": { @@ -10855,7 +10855,7 @@ "HealthCheckType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "A comma-separated value string of one or more health check types.
\nThe valid values are EC2, ELB, and VPC_LATTICE.\n EC2 is the default health check and cannot be disabled. For more\n information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously\n set.
A comma-separated value string of one or more health check types.
\nThe valid values are EC2, ELB, and VPC_LATTICE.\n EC2 is the default health check and cannot be disabled. For more\n information, see Health checks\n for instances in an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
Only specify EC2 if you must clear a value that was previously\n set.
A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Work with\n Amazon EC2 Auto Scaling termination policies in the\n Amazon EC2 Auto Scaling User Guide.
\nValid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n
A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Configure\n termination policies for Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nValid values: Default | AllocationStrategy |\n ClosestToNextInstanceHour | NewestInstance |\n OldestInstance | OldestLaunchConfiguration |\n OldestLaunchTemplate |\n arn:aws:lambda:region:account-id:function:my-function:my-alias\n
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Using\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Use\n instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "ServiceLinkedRoleARN": { @@ -10915,7 +10915,7 @@ "DesiredCapacityType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Creating\n an Auto Scaling group using attribute-based instance type selection in the\n Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.
Valid values: units | vcpu | memory-mib\n
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling\n supports DesiredCapacityType for attribute-based instance type selection\n only. For more information, see Create a mixed instances group using attribute-based instance type\n selection in the Amazon EC2 Auto Scaling User Guide.
By default, Amazon EC2 Auto Scaling specifies units, which translates into number of\n instances.
Valid values: units | vcpu | memory-mib\n
The timestamp when the attachment was last updated.
" } + }, + "LastModificationErrors": { + "target": "com.amazonaws.networkmanager#AttachmentErrorList", + "traits": { + "smithy.api#documentation": "Describes the error associated with the attachment request.
" + } } }, "traits": { "smithy.api#documentation": "Describes a core network attachment.
" } }, + "com.amazonaws.networkmanager#AttachmentError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.networkmanager#AttachmentErrorCode", + "traits": { + "smithy.api#documentation": "The error code for the attachment request.
" + } + }, + "Message": { + "target": "com.amazonaws.networkmanager#ServerSideString", + "traits": { + "smithy.api#documentation": "The message associated with the error code.
The ARN of the requested attachment resource.
" + } + }, + "RequestId": { + "target": "com.amazonaws.networkmanager#ServerSideString", + "traits": { + "smithy.api#documentation": "The ID of the attachment request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the error associated with an attachment request.
" + } + }, + "com.amazonaws.networkmanager#AttachmentErrorCode": { + "type": "enum", + "members": { + "VPC_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_NOT_FOUND" + } + }, + "SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_NOT_FOUND" + } + }, + "SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE" + } + }, + "SUBNET_NO_FREE_ADDRESSES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_NO_FREE_ADDRESSES" + } + }, + "SUBNET_UNSUPPORTED_AVAILABILITY_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_UNSUPPORTED_AVAILABILITY_ZONE" + } + }, + "SUBNET_NO_IPV6_CIDRS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_NO_IPV6_CIDRS" + } + }, + "VPN_CONNECTION_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPN_CONNECTION_NOT_FOUND" + } + }, + "MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED" + } + } + } + }, + "com.amazonaws.networkmanager#AttachmentErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#AttachmentError" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.networkmanager#AttachmentId": { "type": "string", "traits": { @@ -1082,6 +1185,12 @@ "traits": { "smithy.api#documentation": "The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.
" } + }, + "LastModificationErrors": { + "target": "com.amazonaws.networkmanager#ConnectPeerErrorList", + "traits": { + "smithy.api#documentation": "Describes the error associated with the attachment request.
" + } } }, "traits": { @@ -1237,6 +1346,91 @@ "smithy.api#documentation": "Describes a core network Connect peer configuration.
" } }, + "com.amazonaws.networkmanager#ConnectPeerError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.networkmanager#ConnectPeerErrorCode", + "traits": { + "smithy.api#documentation": "The error code for the Connect peer request.
" + } + }, + "Message": { + "target": "com.amazonaws.networkmanager#ServerSideString", + "traits": { + "smithy.api#documentation": "The message associated with the error code.
The ARN of the requested Connect peer resource.
" + } + }, + "RequestId": { + "target": "com.amazonaws.networkmanager#ServerSideString", + "traits": { + "smithy.api#documentation": "The ID of the Connect peer request.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an error associated with a Connect peer request
" + } + }, + "com.amazonaws.networkmanager#ConnectPeerErrorCode": { + "type": "enum", + "members": { + "EDGE_LOCATION_NO_FREE_IPS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EDGE_LOCATION_NO_FREE_IPS" + } + }, + "EDGE_LOCATION_PEER_DUPLICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EDGE_LOCATION_PEER_DUPLICATE" + } + }, + "SUBNET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUBNET_NOT_FOUND" + } + }, + "IP_OUTSIDE_SUBNET_CIDR_RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IP_OUTSIDE_SUBNET_CIDR_RANGE" + } + }, + "INVALID_INSIDE_CIDR_BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_INSIDE_CIDR_BLOCK" + } + }, + "NO_ASSOCIATED_CIDR_BLOCK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_ASSOCIATED_CIDR_BLOCK" + } + } + } + }, + "com.amazonaws.networkmanager#ConnectPeerErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#ConnectPeerError" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.networkmanager#ConnectPeerId": { "type": "string", "traits": { @@ -10043,12 +10237,109 @@ "traits": { "smithy.api#documentation": "The timestamp when the attachment peer was created.
" } + }, + "LastModificationErrors": { + "target": "com.amazonaws.networkmanager#PeeringErrorList", + "traits": { + "smithy.api#documentation": "Describes the error associated with the Connect peer request.
" + } } }, "traits": { "smithy.api#documentation": "Describes a peering connection.
" } }, + "com.amazonaws.networkmanager#PeeringError": { + "type": "structure", + "members": { + "Code": { + "target": "com.amazonaws.networkmanager#PeeringErrorCode", + "traits": { + "smithy.api#documentation": "The error code for the peering request.
" + } + }, + "Message": { + "target": "com.amazonaws.networkmanager#ServerSideString", + "traits": { + "smithy.api#documentation": "The message associated with the error code.
The ARN of the requested peering resource.
" + } + }, + "RequestId": { + "target": "com.amazonaws.networkmanager#ServerSideString", + "traits": { + "smithy.api#documentation": "The ID of the Peering request.
" + } + }, + "MissingPermissionsContext": { + "target": "com.amazonaws.networkmanager#PermissionsErrorContext", + "traits": { + "smithy.api#documentation": "Provides additional information about missing permissions for the peering\n error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes an error associated with a peering request.
" + } + }, + "com.amazonaws.networkmanager#PeeringErrorCode": { + "type": "enum", + "members": { + "TRANSIT_GATEWAY_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_NOT_FOUND" + } + }, + "TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED" + } + }, + "MISSING_REQUIRED_PERMISSIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_PERMISSIONS" + } + }, + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "EDGE_LOCATION_PEER_DUPLICATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EDGE_LOCATION_PEER_DUPLICATE" + } + }, + "INVALID_TRANSIT_GATEWAY_STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_TRANSIT_GATEWAY_STATE" + } + } + } + }, + "com.amazonaws.networkmanager#PeeringErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.networkmanager#PeeringError" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.networkmanager#PeeringId": { "type": "string", "traits": { @@ -10105,6 +10396,20 @@ } } }, + "com.amazonaws.networkmanager#PermissionsErrorContext": { + "type": "structure", + "members": { + "MissingPermission": { + "target": "com.amazonaws.networkmanager#ServerSideString", + "traits": { + "smithy.api#documentation": "The missing permissions.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes additional information about missing permissions.
" + } + }, "com.amazonaws.networkmanager#ProposedNetworkFunctionGroupChange": { "type": "structure", "members": { diff --git a/codegen/sdk-codegen/aws-models/workspaces-thin-client.json b/codegen/sdk-codegen/aws-models/workspaces-thin-client.json index 5b1c36302b9..20322a9b476 100644 --- a/codegen/sdk-codegen/aws-models/workspaces-thin-client.json +++ b/codegen/sdk-codegen/aws-models/workspaces-thin-client.json @@ -196,6 +196,12 @@ "traits": { "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the resource.
" } + }, + "deviceCreationTags": { + "target": "com.amazonaws.workspacesthinclient#DeviceCreationTagsMap", + "traits": { + "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
" + } } }, "traits": { @@ -665,6 +671,42 @@ "smithy.api#documentation": "Describes a thin client device.
" } }, + "com.amazonaws.workspacesthinclient#DeviceCreationTagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(?!aws:)[A-Za-z0-9 _=@:.+-/]+$" + } + }, + "com.amazonaws.workspacesthinclient#DeviceCreationTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9 _=@:.+-/]+$" + } + }, + "com.amazonaws.workspacesthinclient#DeviceCreationTagsMap": { + "type": "map", + "key": { + "target": "com.amazonaws.workspacesthinclient#DeviceCreationTagKey" + }, + "value": { + "target": "com.amazonaws.workspacesthinclient#DeviceCreationTagValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + }, + "smithy.api#sensitive": {} + } + }, "com.amazonaws.workspacesthinclient#DeviceId": { "type": "string", "traits": { @@ -950,6 +992,12 @@ "traits": { "smithy.api#documentation": "The tag keys and optional values for the resource.
" } + }, + "deviceCreationTags": { + "target": "com.amazonaws.workspacesthinclient#DeviceCreationTagsMap", + "traits": { + "smithy.api#documentation": "\"The tag keys and optional values for the newly created devices for this environment.\"
" + } } }, "traits": { @@ -3167,6 +3215,12 @@ "traits": { "smithy.api#documentation": "The ID of the software set to apply.
" } + }, + "deviceCreationTags": { + "target": "com.amazonaws.workspacesthinclient#DeviceCreationTagsMap", + "traits": { + "smithy.api#documentation": "A map of the key-value pairs of the tag or tags to assign to the newly created devices for this environment.
" + } } }, "traits": {