|
1012 | 1012 | "ComputeResourceUpdate$launchTemplate": "<p>The updated launch template to use for your compute resources. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html\">Launch template support</a> in the <i>Batch User Guide</i>. To remove the custom launch template and use the default launch template, set <code>launchTemplateId</code> or <code>launchTemplateName</code> member of the launch template specification to an empty string. Removing the launch template from a compute environment will not remove the AMI specified in the launch template. In order to update the AMI specified in a launch template, the <code>updateToLatestImageVersion</code> parameter must be set to <code>true</code>.</p> <p>When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html\">Updating compute environments</a> in the <i>Batch User Guide</i>.</p> <note> <p>This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.</p> </note>" |
1013 | 1013 | } |
1014 | 1014 | }, |
| 1015 | + "LaunchTemplateSpecificationOverride": { |
| 1016 | + "base": "<p>An object that represents 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> <p>If security groups are specified using both the <code>securityGroupIds</code> parameter of <code>CreateComputeEnvironment</code> and the launch template, the values in the <code>securityGroupIds</code> parameter of <code>CreateComputeEnvironment</code> will be used.</p> <p>You can define up to ten (10) overrides for each compute environment.</p> <note> <p>This object isn't applicable to jobs that are running on Fargate resources.</p> </note> <note> <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> </note>", |
| 1017 | + "refs": { |
| 1018 | + "LaunchTemplateSpecificationOverrideList$member": null |
| 1019 | + } |
| 1020 | + }, |
| 1021 | + "LaunchTemplateSpecificationOverrideList": { |
| 1022 | + "base": null, |
| 1023 | + "refs": { |
| 1024 | + "LaunchTemplateSpecification$overrides": "<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> <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> <note> <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> </note>" |
| 1025 | + } |
| 1026 | + }, |
1015 | 1027 | "LinuxParameters": { |
1016 | 1028 | "base": "<p>Linux-specific modifications that are applied to the container, such as details for device mappings.</p>", |
1017 | 1029 | "refs": { |
|
1558 | 1570 | "KeyValuesPair$name": "<p>The name of the filter. Filter names are case sensitive.</p>", |
1559 | 1571 | "LaunchTemplateSpecification$launchTemplateId": "<p>The ID of the launch template.</p>", |
1560 | 1572 | "LaunchTemplateSpecification$launchTemplateName": "<p>The name of the launch template.</p>", |
1561 | | - "LaunchTemplateSpecification$version": "<p>The version number of the launch template, <code>$Latest</code>, or <code>$Default</code>.</p> <p>If the value is <code>$Latest</code>, the latest version of the launch template is used. If the value is <code>$Default</code>, the default version of the launch template is used.</p> <important> <p>If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the <code>updateToLatestImageVersion</code> parameter for the compute environment is set to <code>true</code>. During an infrastructure update, if either <code>$Latest</code> or <code>$Default</code> is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html\">Updating compute environments</a> in the <i>Batch User Guide</i>.</p> </important> <p>Default: <code>$Default</code>.</p>", |
| 1573 | + "LaunchTemplateSpecification$version": "<p>The version number of the launch template, <code>$Default</code>, or <code>$Latest</code>.</p> <p>If the value is <code>$Default</code>, the default version of the launch template is used. If the value is <code>$Latest</code>, the latest version of the launch template is used. </p> <important> <p>If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the <code>updateToLatestImageVersion</code> parameter for the compute environment is set to <code>true</code>. During an infrastructure update, if either <code>$Default</code> or <code>$Latest</code> is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html\">Updating compute environments</a> in the <i>Batch User Guide</i>.</p> </important> <p>Default: <code>$Default</code> </p> <p>Latest: <code>$Latest</code> </p>", |
| 1574 | + "LaunchTemplateSpecificationOverride$launchTemplateId": "<p>The ID of the launch template.</p> <p> <b>Note:</b> If you specify the <code>launchTemplateId</code> you can't specify the <code>launchTemplateName</code> as well.</p>", |
| 1575 | + "LaunchTemplateSpecificationOverride$launchTemplateName": "<p>The name of the launch template.</p> <p> <b>Note:</b> If you specify the <code>launchTemplateName</code> you can't specify the <code>launchTemplateId</code> as well.</p>", |
| 1576 | + "LaunchTemplateSpecificationOverride$version": "<p>The version number of the launch template, <code>$Default</code>, or <code>$Latest</code>.</p> <p>If the value is <code>$Default</code>, the default version of the launch template is used. If the value is <code>$Latest</code>, the latest version of the launch template is used. </p> <important> <p>If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the <code>updateToLatestImageVersion</code> parameter for the compute environment is set to <code>true</code>. During an infrastructure update, if either <code>$Default</code> or <code>$Latest</code> is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/updating-compute-environments.html\">Updating compute environments</a> in the <i>Batch User Guide</i>.</p> </important> <p>Default: <code>$Default</code> </p> <p>Latest: <code>$Latest</code> </p>", |
1562 | 1577 | "ListJobsRequest$jobQueue": "<p>The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.</p>", |
1563 | 1578 | "ListJobsRequest$arrayJobId": "<p>The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.</p>", |
1564 | 1579 | "ListJobsRequest$multiNodeJobId": "<p>The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.</p>", |
|
1656 | 1671 | "EksContainerOverride$command": "<p>The command to send to the container that overrides the default command from the Docker image or the job definition.</p>", |
1657 | 1672 | "EksContainerOverride$args": "<p>The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">Dockerfile reference: CMD</a> and <a href=\"https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/\">Define a command an arguments for a pod</a> in the <i>Kubernetes documentation</i>.</p>", |
1658 | 1673 | "KeyValuesPair$values": "<p>The filter values.</p>", |
| 1674 | + "LaunchTemplateSpecificationOverride$targetInstanceTypes": "<p>The instance type or family that this this override launch template should be applied to.</p> <p>This parameter is required when defining a launch template override.</p> <p>Information included in this parameter must meet the following requirements:</p> <ul> <li> <p>Must be a valid Amazon EC2 instance type or family.</p> </li> <li> <p> <code>optimal</code> isn't allowed.</p> </li> <li> <p> <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\"> <code>ComputeResource.instanceTypes</code> </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> </li> <li> <p> <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> </li> </ul>", |
1659 | 1675 | "NodePropertyOverride$instanceTypes": "<p>An object that contains the instance types that you want to replace for the existing resources of a job.</p>", |
1660 | 1676 | "NodeRangeProperty$instanceTypes": "<p>The instance types of the underlying host infrastructure of a multi-node parallel job.</p> <note> <p>This parameter isn't applicable to jobs that are running on Fargate resources.</p> <p>In addition, this list object is currently limited to one element.</p> </note>", |
1661 | 1677 | "TaskContainerDetails$command": "<p>The command that's passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>", |
|
0 commit comments