|
4178 | 4178 | "target": "com.amazonaws.batch#ImageType",
|
4179 | 4179 | "traits": {
|
4180 | 4180 | "smithy.api#clientOptional": {},
|
4181 |
| - "smithy.api#documentation": "<p>The image type to match with the instance type to select an AMI. The supported values are\n different for <code>ECS</code> and <code>EKS</code> resources.</p>\n <dl>\n <dt>ECS</dt>\n <dd>\n <p>If the <code>imageIdOverride</code> parameter isn't specified, then a recent <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami\">Amazon ECS-optimized Amazon Linux 2 AMI</a> (<code>ECS_AL2</code>) is used. If a new image type is\n specified in an update, but neither an <code>imageId</code> nor a <code>imageIdOverride</code>\n parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's\n supported by Batch is used.</p>\n <dl>\n <dt>ECS_AL2</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami\">Amazon Linux\n 2</a>: Default for all non-GPU instance families.</p>\n </dd>\n <dt>ECS_AL2_NVIDIA</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami\">Amazon Linux 2\n (GPU)</a>: Default for all GPU instance families (for example <code>P4</code> and\n <code>G4</code>) and can be used for all non Amazon Web Services Graviton-based instance types.</p>\n </dd>\n <dt>ECS_AL2023</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon Linux 2023</a>: Batch\n supports Amazon Linux 2023.</p>\n <note>\n <p>Amazon Linux 2023 does not support <code>A1</code> instances.</p>\n </note>\n </dd>\n <dt>ECS_AL1</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami\">Amazon Linux</a>. Amazon Linux has\n reached the end-of-life of standard support. For more information, see <a href=\"http://aws.amazon.com/amazon-linux-ami/\">Amazon Linux AMI</a>.</p>\n </dd>\n </dl>\n </dd>\n <dt>EKS</dt>\n <dd>\n <p>If the <code>imageIdOverride</code> parameter isn't specified, then a recent <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html\">Amazon EKS-optimized Amazon Linux\n AMI</a> (<code>EKS_AL2</code>) is used. If a new image type is specified in an update,\n but neither an <code>imageId</code> nor a <code>imageIdOverride</code> parameter is specified,\n then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.</p>\n <dl>\n <dt>EKS_AL2</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html\">Amazon\n Linux 2</a>: Default for all non-GPU instance families.</p>\n </dd>\n <dt>EKS_AL2_NVIDIA</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html\">Amazon\n Linux 2 (accelerated)</a>: Default for all GPU instance families (for example,\n <code>P4</code> and <code>G4</code>) and can be used for all non Amazon Web Services Graviton-based\n instance types.</p>\n </dd>\n </dl>\n </dd>\n </dl>", |
| 4181 | + "smithy.api#documentation": "<p>The image type to match with the instance type to select an AMI. The supported values are\n different for <code>ECS</code> and <code>EKS</code> resources.</p>\n <dl>\n <dt>ECS</dt>\n <dd>\n <p>If the <code>imageIdOverride</code> parameter isn't specified, then a recent <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami\">Amazon ECS-optimized Amazon Linux 2 AMI</a> (<code>ECS_AL2</code>) is used. If a new image type is\n specified in an update, but neither an <code>imageId</code> nor a <code>imageIdOverride</code>\n parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's\n supported by Batch is used.</p>\n <dl>\n <dt>ECS_AL2</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#al2ami\">Amazon Linux\n 2</a>: Default for all non-GPU instance families.</p>\n </dd>\n <dt>ECS_AL2_NVIDIA</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#gpuami\">Amazon Linux 2\n (GPU)</a>: Default for all GPU instance families (for example <code>P4</code> and\n <code>G4</code>) and can be used for all non Amazon Web Services Graviton-based instance types.</p>\n </dd>\n <dt>ECS_AL2023</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html\">Amazon Linux 2023</a>: Batch\n supports Amazon Linux 2023.</p>\n <note>\n <p>Amazon Linux 2023 does not support <code>A1</code> instances.</p>\n </note>\n </dd>\n <dt>ECS_AL1</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html#alami\">Amazon Linux</a>. Amazon Linux has\n reached the end-of-life of standard support. For more information, see <a href=\"http://aws.amazon.com/amazon-linux-ami/\">Amazon Linux AMI</a>.</p>\n </dd>\n </dl>\n </dd>\n <dt>EKS</dt>\n <dd>\n <p>If the <code>imageIdOverride</code> parameter isn't specified, then a recent <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html\">Amazon EKS-optimized Amazon Linux\n AMI</a> (<code>EKS_AL2</code>) is used. If a new image type is specified in an update,\n but neither an <code>imageId</code> nor a <code>imageIdOverride</code> parameter is specified,\n then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.</p>\n <dl>\n <dt>EKS_AL2</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html\">Amazon\n Linux 2</a>: Default for all non-GPU instance families.</p>\n </dd>\n <dt>EKS_AL2_NVIDIA</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html\">Amazon\n Linux 2 (accelerated)</a>: Default for all GPU instance families (for example,\n <code>P4</code> and <code>G4</code>) and can be used for all non Amazon Web Services Graviton-based\n instance types.</p>\n </dd>\n <dt>EKS_AL2023</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html\">Amazon\n Linux 2023</a>: Batch supports Amazon Linux 2023.</p>\n <note>\n <p>Amazon Linux 2023 does not support <code>A1</code> instances.</p>\n </note>\n </dd>\n <dt>EKS_AL2023_NVIDIA</dt>\n <dd>\n <p>\n <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html\">Amazon\n Linux 2023 (accelerated)</a>: GPU instance families and can be used for all non Amazon Web Services\n Graviton-based instance types.</p>\n </dd>\n </dl>\n </dd>\n </dl>", |
4182 | 4182 | "smithy.api#required": {}
|
4183 | 4183 | }
|
4184 | 4184 | },
|
|
6396 | 6396 | "traits": {
|
6397 | 6397 | "smithy.api#documentation": "<p>A launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both.</p>\n <p>You can specify up to ten (10) launch template overrides that are associated to unique instance types or families for each compute environment.</p>\n <note>\n <p>To unset all override templates for a compute environment, you can pass an empty array to the <a href=\"https://docs.aws.amazon.com/batch/latest/APIReference/API_UpdateComputeEnvironment.html\">UpdateComputeEnvironment.overrides</a> parameter, or not include the <code>overrides</code> parameter when submitting the <code>UpdateComputeEnvironment</code> API operation.</p>\n </note>"
|
6398 | 6398 | }
|
| 6399 | + }, |
| 6400 | + "userdataType": { |
| 6401 | + "target": "com.amazonaws.batch#UserdataType", |
| 6402 | + "traits": { |
| 6403 | + "smithy.api#documentation": "<p>The EKS node initialization process to use. You only need to specify this value if you are\n using a custom AMI. The default value is <code>EKS_BOOTSTRAP_SH</code>. If\n <i>imageType</i> is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you\n must choose <code>EKS_NODEADM</code>.</p>" |
| 6404 | + } |
6399 | 6405 | }
|
6400 | 6406 | },
|
6401 | 6407 | "traits": {
|
|
6428 | 6434 | "traits": {
|
6429 | 6435 | "smithy.api#documentation": "<p>The instance type or family that this override launch template should be applied to.</p>\n <p>This parameter is required when defining a launch template override.</p>\n <p>Information included in this parameter must meet the following requirements:</p>\n <ul>\n <li>\n <p>Must be a valid Amazon EC2 instance type or family.</p>\n </li>\n <li>\n <p>\n <code>optimal</code> isn't allowed.</p>\n </li>\n <li>\n <p>\n <code>targetInstanceTypes</code> can target only instance types and families that are included within the <a href=\"https://docs.aws.amazon.com/batch/latest/APIReference/API_ComputeResource.html#Batch-Type-ComputeResource-instanceTypes\">\n <code>ComputeResource.instanceTypes</code>\n </a> set. <code>targetInstanceTypes</code> doesn't need to include all of the instances from the <code>instanceType</code> set, but at least a subset. For example, if <code>ComputeResource.instanceTypes</code> includes <code>[m5, g5]</code>, <code>targetInstanceTypes</code> can include <code>[m5.2xlarge]</code> and <code>[m5.large]</code> but not <code>[c5.large]</code>.</p>\n </li>\n <li>\n <p>\n <code>targetInstanceTypes</code> included within the same launch template override or across launch template overrides can't overlap for the same compute environment. For example, you can't define one launch template override to target an instance family and another define an instance type within this same family.</p>\n </li>\n </ul>"
|
6430 | 6436 | }
|
| 6437 | + }, |
| 6438 | + "userdataType": { |
| 6439 | + "target": "com.amazonaws.batch#UserdataType", |
| 6440 | + "traits": { |
| 6441 | + "smithy.api#documentation": "<p>The EKS node initialization process to use. You only need to specify this value if you are\n using a custom AMI. The default value is <code>EKS_BOOTSTRAP_SH</code>. If\n <i>imageType</i> is a custom AMI based on EKS_AL2023 or EKS_AL2023_NVIDIA then you\n must choose <code>EKS_NODEADM</code>.</p>" |
| 6442 | + } |
6431 | 6443 | }
|
6432 | 6444 | },
|
6433 | 6445 | "traits": {
|
|
9251 | 9263 | "terminateJobsOnUpdate": {
|
9252 | 9264 | "target": "com.amazonaws.batch#Boolean",
|
9253 | 9265 | "traits": {
|
9254 |
| - "smithy.api#documentation": "<p>Specifies whether jobs are automatically terminated when the computer environment\n infrastructure is updated. The default value is <code>false</code>.</p>" |
| 9266 | + "smithy.api#documentation": "<p>Specifies whether jobs are automatically terminated when the compute environment\n infrastructure is updated. The default value is <code>false</code>.</p>" |
9255 | 9267 | }
|
9256 | 9268 | },
|
9257 | 9269 | "jobExecutionTimeoutMinutes": {
|
|
9320 | 9332 | "smithy.api#output": {}
|
9321 | 9333 | }
|
9322 | 9334 | },
|
| 9335 | + "com.amazonaws.batch#UserdataType": { |
| 9336 | + "type": "enum", |
| 9337 | + "members": { |
| 9338 | + "EKS_BOOTSTRAP_SH": { |
| 9339 | + "target": "smithy.api#Unit", |
| 9340 | + "traits": { |
| 9341 | + "smithy.api#enumValue": "EKS_BOOTSTRAP_SH" |
| 9342 | + } |
| 9343 | + }, |
| 9344 | + "EKS_NODEADM": { |
| 9345 | + "target": "smithy.api#Unit", |
| 9346 | + "traits": { |
| 9347 | + "smithy.api#enumValue": "EKS_NODEADM" |
| 9348 | + } |
| 9349 | + } |
| 9350 | + } |
| 9351 | + }, |
9323 | 9352 | "com.amazonaws.batch#Volume": {
|
9324 | 9353 | "type": "structure",
|
9325 | 9354 | "members": {
|
|
0 commit comments