Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or
- * RUNNABLE state are canceled. Jobs that progressed to the STARTING or RUNNING
- * state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be
- * terminated with the TerminateJob operation.
Cancels a job in an Batch job queue. Jobs that are in the
+ * SUBMITTED
+ * or
+ * PENDING
+ * are
+ * canceled. A job
+ * inRUNNABLE remains in RUNNABLE until it reaches the head of the
+ * job queue. Then the job status is updated to
+ * FAILED.
Jobs that progressed to the STARTING or
+ * RUNNING state aren't canceled. However, the API operation still succeeds, even
+ * if no job is canceled. These jobs must be terminated with the TerminateJob
+ * operation.
Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or
- * RUNNABLE state are canceled. Jobs that progressed to the STARTING or RUNNING
- * state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be
- * terminated with the TerminateJob operation.
Cancels a job in an Batch job queue. Jobs that are in the
+ * SUBMITTED
+ * or
+ * PENDING
+ * are
+ * canceled. A job
+ * inRUNNABLE remains in RUNNABLE until it reaches the head of the
+ * job queue. Then the job status is updated to
+ * FAILED.
Jobs that progressed to the STARTING or
+ * RUNNING state aren't canceled. However, the API operation still succeeds, even
+ * if no job is canceled. These jobs must be terminated with the TerminateJob
+ * operation.
A summary of the number of array job children in each available job status. This parameter is returned for - * parent array jobs.
+ *A summary of the number of array job children in each available job status. This parameter + * is returned for parent array jobs.
*/ statusSummary?: RecordThe job index within the array that's associated with this job. This parameter is returned for array job - * children.
+ *The job index within the array that's associated with this job. This parameter is returned + * for array job children.
*/ index?: number; } @@ -56,8 +56,8 @@ export interface ArrayPropertiesSummary { size?: number; /** - *The job index within the array that's associated with this job. This parameter is returned for children of array - * jobs.
+ *The job index within the array that's associated with this job. This parameter is returned + * for children of array jobs.
*/ index?: number; } @@ -72,7 +72,8 @@ export enum AssignPublicIp { /** * @public - *An object that represents the elastic network interface for a multi-node parallel job node.
+ *An object that represents the elastic network interface for a multi-node parallel job + * node.
*/ export interface NetworkInterface { /** @@ -102,8 +103,8 @@ export interface AttemptContainerDetail { containerInstanceArn?: string; /** - *The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container attempt receives a task
- * ARN when they reach the STARTING status.
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container
+ * attempt receives a task ARN when they reach the STARTING status.
A short (255 max characters) human-readable string to provide additional details for a running or stopped - * container.
+ *A short (255 max characters) human-readable string to provide additional details for a + * running or stopped container.
*/ reason?: string; /** - *The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs
- * is /aws/batch/job. Each container attempt receives a log stream name when they reach the
- * RUNNING status.
The name of the CloudWatch Logs log stream that's associated with the container. The log
+ * group for Batch jobs is /aws/batch/job. Each container attempt receives a log
+ * stream name when they reach the RUNNING status.
The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the
- * STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt
+ * transitioned from the STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the
- * RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt
+ * transitioned from the RUNNING state to a terminal state, such as
+ * SUCCEEDED or FAILED).
A short, human-readable string to provide additional details for the current status of the job attempt.
+ *A short, human-readable string to provide additional details for the current status of the + * job attempt.
*/ statusReason?: string; } @@ -235,63 +238,66 @@ export enum CRAllocationStrategy { /** * @public - *Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If
- * Ec2Configuration isn't specified, the default is ECS_AL2 (Amazon Linux 2).
Provides information used to select Amazon Machine Images (AMIs) for instances in the
+ * compute environment. If Ec2Configuration isn't specified, the default is
+ * ECS_AL2 (Amazon Linux 2).
This object isn't applicable to jobs that are running on Fargate resources.
*The image type to match with the instance type to select an AMI. The supported values are different for
- * ECS and EKS resources.
The image type to match with the instance type to select an AMI. The supported values are
+ * different for ECS and EKS resources.
If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI
- * (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId
- * nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type
- * that's supported by Batch is used.
If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is
+ * specified in an update, but neither an imageId nor a imageIdOverride
+ * parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's
+ * supported by Batch is used.
- * Amazon - * Linux 2: Default for all non-GPU instance families.
+ * Amazon Linux + * 2: Default for all non-GPU instance families. *
- * Amazon
- * Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4)
- * and can be used for all non Amazon Web Services Graviton-based instance types.
P4 and
+ * G4) and can be used for all non Amazon Web Services Graviton-based instance types.
* - * Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.
+ * Amazon Linux. Amazon Linux has + * reached the end-of-life of standard support. For more information, see Amazon Linux AMI. *If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI
- * (EKS_AL2) is used. If a new image type is specified in an update, but neither an imageId
- * nor a imageIdOverride parameter is specified, then the latest Amazon EKS optimized AMI for that image type
- * that Batch supports is used.
If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux
+ * AMI (EKS_AL2) is used. If a new image type is specified in an update,
+ * but neither an imageId nor a imageIdOverride parameter is specified,
+ * then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.
* Amazon - * Linux 2: Default for all non-GPU instance families.
+ * Linux 2: Default for all non-GPU instance families. *
- * Amazon Linux 2
- * (accelerated): Default for all GPU instance families (for example, P4 and
- * G4) and can be used for all non Amazon Web Services Graviton-based instance types.
P4 and G4) and can be used for all non Amazon Web Services Graviton-based
+ * instance types.
* The AMI ID used for instances launched in the compute environment that match the image type. This setting
- * overrides the imageId set in the computeResource object.
The AMI ID used for instances launched in the compute environment that match the image type.
+ * This setting overrides the imageId set in the computeResource
+ * object.
The AMI that you choose for a compute environment must match the architecture of the instance types that * you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, @@ -314,19 +321,21 @@ export interface Ec2Configuration { imageIdOverride?: string; /** - *
The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch - * supports is used.
+ *The Kubernetes version for the compute environment. If you don't specify a value, the latest + * version that Batch supports is used.
*/ imageKubernetesVersion?: string; } /** * @public - *An object that represents a launch template that's associated with a compute resource. You must specify either - * the launch template ID or launch template name in the request, but not both.
+ *An object that represents a launch template that's associated with a compute resource. You + * must specify either the launch template ID or launch template name in the request, but not + * both.
*If security groups are specified using both the securityGroupIds parameter of
- * CreateComputeEnvironment and the launch template, the values in the securityGroupIds
- * parameter of CreateComputeEnvironment will be used.
CreateComputeEnvironment and the launch template, the values in the
+ * securityGroupIds parameter of CreateComputeEnvironment will be
+ * used.
* This object isn't applicable to jobs that are running on Fargate resources.
*The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is used. If the value is
- * $Default, the default version of the launch template is used.
The version number of the launch template, $Latest, or
+ * $Default.
If the value is $Latest, the latest version of the launch template is used. If
+ * the value is $Default, the default version of the launch template is used.
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 updateToLatestImageVersion parameter for the
- * compute environment is set to true. During an infrastructure update, if either $Latest or
- * $Default 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 Updating compute environments in the
- * Batch User Guide.
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
+ * updateToLatestImageVersion parameter for the compute environment is set to
+ * true. During an infrastructure update, if either $Latest or
+ * $Default 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
+ * Updating compute
+ * environments in the Batch User Guide.
Default: $Default.
An object that represents an Batch compute resource. For more information, see Compute environments in the - * Batch User Guide.
+ *An object that represents an Batch compute resource. For more information, see Compute environments in + * the Batch User Guide.
*/ export interface ComputeResource { /** - *The type of compute environment: EC2, SPOT, FARGATE, or
- * FARGATE_SPOT. For more information, see Compute environments in the
- * Batch User Guide.
The type of compute environment: EC2, SPOT, FARGATE,
+ * or FARGATE_SPOT. For more information, see Compute environments in the
+ * Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
- * spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the
- * Batch User Guide.
spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the
+ * Batch User Guide.
*/
type: CRType | string | undefined;
/**
- * The allocation strategy to use for the compute resource if not enough instances of the best fitting instance - * type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more - * information, see Allocation strategies - * in the Batch User Guide.
+ *The allocation strategy to use for the compute resource if not enough instances of the best + * fitting instance type can be allocated. This might be because of availability of the instance + * type in the Region or Amazon EC2 service limits. For more + * information, see Allocation strategies in the Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost
- * instance type. If additional instances of the selected instance type aren't available, Batch waits for the
- * additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service limits,
- * additional jobs aren't run until the currently running jobs are completed. This allocation strategy keeps costs
- * lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must
- * be specified. Compute resources that use a BEST_FIT allocation strategy don't support infrastructure
- * updates and can't update some parameters. For more information, see Updating compute environments in the
- * Batch User Guide.
Batch selects an instance type that best fits the needs of the jobs with a preference
+ * for the lowest-cost instance type. If additional instances of the selected instance type
+ * aren't available, Batch waits for the additional instances to be available. If there aren't
+ * enough instances available or the user is reaching Amazon EC2 service limits,
+ * additional jobs aren't run until the currently running jobs are completed. This allocation
+ * strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with
+ * BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use
+ * a BEST_FIT allocation strategy don't support infrastructure updates and can't
+ * update some parameters. For more information, see Updating compute environments in
+ * the Batch User Guide.
Batch selects additional instance types that are large enough to meet the requirements of the jobs in the - * queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously - * selected instance types aren't available, Batch selects new instance types.
+ *Batch selects additional instance types that are large enough to meet the requirements + * of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If + * additional instances of the previously selected instance types aren't available, Batch + * selects new instance types.
*Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the - * queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is - * only available for Spot Instance compute resources.
+ *Batch selects one or more instance types that are large enough to meet the requirements + * of the jobs in the queue. Its preference is for instance types that are less likely to be + * interrupted. This allocation strategy is only available for Spot Instance compute + * resources.
*With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using On-Demand
- * or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed
- * maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus
- * by more than a single instance.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED
+ * strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot
+ * Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.
+ * In this event, Batch never exceeds maxvCpus by more than a single instance.
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is
- * DISABLED).
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute
+ * environment is DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
*With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies
- * using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never
- * exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among
- * those specified in your compute environment is allocated.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED
+ * allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy
+ * using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity
+ * requirements. In this event, Batch never exceeds maxvCpus by more than a single
+ * instance. For example, no more than a single instance from among those specified in your compute
+ * environment is allocated.
The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum - * and maximum values based on job queue demand.
+ *The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value + * between the minimum and maximum values based on job queue demand.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The instances types that can be launched. You can specify instance families to launch any instance type within
- * those families (for example, c5 or p3), or you can specify specific sizes within a family
- * (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,
- * M4, and R4 instance families) that match the demand of your job queues.
The instances types that can be launched. You can specify instance families to launch any
+ * instance type within those families (for example, c5 or p3), or you can
+ * specify specific sizes within a family (such as c5.8xlarge). You can also choose
+ * optimal to select instance types (from the C4, M4, and R4 instance families) that
+ * match the demand of your job queues.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that
- * don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are
- * used.
Currently, optimal uses instance types from the C4, M4, and R4 instance
+ * families. In Regions that don't have instance types from those instance families, instance types
+ * from the C5, M5, and R5 instance families are used.
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is
- * overridden by the imageIdOverride member of the Ec2Configuration structure.
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
+ * This parameter is overridden by the imageIdOverride member of the
+ * Ec2Configuration structure.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate - * compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User - * Guide.
+ *The VPC subnets where the compute resources are launched. These subnets must be within the + * same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see + * VPCs and subnets + * in the Amazon VPC User Guide.
*Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see - * Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local - * Zones in the Amazon EKS User Guide and - * Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the - * Amazon ECS Developer Guide.
+ *Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local + * Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local + * Zones in the Amazon EKS User Guide and Amazon ECS + * clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS + * Developer Guide.
*Batch on Fargate doesn't currently support Local Zones.
*The Amazon EC2 security groups that are associated with instances launched in the compute environment. One or more
- * security groups must be specified, either in securityGroupIds or using a launch template referenced in
- * launchTemplate. This parameter is required for jobs that are running on Fargate resources and must
- * contain at least one security group. Fargate doesn't support launch templates. If security groups are specified
- * using both securityGroupIds and launchTemplate, the values in securityGroupIds
- * are used.
The Amazon EC2 security groups that are associated with instances launched in the compute
+ * environment. One or more security groups must be specified, either in
+ * securityGroupIds or using a launch template referenced in
+ * launchTemplate. This parameter is required for jobs that are running on Fargate
+ * resources and must contain at least one security group. Fargate doesn't support launch
+ * templates. If security groups are specified using both securityGroupIds and
+ * launchTemplate, the values in securityGroupIds are used.
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to - * log in to your instances with SSH.
+ *The Amazon EC2 key pair that's used for instances launched in the compute environment. You can + * use this key pair to log in to your instances with SSH.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name
- * or full Amazon Resource Name (ARN) of an instance profile. For example, The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can
+ * specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,
+ *
+ *
* ecsInstanceRole
* or
- * arn:aws:iam::arn:aws:iam::.
- * For more information, see Amazon ECS instance
- * role in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,
- * these take the form of "String1": "String2", where String1 is the tag key and
- * String2 is the tag value-for example, \{ "Name": "Batch Instance - C4OnDemand" \}. This is
- * helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure
- * update to the compute environment. For more information, see Updating compute environments in the
- * Batch User Guide. These tags aren't seen when using the Batch ListTagsForResource
- * API operation.
Key-value pair tags to be applied to EC2 resources that are launched in the compute
+ * environment. For Batch, these take the form of "String1": "String2", where
+ * String1 is the tag key and String2 is the tag value-for example,
+ * \{ "Name": "Batch Instance - C4OnDemand" \}. This is helpful for recognizing your
+ * Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to
+ * the compute environment. For more information, see Updating compute environments in the
+ * Batch User Guide. These tags aren't seen when using the Batch
+ * ListTagsForResource API operation.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel - * jobs to your compute environment, you should consider creating a cluster placement group and associate it with your - * compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single - * Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for - * Linux Instances.
+ *The Amazon EC2 placement group to associate with your compute resources. If you intend to submit + * multi-node parallel jobs to your compute environment, you should consider creating a cluster + * placement group and associate it with your compute resources. This keeps your multi-node parallel + * job on a logical grouping of instances within a single Availability Zone with high network flow + * potential. For more information, see Placement groups in the + * Amazon EC2 User Guide for Linux Instances.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that - * instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must - * be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and - * never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand - * price. For most use cases, we recommend - * leaving this field empty.
+ *The maximum percentage that a Spot Instance price can be when compared with the On-Demand + * price for that instance type before instances are launched. For example, if your maximum + * percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for + * that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum + * percentage. If you leave this field empty, the default value is 100% of the On-Demand + * price. For most use cases, + * we recommend leaving this field empty.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is
- * required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For
- * more information, see Amazon EC2 spot fleet
- * role in the Batch User Guide.
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute
+ * environment. This role is required if the allocation strategy set to BEST_FIT or if
+ * the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the
+ * Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot - * Instances. For more information, see Spot instances not tagged on creation in the - * Batch User Guide.
+ *To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use + * the newer AmazonEC2SpotFleetTaggingRole managed policy. The + * previously recommended AmazonEC2SpotFleetRole managed policy + * doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances + * not tagged on creation in the Batch User Guide.
*The launch template to use for your compute resources. Any other compute resource parameters that you specify in - * a CreateComputeEnvironment API operation override the same parameters in the launch template. You - * must specify either the launch template ID or launch template name in the request, but not both. For more - * information, see Launch template support in - * the Batch User Guide.
+ *The launch template to use for your compute resources. Any other compute resource parameters + * that you specify in a CreateComputeEnvironment API operation override the same + * parameters in the launch template. You must specify either the launch template ID or launch + * template name in the request, but not both. For more information, see Launch template support in the + * Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute
- * environment. If Ec2Configuration isn't specified, the default is ECS_AL2.
Provides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in
+ * the compute environment. If Ec2Configuration isn't specified, the default is
+ * ECS_AL2.
One or two values can be provided.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
@@ -625,23 +653,23 @@ export interface ComputeResource { /** * @public - *Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before - * the compute environment can be created.
+ *Configuration for the Amazon EKS cluster that supports the Batch compute environment. The + * cluster must exist before the compute environment can be created.
*/ export interface EksConfiguration { /** *The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is
- * arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch
+ * arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch
* .
*
The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or
- * null. It must be fewer than 64 characters long, can't be set to default, can't start with
- * "kube-," and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more
- * information, see Namespaces in the Kubernetes documentation.
The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value
+ * can't left empty or null. It must be fewer than 64 characters long, can't be set to
+ * default, can't start with "kube-," and must match this regular
+ * expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.
The state of the compute environment. If the state is ENABLED, then the compute environment accepts
- * jobs from a queue and can scale out automatically based on queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated
- * job queue on the compute resources within the environment. If the compute environment is managed, then it can scale
- * its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
- * environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
- * compute environments in the DISABLED state don't scale out. However, they scale in to
- * minvCpus value after instances become idle.
The state of the compute environment. If the state is ENABLED, then the
+ * compute environment accepts jobs from a queue and can scale out automatically based on
+ * queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs
+ * from an associated job queue on the compute resources within the environment. If the compute
+ * environment is managed, then it can scale its instances out or in automatically, based on the
+ * job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place
+ * jobs within the environment. Jobs in a STARTING or RUNNING state
+ * continue to progress normally. Managed compute environments in the DISABLED state
+ * don't scale out.
Compute environments in a DISABLED state may continue to incur billing
+ * charges. To prevent additional charges, turn off and then delete the compute environment.
+ * For more information, see State in the Batch User Guide.
When an instance is idle, the instance scales down to the minvCpus value.
+ * However, the instance size doesn't change. For example, consider a c5.8xlarge
+ * instance with a minvCpus value of 4 and a desiredvCpus
+ * value of 36. This instance doesn't scale down to a c5.large
+ * instance.
The order that compute environments are tried in for job placement within a queue. Compute environments are
- * tried in ascending order. For example, if two compute environments are associated with a job queue, the compute
- * environment with a lower order integer value is tried for job placement first. Compute environments must be in the
- * VALID state before you can associate them with a job queue. All of the compute environments must be
- * either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT);
- * EC2 and Fargate compute environments can't be mixed.
The order that compute environments are tried in for job placement within a queue. Compute
+ * environments are tried in ascending order. For example, if two compute environments are
+ * associated with a job queue, the compute environment with a lower order integer value is tried
+ * for job placement first. Compute environments must be in the VALID state before you
+ * can associate them with a job queue. All of the compute environments must be either EC2
+ * (EC2 or SPOT) or Fargate (FARGATE or
+ * FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. Batch doesn't - * support mixing compute environment architecture types in a single job queue.
+ *All compute environments that are associated with a job queue must share the same + * architecture. Batch doesn't support mixing compute environment architecture types in a single + * job queue.
*The order of the compute environment. Compute environments are tried in ascending order. For example, if two
- * compute environments are associated with a job queue, the compute environment with a lower order integer
- * value is tried for job placement first.
The order of the compute environment. Compute environments are tried in ascending order. For
+ * example, if two compute environments are associated with a job queue, the compute environment
+ * with a lower order integer value is tried for job placement first.
Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that
- * aren't included have a default weight of 1.0.
Specifies the weights for the fair share identifiers for the fair share policy. Fair share
+ * identifiers that aren't included have a default weight of 1.0.
A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry
- * specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share
- * identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a
- * shareIdentifier of UserA* and another that specifies a shareIdentifier of
- * UserA-1.
A fair share identifier or fair share identifier prefix. If the string ends with an asterisk
+ * (*), this entry specifies the weight factor to use for fair share identifiers that start with
+ * that prefix. The list of fair share identifiers in a fair share policy can't overlap. For
+ * example, you can't have one that specifies a shareIdentifier of UserA*
+ * and another that specifies a shareIdentifier of UserA-1.
There can be no more than 500 fair share identifiers active in a job queue.
- *The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).
+ *The string is limited to 255 alphanumeric characters, and can be followed by an asterisk + * (*).
*/ shareIdentifier: string | undefined; /** - *The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority - * for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times - * the compute resources of jobs that use a share identifier with a weight factor of 1.
+ *The weight factor for the fair share identifier. The default value is 1.0. A lower value has + * a higher priority for compute resources. For example, jobs that use a share identifier with a + * weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share + * identifier with a weight factor of 1.
*The smallest supported value is 0.0001, and the largest supported value is 999.9999.
*/ weightFactor?: number; @@ -906,33 +950,37 @@ export interface ShareAttributes { */ export interface FairsharePolicy { /** - *The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in - * use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs - * to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
+ *The amount of time (in seconds) to use to calculate a fair share percentage for each fair + * share identifier in use. A value of zero (0) indicates that only current usage is measured. The + * decay allows for more recently run jobs to have more weight than jobs that ran earlier. The + * maximum supported value is 604800 (1 week).
*/ shareDecaySeconds?: number; /** - *A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already - * used.
+ *A value used to reserve some of the available maximum vCPU for fair share identifiers that + * aren't already used.
*The reserved ratio is
- * (computeReservation/100)^ActiveFairShares
- * where
- *
+ * (computeReservation/100)^ActiveFairShares
+ *
+ * where
* ActiveFairShares
- * is the number of active fair share identifiers.
For example, a computeReservation value of 50 indicates that Batchreserves 50% of the maximum
- * available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It
- * reserves 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates
- * that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if
- * there are two fair share identifiers, and 1.56% if there are three fair share identifiers.
For example, a computeReservation value of 50 indicates that Batchreserves
+ * 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if
+ * there are two fair share identifiers. It reserves 12.5% if there are three fair share
+ * identifiers. A computeReservation value of 25 indicates that Batch should reserve
+ * 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are
+ * two fair share identifiers, and 1.56% if there are three fair share identifiers.
The minimum value is 0 and the maximum value is 99.
*/ computeReservation?: number; /** - *An array of SharedIdentifier objects that contain the weights for the fair share identifiers for
- * the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
An array of SharedIdentifier objects that contain the weights for the fair
+ * share identifiers for the fair share policy. Fair share identifiers that aren't included have a
+ * default weight of 1.0.
Specifies the infrastructure update policy for the compute environment. For more information about - * infrastructure updates, see Updating - * compute environments in the Batch User Guide.
+ *Specifies the infrastructure update policy for the compute environment. For more information + * about infrastructure updates, see Updating compute environments in the + * Batch User Guide.
*/ export interface UpdatePolicy { /** - *Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The
- * default value is false.
Specifies whether jobs are automatically terminated when the computer environment
+ * infrastructure is updated. The default value is false.
Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value - * is 30.
+ *Specifies the job timeout (in minutes) when the compute environment infrastructure is + * updated. The default value is 30.
*/ jobExecutionTimeoutMinutes?: number; } @@ -1150,64 +1198,76 @@ export interface ComputeEnvironmentDetail { tags?: RecordThe type of the compute environment: MANAGED or UNMANAGED. For more information, see
- * Compute environments in the
- * Batch User Guide.
The type of the compute environment: MANAGED or UNMANAGED. For
+ * more information, see Compute environments in the Batch User Guide.
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated
- * job queue on the compute resources within the environment. If the compute environment is managed, then it can scale
- * its instances out or in automatically based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
- * environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
- * compute environments in the DISABLED state don't scale out. However, they scale in to
- * minvCpus value after instances become idle.
The state of the compute environment. The valid values are ENABLED or
+ * DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs
+ * from an associated job queue on the compute resources within the environment. If the compute
+ * environment is managed, then it can scale its instances out or in automatically based on the job
+ * queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place
+ * jobs within the environment. Jobs in a STARTING or RUNNING state
+ * continue to progress normally. Managed compute environments in the DISABLED state
+ * don't scale out.
Compute environments in a DISABLED state may continue to incur billing
+ * charges. To prevent additional charges, turn off and then delete the compute environment. For
+ * more information, see State in the Batch User Guide.
When an instance is idle, the instance scales down to the minvCpus value.
+ * However, the instance size doesn't change. For example, consider a c5.8xlarge
+ * instance with a minvCpus value of 4 and a desiredvCpus
+ * value of 36. This instance doesn't scale down to a c5.large
+ * instance.
The current status of the compute environment (for example, CREATING or VALID).
The current status of the compute environment (for example, CREATING or
+ * VALID).
A short, human-readable string to provide additional details for the current status of the compute - * environment.
+ *A short, human-readable string to provide additional details for the current status of the + * compute environment.
*/ statusReason?: string; /** - *The compute resources defined for the compute environment. For more information, see Compute environments in the - * Batch User Guide.
+ *The compute resources defined for the compute environment. For more information, see Compute environments in + * the Batch User Guide.
*/ computeResources?: ComputeResource; /** - *The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API - * operations on your behalf. For more information, see Batch service IAM role in the - * Batch User Guide.
+ *The service role that's associated with the compute environment that allows Batch to make + * calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in + * the Batch User Guide.
*/ serviceRole?: string; /** - *Specifies the infrastructure update policy for the compute environment. For more information about - * infrastructure updates, see Updating - * compute environments in the Batch User Guide.
+ *Specifies the infrastructure update policy for the compute environment. For more information + * about infrastructure updates, see Updating compute environments in the + * Batch User Guide.
*/ updatePolicy?: UpdatePolicy; /** - *The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this
- * parameter if the containerOrchestrationType is EKS.
The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only
+ * specify this parameter if the containerOrchestrationType is EKS.
The orchestration type of the compute environment. The valid values are ECS (default) or
- * EKS.
The orchestration type of the compute environment. The valid values are ECS
+ * (default) or EKS.
The name of the key-value pair. For environment variables, this is the name of the environment variable.
+ *The name of the key-value pair. For environment variables, this is the name of the + * environment variable.
*/ name?: string; /** - *The value of the key-value pair. For environment variables, this is the value of the environment - * variable.
+ *The value of the key-value pair. For environment variables, this is the value of the + * environment variable.
*/ value?: string; } /** * @public - *The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must - * not specify this parameter.
+ *The amount of ephemeral storage to allocate for the task. This parameter is used to expand + * the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on + * Fargate.
+ */ +export interface EphemeralStorage { + /** + *The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported
+ * value is 21 GiB and the maximum supported value is 200 GiB.
The platform configuration for jobs that are running on Fargate resources. Jobs that run + * on EC2 resources must not specify this parameter.
*/ export interface FargatePlatformConfiguration { /** - *The Fargate platform version where the jobs are running. A platform version is specified only for jobs
- * that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by
- * default. This uses a recent, approved version of the Fargate platform for compute resources. For more
- * information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
The Fargate platform version where the jobs are running. A platform version is
+ * specified only for jobs that are running on Fargate resources. If one isn't specified, the
+ * LATEST platform version is used by default. This uses a recent, approved version of
+ * the Fargate platform for compute resources. For more information, see Fargate
+ * platform versions in the Amazon Elastic Container Service Developer Guide.
An object that represents a container instance host device.
*This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
+ *This object isn't applicable to jobs that are running on Fargate resources and shouldn't + * be provided.
*The path inside the container that's used to expose the host device. By default, the hostPath value
- * is used.
The path inside the container that's used to expose the host device. By default, the
+ * hostPath value is used.
The explicit permissions to provide to the container for the device. By default, the container has permissions
- * for read, write, and mknod for the device.
The explicit permissions to provide to the container for the device. By default, the
+ * container has permissions for read, write, and mknod for
+ * the device.
The absolute file path in the container where the tmpfs volume is mounted.
The absolute file path in the container where the tmpfs volume is
+ * mounted.
The list of tmpfs volume mount options.
Valid values: "defaults" | "ro" | "rw" | "suid" |
- * "nosuid" | "dev" | "nodev" | "exec" | "noexec" |
- * "sync" | "async" | "dirsync" | "remount" | "mand" |
- * "nomand" | "atime" | "noatime" | "diratime" |
- * "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" |
- * "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" |
- * "strictatime" | "nostrictatime" | "mode" | "uid" |
- * "gid" | "nr_inodes" | "nr_blocks" | "mpol"
Valid values: "defaults" | "ro" | "rw" |
+ * "suid" | "nosuid" | "dev" | "nodev" |
+ * "exec" | "noexec" | "sync" | "async" |
+ * "dirsync" | "remount" | "mand" | "nomand" |
+ * "atime" | "noatime" | "diratime" |
+ * "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" |
+ * "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" |
+ * "norelatime" | "strictatime" | "nostrictatime" |
+ * "mode" | "uid" | "gid" | "nr_inodes" |
+ * "nr_blocks" | "mpol"
Linux-specific modifications that are applied to the container, such as details for device mappings.
+ *Linux-specific modifications that are applied to the container, such as details for device + * mappings.
*/ export interface LinuxParameters { /** - *Any of the host devices to expose to the container. This parameter maps to Devices in the
- * Create a container section of the Docker Remote API and the --device option to docker run.
Any of the host devices to expose to the container. This parameter maps to
+ * Devices in the Create a container section of the Docker Remote API
+ * and the --device option to docker
+ * run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these - * jobs.
+ *This parameter isn't applicable to jobs that are running on Fargate resources. Don't + * provide it for these jobs.
*If true, run an init process inside the container that forwards signals and reaps processes. This
- * parameter maps to the --init option to docker run.
- * This parameter requires version 1.25 of the Docker Remote API or greater on your
+ *
If true, run an init process inside the container that forwards signals and
+ * reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your
* container instance. To check the Docker Remote API version on your container instance, log in to your
* container instance and run the following command: sudo docker version | grep "Server API version"
*
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the
- * --shm-size option to docker run.
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to
+ * the --shm-size option to docker
+ * run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these - * jobs.
+ *This parameter isn't applicable to jobs that are running on Fargate resources. Don't + * provide it for these jobs.
*The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the
- * --tmpfs option to docker run.
The container path, mount options, and size (in MiB) of the tmpfs mount. This
+ * parameter maps to the --tmpfs option to docker
+ * run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter - * for this resource type.
+ *This parameter isn't applicable to jobs that are running on Fargate resources. Don't + * provide this parameter for this resource type.
*The total amount of swap memory (in MiB) a container can use. This parameter is translated to the
- * The total amount of swap memory (in MiB) a container can use. This parameter is translated
+ * to the If a If a This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
- * jobs. This parameter isn't applicable to jobs that are running on Fargate resources. Don't
+ * provide it for these jobs. You can use this parameter to tune a container's memory swappiness behavior. A You can use this parameter to tune a container's memory swappiness behavior. A
+ * Consider the following when you use a per-container swap configuration. Swap space must be enabled and allocated on the container instance for the containers to use. Swap space must be enabled and allocated on the container instance for the containers to
+ * use. By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use
- * this feature. For more information, see Instance store swap volumes in the
- * Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an
- * Amazon EC2 instance by using a swap file?
+ * By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the
+ * instance to use this feature. For more information, see Instance store swap
+ * volumes in the Amazon EC2 User Guide for Linux Instances or How do I
+ * allocate memory to work as swap space in an Amazon EC2 instance by using a swap
+ * file?
* The swap space parameters are only supported for job definitions using EC2 resources. The swap space parameters are only supported for job definitions using EC2
+ * resources. If the If the This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
- * jobs. This parameter isn't applicable to jobs that are running on Fargate resources. Don't
+ * provide it for these jobs. An object that represents the secret to expose to your container. Secrets can be exposed to a container in the
- * following ways: An object that represents the secret to expose to your container. Secrets can be exposed to
+ * a container in the following ways: To inject sensitive data into your containers as environment variables, use the To inject sensitive data into your containers as environment variables, use the
+ * To reference sensitive information in the log configuration of a container, use the To reference sensitive information in the log configuration of a container, use the
+ * For more information, see Specifying
- * sensitive data in the Batch User Guide. For more information, see Specifying sensitive data in the
+ * Batch User Guide. The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or
- * the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store. The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of
+ * the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store. If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use
- * either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN
- * must be specified. If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're
+ * launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter
+ * exists in a different Region, then the full ARN must be specified. The log driver to use for the container. The valid values that are listed for this parameter are log drivers
- * that the Amazon ECS container agent can communicate with by default. The log driver to use for the container. The valid values that are listed for this parameter
+ * are log drivers that the Amazon ECS container agent can communicate with by default. The supported log drivers are --memory-swap option to docker run where the value is the
- * sum of the container memory plus the maxSwap value. For more information, see
+ * --memory-swap option to docker
+ * run where the value is the sum of the container memory plus the maxSwap
+ * value. For more information, see
* --memory-swap details in the Docker documentation.maxSwap value of 0 is specified, the container doesn't use swap. Accepted values
- * are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't
- * use the swap configuration for the container instance that it's running on. A maxSwap value must be set
- * for the swappiness parameter to be used.maxSwap value of 0 is specified, the container doesn't use
+ * swap. Accepted values are 0 or any positive integer. If the maxSwap
+ * parameter is omitted, the container doesn't use the swap configuration for the container instance
+ * that it's running on. A maxSwap value must be set for the swappiness
+ * parameter to be used.swappiness value of
- * 0 causes swapping to not occur unless absolutely necessary. A swappiness value of
- * 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and
- * 100. If the swappiness parameter isn't specified, a default value of 60 is
- * used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is
- * set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to
- * docker run.swappiness value of 0 causes swapping to not occur unless absolutely
+ * necessary. A swappiness value of 100 causes pages to be swapped
+ * aggressively. Valid values are whole numbers between 0 and 100. If the
+ * swappiness parameter isn't specified, a default value of 60 is used.
+ * If a value isn't specified for maxSwap, then this parameter is ignored. If
+ * maxSwap is set to 0, the container doesn't use swap. This parameter maps to the
+ * --memory-swappiness option to docker
+ * run.
*
* maxSwap and swappiness parameters are omitted from a job definition, each
- * container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times
- * the memory reservation of the container.maxSwap and swappiness parameters are omitted from a job
+ * definition, each container has a default swappiness value of 60. Moreover, the
+ * total swap usage is limited to two times the memory reservation of the container.
*
- * secrets container
- * definition parameter.secrets container definition parameter.secretOptions
- * container definition parameter.secretOptions container definition parameter.awslogs, fluentd, gelf,
- * json-file, journald, logentries, syslog, and
- * splunk.json-file, journald, logentries, syslog, and
+ * splunk.
Jobs that are running on Fargate resources are restricted to the awslogs and splunk
- * log drivers.
Jobs that are running on Fargate resources are restricted to the awslogs and
+ * splunk log drivers.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the - * Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
+ *Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver + * in the Batch User Guide and Amazon CloudWatch Logs logging + * driver in the Docker documentation.
*Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the - * Docker documentation.
+ *Specifies the Fluentd logging driver. For more information including usage and options, + * see Fluentd logging + * driver in the Docker documentation.
*Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and - * options, see Graylog Extended Format logging - * driver in the Docker documentation.
+ *Specifies the Graylog Extended Format (GELF) logging driver. For more information + * including usage and options, see Graylog Extended Format logging + * driver in the Docker documentation.
*Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the - * Docker documentation.
+ *Specifies the journald logging driver. For more information including usage and options, + * see Journald logging + * driver in the Docker documentation.
*Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the - * Docker documentation.
+ *Specifies the JSON file logging driver. For more information including usage and options, + * see JSON File + * logging driver in the Docker documentation.
*Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the - * Docker documentation.
+ *Specifies the Splunk logging driver. For more information including usage and options, + * see Splunk logging + * driver in the Docker documentation.
*Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the - * Docker documentation.
+ *Specifies the syslog logging driver. For more information including usage and options, + * see Syslog logging + * driver in the Docker documentation.
*If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you - * can fork the Amazon ECS container agent project that's available on - * GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that - * you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this + *
If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS + * container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to + * work with that driver. We encourage you to submit pull requests for changes that you want to + * have included. However, Amazon Web Services doesn't currently support running modified copies of this * software.
*This parameter requires version 1.18 of the Docker Remote API or greater on your
@@ -1602,18 +1700,17 @@ export interface LogConfiguration {
options?: Record The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the
- * Batch User Guide. The secrets to pass to the log configuration. For more information, see Specifying sensitive
+ * data in the Batch User Guide. Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to
- * Details for a Docker volume mount point that's used in a job's container properties. This
+ * parameter maps to If this value is If this value is The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2
- * resources must not specify this parameter. The network configuration for jobs that are running on Fargate resources. Jobs that are
+ * running on EC2 resources must not specify this parameter. Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private
- * subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires
- * a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking in the
- * Amazon Elastic Container Service Developer Guide. The default value is " Indicates whether the job has a public IP address. For a job that's running on Fargate
+ * resources in a private subnet to send outbound traffic to the internet (for example, to pull
+ * container images), the private subnet requires a NAT gateway be attached to route requests to the
+ * internet. For more information, see Amazon ECS task networking in the
+ * Amazon Elastic Container Service Developer Guide. The default value is " The type and amount of a resource to assign to a container. The supported resources include The type and amount of a resource to assign to a container. The supported resources include
+ * The quantity of the specified resource to reserve for the container. The values vary based on the
- * The quantity of the specified resource to reserve for the container. The values vary based
+ * on the The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all
- * containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched
- * on. The number of physical GPUs to reserve for the container. Make sure that the number of
+ * GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the
+ * compute resource that the job is launched on. GPUs aren't available for jobs that are running on Fargate resources. The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are
- * running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.
- * This parameter maps to The memory hard limit (in MiB) present to the container. This parameter is supported for
+ * jobs that are running on EC2 resources. If your container attempts to exceed the memory
+ * specified, the container is terminated. This parameter maps to If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for
- * a particular instance type, see Memory
- * management in the Batch User Guide. If you're trying to maximize your resource utilization by providing your jobs as much
+ * memory as possible for a particular instance type, see Memory management in the
+ * Batch User Guide. For jobs that are running on Fargate resources, then For jobs that are running on Fargate resources, then
- * Volumes in the Create a
- * container section of the Docker Remote API and the --volume option to
- * docker run.Volumes in the Create a container section of the Docker Remote API and the
+ * --volume option to docker run.true, the container has read-only access to the volume. Otherwise, the container
- * can write to the volume. The default value is false.true, the container has read-only access to the volume.
+ * Otherwise, the container can write to the volume. The default value is false.DISABLED".DISABLED".GPU,
- * MEMORY, and VCPU.GPU, MEMORY, and VCPU.type specified.type specified.
*
Memory in the Create a container section of the
- * Docker Remote API and the --memory option to docker run.
- * You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for
- * multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to
- * Memory in the Create a container section of the Docker Remote API and the
- * --memory option to docker run.Memory in the
+ * Create a container section of the Docker Remote API and the
+ * --memory option to docker run. You
+ * must specify at least 4 MiB of memory for a job. This is required but can be specified in
+ * several places for multi-node parallel (MNP) jobs. It must be specified for each node at least
+ * once. This parameter maps to Memory in the Create a container
+ * section of the Docker Remote API and the --memory option to docker run.value is the hard limit (in MiB), and
- * must match one of the supported values and the VCPU values must be one of the values supported for
- * that memory value.value is the hard
+ * limit (in MiB), and must match one of the supported values and the VCPU values
+ * must be one of the values supported for that memory value.
*
VCPU = 1, 2, 4, or 8VCPU = 1, 2, or 4
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the
- * Create a container section of the Docker Remote API and the --cpu-shares option to
- * docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2
- * resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be
- * specified for each node at least once.
The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about - * Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.
- *For jobs that are running on Fargate resources, then value must match one of the supported
- * values and the MEMORY values must be one of the values supported for that VCPU value.
- * The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16
The number of vCPUs reserved for the container. This parameter maps to
+ * CpuShares in the Create a container section of the
+ * Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares.
+ * For EC2 resources, you must specify at least one vCPU. This is required but can be specified
+ * in several places; it must be specified for each node at least once.
The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more + * information about Fargate quotas, see Fargate quotas + * in the Amazon Web Services General Reference.
+ *For jobs that are running on Fargate resources, then value must match one
+ * of the supported values and the MEMORY values must be one of the values supported
+ * for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and
+ * 16
The type of resource to assign to a container. The supported resources include GPU,
- * MEMORY, and VCPU.
The type of resource to assign to a container. The supported resources include
+ * GPU, MEMORY, and VCPU.
The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the
- * EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on
- * the EFS access point. If an access point is used, transit encryption must be enabled in the
- * EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the
- * Amazon Elastic File System User Guide.
The Amazon EFS access point ID to use. If an access point is specified, the root directory value
+ * specified in the EFSVolumeConfiguration must either be omitted or set to
+ * / which enforces the path set on the EFS access point. If an access point is used,
+ * transit encryption must be enabled in the EFSVolumeConfiguration. For more
+ * information, see Working
+ * with Amazon EFS access points in the Amazon Elastic File System User Guide.
Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.
- * If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is
- * omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the
- * Batch User Guide. EFS IAM authorization requires that TransitEncryption be
- * ENABLED and that a JobRoleArn is specified.
Whether or not to use the Batch job IAM role defined in a job definition when mounting the
+ * Amazon EFS file system. If enabled, transit encryption must be enabled in the
+ * EFSVolumeConfiguration. If this parameter is omitted, the default value of
+ * DISABLED is used. For more information, see Using Amazon EFS access points in
+ * the Batch User Guide. EFS IAM authorization requires that
+ * TransitEncryption be ENABLED and that a JobRoleArn is
+ * specified.
This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the - * Batch User Guide.
+ *This is used when you're using an Amazon Elastic File System file system for job storage. For more + * information, see Amazon EFS + * Volumes in the Batch User Guide.
*/ export interface EFSVolumeConfiguration { /** @@ -1907,28 +2012,31 @@ export interface EFSVolumeConfiguration { fileSystemId: string | undefined; /** - *The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is
- * omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this
- * parameter. The maximum length is 4,096 characters.
The directory within the Amazon EFS file system to mount as the root directory inside the host.
+ * If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying
+ * / has the same effect as omitting this parameter. The maximum length is 4,096
+ * characters.
If an EFS access point is specified in the authorizationConfig, the root directory parameter must
- * either be omitted or set to /, which enforces the path set on the Amazon EFS access point.
If an EFS access point is specified in the authorizationConfig, the root
+ * directory parameter must either be omitted or set to /, which enforces the path set
+ * on the Amazon EFS access point.
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.
- * Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default
- * value of DISABLED is used. For more information, see Encrypting data in transit in the
- * Amazon Elastic File System User Guide.
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and
+ * the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If
+ * this parameter is omitted, the default value of DISABLED is used. For more
+ * information, see Encrypting data in transit in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a - * transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be - * between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
+ *The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If + * you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS + * mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the + * Amazon Elastic File System User Guide.
*/ transitEncryptionPort?: number; @@ -1940,20 +2048,22 @@ export interface EFSVolumeConfiguration { /** * @public - *Determine whether your data volume persists on the host container instance and where it's stored. If this - * parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't - * guaranteed to persist after the containers that are associated with it stop running.
+ *Determine whether your data volume persists on the host container instance and where it's + * stored. If this parameter is empty, then the Docker daemon assigns a host path for your data + * volume. However, the data isn't guaranteed to persist after the containers that are associated + * with it stop running.
*/ export interface Host { /** - *The path on the host container instance that's presented to the container. If this parameter is empty, then the - * Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume - * persists at the specified location on the host container instance until you delete it manually. If the source path - * location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the - * contents of the source path folder are exported.
+ *The path on the host container instance that's presented to the container. If this parameter + * is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a + * file location, then the data volume persists at the specified location on the host container + * instance until you delete it manually. If the source path location doesn't exist on the host + * container instance, the Docker daemon creates it. If the location does exist, the contents of the + * source path folder are exported.
*This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these - * jobs.
+ *This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this + * for these jobs.
*The contents of the host parameter determine whether your data volume persists on the host
- * container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path
- * for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it
- * stop running.
The contents of the host parameter determine whether your data volume persists
+ * on the host container instance and where it's stored. If the host parameter is empty, then the
+ * Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to
+ * persist after the containers that are associated with it stop running.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be - * provided.
+ *This parameter isn't applicable to jobs that are running on Fargate resources and + * shouldn't be provided.
*The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters,
- * numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume
- * parameter of container definition mountPoints.
sourceVolume parameter of container definition mountPoints.
*/
name?: string;
/**
- * This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on
- * Fargate resources must specify a platformVersion of at least 1.4.0.
This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs
+ * that are running on Fargate resources must specify a platformVersion of at least
+ * 1.4.0.
Container properties are used * for - * Amazon ECS based job definitions. These properties to describe the container that's launched as part of - * a job.
+ * Amazon ECS based job definitions. These properties to describe the container that's + * launched as part of a job. */ export interface ContainerProperties { /** - *The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker
- * Hub registry are available by default. Other repositories are specified with
- * The image used to start a container. This string is passed directly to the Docker daemon.
+ * Images in the Docker Hub registry are available by default. Other repositories are specified with
+ *
+ *
* repository-url/image:tag
* .
* It can be 255 characters long. It can contain uppercase and lowercase letters, numbers,
- * hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of
- * the Docker Remote API and the IMAGE parameter of docker
- * run.Image in the
+ * Create a container section of the Docker Remote API and the IMAGE
+ * parameter of docker run.
Docker image architecture must match the processor architecture of the compute resources that they're scheduled - * on. For example, ARM-based Docker images can only run on ARM-based compute resources.
+ *Docker image architecture must match the processor architecture of the compute resources + * that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based + * compute resources.
*Images in Amazon ECR Public repositories use the full registry/repository[:tag] or
- * registry/repository[@digest] naming conventions. For example,
- * public.ecr.aws/registry_alias/my-web-app:latest
+ * registry/repository[@digest] naming conventions. For example,
+ * public.ecr.aws/registry_alias/my-web-app:latest
* .
Images in Amazon ECR repositories use the full registry and repository URI (for example,
- * 123456789012.dkr.ecr.).
123456789012.dkr.ecr..amazonaws.com/ ).
* Images in official repositories on Docker Hub use a single name (for example, ubuntu or
- * mongo).
Images in official repositories on Docker Hub use a single name (for example,
+ * ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example,
- * amazon/amazon-ecs-agent).
Images in other repositories on Docker Hub are qualified with an organization name (for
+ * example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example,
- * quay.io/assemblyline/ubuntu).
quay.io/assemblyline/ubuntu).
* This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job
- * definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies
- * the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the
- * Create a container section of the Docker Remote API and the --cpu-shares option to
- * docker run. The number of vCPUs must be specified but can be specified in
- * several places. You must specify it at least once for each node.
This parameter is deprecated, use resourceRequirements to specify the vCPU
+ * requirements for the job definition. It's not supported for jobs running on Fargate resources.
+ * For jobs running on EC2 resources, it specifies the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares
+ * in the Create a container section of the Docker Remote API and the
+ * --cpu-shares option to docker run. The
+ * number of vCPUs must be specified but can be specified in several places. You must specify it at
+ * least once for each node.
This parameter is deprecated, use resourceRequirements to specify the memory requirements for the
- * job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it
- * specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number,
- * it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can
- * be specified in several places. It must be specified for each node at least once.
This parameter is deprecated, use resourceRequirements to specify the memory
+ * requirements for the job definition. It's not supported for jobs running on Fargate resources.
+ * For jobs that run on EC2 resources, it specifies the memory hard limit (in MiB) for a container.
+ * If your container attempts to exceed the specified number, it's terminated. You must specify at
+ * least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in
+ * several places. It must be specified for each node at least once.
The command that's passed to the container. This parameter maps to Cmd in the
- * Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
COMMAND
+ * parameter to docker run. For more information, see
+ * https://docs.docker.com/engine/reference/builder/#cmd.
*/
command?: string[];
/**
- * The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see - * IAM roles for tasks - * in the Amazon Elastic Container Service Developer Guide.
+ *The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more + * information, see IAM roles for tasks in the + * Amazon Elastic Container Service Developer Guide.
*/ jobRoleArn?: string; /** - *The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must - * provide an execution role. For more information, see Batch execution IAM role in the - * Batch User Guide.
+ *The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate + * resources, you must provide an execution role. For more information, see Batch execution IAM role + * in the Batch User Guide.
*/ executionRoleArn?: string; @@ -2089,11 +2205,12 @@ export interface ContainerProperties { volumes?: Volume[]; /** - *The environment variables to pass to a container. This parameter maps to Env in the
- * Create a container section of the Docker Remote API and the --env option to docker run.
The environment variables to pass to a container. This parameter maps to Env in
+ * the Create a container section of the Docker Remote API and the
+ * --env option to docker run.
We don't recommend using plaintext environment variables for sensitive information, such as credential - * data.
+ *We don't recommend using plaintext environment variables for sensitive information, such as + * credential data.
*Environment variables cannot start with "AWS_BATCH". This naming
@@ -2103,110 +2220,126 @@ export interface ContainerProperties {
environment?: KeyValuePair[];
/**
- *
The mount points for data volumes in your container. This parameter maps to Volumes in the
- * Create a container section of the Docker Remote API and the --volume option to docker run.
The mount points for data volumes in your container. This parameter maps to
+ * Volumes in the Create a container section of the Docker Remote API
+ * and the --volume option to docker
+ * run.
When this parameter is true, the container is given read-only access to its root file system. This parameter
- * maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and
- * the --read-only option to docker run.
When this parameter is true, the container is given read-only access to its root file
+ * system. This parameter maps to ReadonlyRootfs in the
+ * Create a container section of the Docker Remote API and the
+ * --read-only option to docker run.
When this parameter is true, the container is given elevated permissions on the host container instance (similar
- * to the root user). This parameter maps to Privileged in the
- * Create a container section of the Docker Remote API and the --privileged option to
- * docker run. The default value is false.
When this parameter is true, the container is given elevated permissions on the host
+ * container instance (similar to the root user). This parameter maps to
+ * Privileged in the Create a container section of the
+ * Docker Remote API and the --privileged option to docker run. The default value is false.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or - * specified as false.
+ *This parameter isn't applicable to jobs that are running on Fargate resources and + * shouldn't be provided, or specified as false.
*A list of ulimits to set in the container. This parameter maps to Ulimits in the
- * Create a container section of the Docker Remote API and the --ulimit option to docker run.
A list of ulimits to set in the container. This parameter maps to
+ * Ulimits in the Create a container section of the Docker Remote API
+ * and the --ulimit option to docker
+ * run.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be - * provided.
+ *This parameter isn't applicable to jobs that are running on Fargate resources and + * shouldn't be provided.
*The user name to use inside the container. This parameter maps to User in the
- * Create a container section of the Docker Remote API and the --user option to docker run.
--user
+ * option to docker run.
*/
user?: string;
/**
- * The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use - * the same instance type.
+ *The instance type to use for a multi-node parallel job. All node groups in a multi-node + * parallel job must use the same instance type.
*This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and - * shouldn't be provided.
+ *This parameter isn't applicable to single-node container jobs or jobs that run on Fargate + * resources, and shouldn't be provided.
*The type and amount of resources to assign to a container. The supported resources include GPU,
- * MEMORY, and VCPU.
The type and amount of resources to assign to a container. The supported resources include
+ * GPU, MEMORY, and VCPU.
Linux-specific modifications that are applied to the container, such as details for device mappings.
+ *Linux-specific modifications that are applied to the container, such as details for device + * mappings.
*/ linuxParameters?: LinuxParameters; /** *The log configuration specification for the container.
- *This parameter maps to LogConfig in the Create a container section of the
- * Docker Remote API and the --log-driver option to docker run.
- * By default, containers use the same logging driver that the Docker daemon uses. However the container might use a
- * different logging driver than the Docker daemon by specifying a log driver with this parameter in the container
- * definition. To use a different logging driver for a container, the log system must be configured properly on the
- * container instance (or on a different log server for remote logging options). For more information on the options for
- * different supported log drivers, see Configure
- * logging drivers in the Docker documentation.
This parameter maps to LogConfig in the Create a container
+ * section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging
+ * driver that the Docker daemon uses. However the container might use a different logging driver
+ * than the Docker daemon by specifying a log driver with this parameter in the container
+ * definition. To use a different logging driver for a container, the log system must be configured
+ * properly on the container instance (or on a different log server for remote logging options). For
+ * more information on the options for different supported log drivers, see Configure logging drivers
+ * in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
+ *Batch currently supports a subset of the logging drivers available to the Docker daemon + * (shown in the LogConfiguration data type).
*This parameter requires version 1.18 of the Docker Remote API or greater on your
* container instance. To check the Docker Remote API version on your container instance, log in to your
* container instance and run the following command: sudo docker version | grep "Server API version"
*
The Amazon ECS container agent running on a container instance must register the logging drivers available on that
- * instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that
- * instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the
- * Amazon Elastic Container Service Developer Guide.
The Amazon ECS container agent running on a container instance must register the logging drivers
+ * available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment
+ * variable before containers placed on that instance can use these log configuration options. For
+ * more information, see Amazon ECS container agent
+ * configuration in the Amazon Elastic Container Service Developer Guide.
The secrets for the container. For more information, see Specifying sensitive data in the - * Batch User Guide.
+ * Batch User Guide. */ secrets?: Secret[]; /** - *The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 - * resources must not specify this parameter.
+ *The network configuration for jobs that are running on Fargate resources. Jobs that are + * running on EC2 resources must not specify this parameter.
*/ networkConfiguration?: NetworkConfiguration; /** - *The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 - * resources must not specify this parameter.
+ *The platform configuration for jobs that are running on Fargate resources. Jobs that are + * running on EC2 resources must not specify this parameter.
*/ fargatePlatformConfiguration?: FargatePlatformConfiguration; + + /** + *The amount of ephemeral storage to allocate for the task. This parameter is used to expand + * the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on + * Fargate.
+ */ + ephemeralStorage?: EphemeralStorage; } /** @@ -2227,41 +2360,45 @@ export interface EksContainerEnvironmentVariable { /** * @public - *The type and amount of resources to assign to a container. The supported resources include memory,
- * cpu, and nvidia.com/gpu. For more information, see Resource management for pods
- * and containers in the Kubernetes documentation.
The type and amount of resources to assign to a container. The supported resources include
+ * memory, cpu, and nvidia.com/gpu. For more information,
+ * see Resource management for pods and containers in the Kubernetes
+ * documentation.
The type and quantity of the resources to reserve for the container. The values vary based on the
- * name that's specified. Resources can be requested using either the limits or the
- * requests objects.
The type and quantity of the resources to reserve for the container. The values vary based
+ * on the name that's specified. Resources can be requested using either the
+ * limits or the requests objects.
The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container
- * attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory
- * for a job. memory can be specified in limits, requests, or both. If
- * memory is specified in both places, then the value that's specified in limits must be
- * equal to the value that's specified in requests.
The memory hard limit (in MiB) for the container, using whole integers, with a "Mi"
+ * suffix. If your container attempts to exceed the memory specified, the container is
+ * terminated. You must specify at least 4 MiB of memory for a job. memory can be
+ * specified in limits, requests, or both. If memory is
+ * specified in both places, then the value that's specified in limits must be equal
+ * to the value that's specified in requests.
To maximize your resource utilization, provide your jobs with as much memory as possible for the specific - * instance type that you are using. To learn how, see Memory management in the - * Batch User Guide.
+ *To maximize your resource utilization, provide your jobs with as much memory as possible + * for the specific instance type that you are using. To learn how, see Memory management in the + * Batch User Guide.
*The number of CPUs that's reserved for the container. Values must be an even multiple of 0.25.
- * cpu can be specified in limits, requests, or both. If cpu is
- * specified in both places, then the value that's specified in limits must be at least as large as the
- * value that's specified in requests.
The number of CPUs that's reserved for the container. Values must be an even multiple of
+ * 0.25. cpu can be specified in limits,
+ * requests, or both. If cpu is specified in both places, then the
+ * value that's specified in limits must be at least as large as the value that's
+ * specified in requests.
The number of GPUs that's reserved for the container. Values must be a whole integer. memory can
- * be specified in limits, requests, or both. If memory is specified in both
- * places, then the value that's specified in limits must be equal to the value that's specified in
+ *
The number of GPUs that's reserved for the container. Values must be a whole integer.
+ * memory can be specified in limits, requests, or both.
+ * If memory is specified in both places, then the value that's specified in
+ * limits must be equal to the value that's specified in
* requests.
The type and quantity of the resources to request for the container. The values vary based on the
- * name that's specified. Resources can be requested by using either the limits or the
- * requests objects.
The type and quantity of the resources to request for the container. The values vary based
+ * on the name that's specified. Resources can be requested by using either the
+ * limits or the requests objects.
The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container
- * attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory
- * for a job. memory can be specified in limits, requests, or both. If
- * memory is specified in both, then the value that's specified in limits must be equal to
- * the value that's specified in requests.
The memory hard limit (in MiB) for the container, using whole integers, with a "Mi"
+ * suffix. If your container attempts to exceed the memory specified, the container is
+ * terminated. You must specify at least 4 MiB of memory for a job. memory can be
+ * specified in limits, requests, or both. If memory is
+ * specified in both, then the value that's specified in limits must be equal to the
+ * value that's specified in requests.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for - * a particular instance type, see Memory - * management in the Batch User Guide.
+ *If you're trying to maximize your resource utilization by providing your jobs as much + * memory as possible for a particular instance type, see Memory management in the + * Batch User Guide.
*The number of CPUs that are reserved for the container. Values must be an even multiple of 0.25.
- * cpu can be specified in limits, requests, or both. If cpu is
- * specified in both, then the value that's specified in limits must be at least as large as the value
- * that's specified in requests.
The number of CPUs that are reserved for the container. Values must be an even multiple
+ * of 0.25. cpu can be specified in limits,
+ * requests, or both. If cpu is specified in both, then the value
+ * that's specified in limits must be at least as large as the value that's
+ * specified in requests.
The number of GPUs that are reserved for the container. Values must be a whole integer.
- * nvidia.com/gpu can be specified in limits, requests, or both. If
- * nvidia.com/gpu is specified in both, then the value that's specified in limits must be
- * equal to the value that's specified in requests.
nvidia.com/gpu can be specified in limits, requests,
+ * or both. If nvidia.com/gpu is specified in both, then the value that's specified
+ * in limits must be equal to the value that's specified in
+ * requests.
* The security context for a job. For more information, see Configure a security context for a - * pod or container in the Kubernetes documentation.
+ *The security context for a job. For more information, see Configure a + * security context for a pod or container in the Kubernetes + * documentation.
*/ export interface EksContainerSecurityContext { /** - *When this parameter is specified, the container is run as the specified user ID (uid). If this
- * parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to
- * RunAsUser and MustRanAs policy in the Users and groups pod
- * security policies in the Kubernetes documentation.
When this parameter is specified, the container is run as the specified user ID
+ * (uid). If this parameter isn't specified, the default is the user that's specified
+ * in the image metadata. This parameter maps to RunAsUser and MustRanAs
+ * policy in the Users
+ * and groups pod security policies in the Kubernetes
+ * documentation.
When this parameter is specified, the container is run as the specified group ID (gid). If this
- * parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to
- * RunAsGroup and MustRunAs policy in the Users and groups pod
- * security policies in the Kubernetes documentation.
When this parameter is specified, the container is run as the specified group ID
+ * (gid). If this parameter isn't specified, the default is the group that's specified
+ * in the image metadata. This parameter maps to RunAsGroup and MustRunAs
+ * policy in the Users
+ * and groups pod security policies in the Kubernetes
+ * documentation.
When this parameter is true, the container is given elevated permissions on the host container
- * instance. The level of permissions are similar to the root user permissions. The default value is
- * false. This parameter maps to privileged policy in the Privileged pod security
- * policies in the Kubernetes documentation.
When this parameter is true, the container is given elevated permissions on the
+ * host container instance. The level of permissions are similar to the root user
+ * permissions. The default value is false. This parameter maps to
+ * privileged policy in the Privileged
+ * pod security policies in the Kubernetes documentation.
When this parameter is true, the container is given read-only access to its root file system. The
- * default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file
- * systems pod security policies in the Kubernetes documentation.
When this parameter is true, the container is given read-only access to its
+ * root file system. The default value is false. This parameter maps to
+ * ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes
+ * documentation.
When this parameter is specified, the container is run as a user with a uid other than 0. If this
- * parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and
- * MustRunAsNonRoot policy in the Users and groups pod
- * security policies in the Kubernetes documentation.
When this parameter is specified, the container is run as a user with a uid
+ * other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to
+ * RunAsUser and MustRunAsNonRoot policy in the Users
+ * and groups pod security policies in the Kubernetes
+ * documentation.
The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in - * Kubernetes, see Volumes in the Kubernetes - * documentation.
+ *The volume mounts for a container for an Amazon EKS job. For more information about volumes and + * volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
*/ export interface EksContainerVolumeMount { /** - *The name the volume mount. This must match the name of one of the volumes in the pod.
+ *The name the volume mount. This must match the name of one of the volumes in the + * pod.
*/ name?: string; @@ -2369,22 +2517,22 @@ export interface EksContainerVolumeMount { mountPath?: string; /** - *If this value is true, the container has read-only access to the volume. Otherwise, the container
- * can write to the volume. The default value is false.
If this value is true, the container has read-only access to the volume.
+ * Otherwise, the container can write to the volume. The default value is false.
EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties - * for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job - * definitions.
+ *EKS container properties are used in job definitions for Amazon EKS based job definitions to + * describe the properties for a container node in the pod that's launched as part of a job. This + * can't be specified for Amazon ECS based job definitions.
*/ export interface EksContainer { /** - *The name of the container. If the name isn't specified, the default name "Default" is used. Each
- * container in a pod must have a unique name.
The name of the container. If the name isn't specified, the default name
+ * "Default" is used. Each container in a pod must have a unique name.
The image pull policy for the container. Supported values are Always, IfNotPresent,
- * and Never. This parameter defaults to IfNotPresent. However, if the :latest
- * tag is specified, it defaults to Always. For more information, see Updating images in the
- * Kubernetes documentation.
The image pull policy for the container. Supported values are Always,
+ * IfNotPresent, and Never. This parameter defaults to
+ * IfNotPresent. However, if the :latest tag is specified, it defaults to
+ * Always. For more information, see Updating
+ * images in the Kubernetes documentation.
The entrypoint for the container. This isn't run within a shell. If this isn't specified, the
- * ENTRYPOINT of the container image is used. Environment variable references are expanded using the
- * container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example,
- * if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the
- * command string will remain "$(NAME1)." $$ is replaced with $ and the resulting
- * string isn't expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or
- * not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see
- * ENTRYPOINT in the
- * Dockerfile reference and Define a command
- * and arguments for a container and Entrypoint in
- * the Kubernetes documentation.
The entrypoint for the container. This isn't run within a shell. If this isn't specified,
+ * the ENTRYPOINT of the container image is used. Environment variable references are
+ * expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't
+ * changed. For example, if the reference is to "$(NAME1)" and the NAME1
+ * environment variable doesn't exist, the command string will remain "$(NAME1)."
+ * $$ is replaced with $ and the resulting string isn't expanded. For
+ * example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the
+ * VAR_NAME environment variable exists. The entrypoint can't be updated. For more
+ * information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.
An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is
- * used. This corresponds to the args member in the Entrypoint
- * portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example,
- * if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the
- * command string will remain "$(NAME1)." $$ is replaced with $, and the
- * resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether
- * or not the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile
- * reference and Define a command
- * and arguments for a pod in the Kubernetes documentation.
An array of arguments to the entrypoint. If this isn't specified, the CMD of
+ * the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod
+ * in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't
+ * changed. For example, if the reference is to "$(NAME1)" and the NAME1
+ * environment variable doesn't exist, the command string will remain "$(NAME1)."
+ * $$ is replaced with $, and the resulting string isn't expanded. For
+ * example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the
+ * VAR_NAME environment variable exists. For more information, see CMD in the
+ * Dockerfile reference and Define a command and arguments for a pod in the Kubernetes
+ * documentation.
The type and amount of resources to assign to a container. The supported resources include memory,
- * cpu, and nvidia.com/gpu. For more information, see Resource management for pods
- * and containers in the Kubernetes documentation.
The type and amount of resources to assign to a container. The supported resources include
+ * memory, cpu, and nvidia.com/gpu. For more information,
+ * see Resource management for pods and containers in the Kubernetes
+ * documentation.
The volume mounts for the container. Batch supports emptyDir, hostPath, and
- * secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes
- * documentation.
The volume mounts for the container. Batch supports emptyDir,
+ * hostPath, and secret volume types. For more information about volumes
+ * and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
The security context for a job. For more information, see Configure a security context for a - * pod or container in the Kubernetes documentation.
+ *The security context for a job. For more information, see Configure a + * security context for a pod or container in the Kubernetes + * documentation.
*/ securityContext?: EksContainerSecurityContext; } /** * @public - *Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir volume is first
- * created when a pod is assigned to a node. It exists as long as that pod is running on that node. The
- * emptyDir volume is initially empty. All containers in the pod can read and write the files in the
- * emptyDir volume. However, the emptyDir volume can be mounted at the same or different paths
- * in each container. When a pod is removed from a node for any reason, the data in the emptyDir is
- * deleted permanently. For more information, see emptyDir in the Kubernetes
- * documentation.
Specifies the configuration of a Kubernetes emptyDir volume. An
+ * emptyDir volume is first created when a pod is assigned to a node. It exists as
+ * long as that pod is running on that node. The emptyDir volume is initially empty.
+ * All containers in the pod can read and write the files in the emptyDir volume.
+ * However, the emptyDir volume can be mounted at the same or different paths in each
+ * container. When a pod is removed from a node for any reason, the data in the
+ * emptyDir is deleted permanently. For more information, see emptyDir in the
+ * Kubernetes documentation.
The medium to store the volume. The default value is an empty string, which uses the storage of the node.
+ *The medium to store the volume. The default value is an empty string, which uses the storage + * of the node.
*Use the tmpfs volume that's backed by the RAM of the node. Contents of the volume are lost when
- * the node reboots, and any storage on the volume counts against the container's memory limit.
Use the tmpfs volume that's backed by the RAM of the node. Contents of the
+ * volume are lost when the node reboots, and any storage on the volume counts against the
+ * container's memory limit.
Specifies the configuration of a Kubernetes hostPath volume. A hostPath volume mounts an
- * existing file or directory from the host node's filesystem into your pod. For more information, see hostPath in the Kubernetes
- * documentation.
Specifies the configuration of a Kubernetes hostPath volume. A hostPath
+ * volume mounts an existing file or directory from the host node's filesystem into your pod. For
+ * more information, see hostPath in the Kubernetes documentation.
Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes
- * documentation.
Specifies the configuration of a Kubernetes secret volume. For more information, see
+ * secret in the
+ * Kubernetes documentation.
The name of the secret. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain - * names in the Kubernetes documentation.
+ *The name of the secret. The name must be allowed as a DNS subdomain name. For more + * information, see DNS subdomain names in the Kubernetes documentation.
*/ secretName: string | undefined; @@ -2532,26 +2693,29 @@ export interface EksSecret { */ export interface EksVolume { /** - *The name of the volume. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain - * names in the Kubernetes documentation.
+ *The name of the volume. The name must be allowed as a DNS subdomain name. For more + * information, see DNS subdomain names in the Kubernetes documentation.
*/ name: string | undefined; /** - *Specifies the configuration of a Kubernetes hostPath volume. For more information, see hostPath in the Kubernetes
- * documentation.
Specifies the configuration of a Kubernetes hostPath volume. For more information,
+ * see hostPath
+ * in the Kubernetes documentation.
Specifies the configuration of a Kubernetes emptyDir volume. For more information, see emptyDir in the Kubernetes
- * documentation.
Specifies the configuration of a Kubernetes emptyDir volume. For more information,
+ * see emptyDir
+ * in the Kubernetes documentation.
Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes
- * documentation.
Specifies the configuration of a Kubernetes secret volume. For more information, see
+ * secret in the
+ * Kubernetes documentation.
The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account - * to assume an IAM role in the Amazon EKS User Guide and Configure service accounts - * for pods in the Kubernetes documentation.
+ *The name of the service account that's used to run the pod. For more information, see + * Kubernetes service + * accounts and Configure a Kubernetes service account + * to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes + * documentation.
*/ serviceAccountName?: string; /** - *Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this
- * to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't
- * require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and
- * Pod networking in the
- * Kubernetes documentation.
Indicates if the pod uses the hosts' network IP address. The default value is
+ * true. Setting this to false enables the Kubernetes pod networking model.
+ * Most Batch workloads are egress-only and don't require the overhead of IP allocation for each
+ * pod for incoming connections. For more information, see Host
+ * namespaces and Pod networking
+ * in the Kubernetes documentation.
The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork
- * parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates
- * that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver
- * inherited from the node. For more information, see Pod's DNS
- * policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst | ClusterFirstWithHostNet
+ *
The DNS policy for the pod. The default value is ClusterFirst. If the
+ * hostNetwork parameter is not specified, the default is
+ * ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query
+ * that does not match the configured cluster domain suffix is forwarded to the upstream nameserver
+ * inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst |
+ * ClusterFirstWithHostNet
*
Specifies the volumes for a job definition that uses Amazon EKS resources.
*/ volumes?: EksVolume[]; + + metadata?: EksMetadata; } /** @@ -2612,16 +2782,18 @@ export interface EksProperties { /** * @public - *An object that represents the properties of the node range for a multi-node parallel job.
+ *An object that represents the properties of the node range for a multi-node parallel + * job.
*/ export interface NodeRangeProperty { /** - *The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of
- * 0 through 3. If the starting range value is omitted (:n), then 0
- * is used to start the range. If the ending range value is omitted (n:), then the highest possible node
- * index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can
- * nest node ranges (for example, 0:10 and 4:5). In this case, the 4:5 range
- * properties override the 0:10 properties.
The range of nodes, using node index values. A range of 0:3 indicates nodes
+ * with index values of 0 through 3. If the starting range value is
+ * omitted (:n), then 0 is used to start the range. If the ending range
+ * value is omitted (n:), then the highest possible node index is used to end the
+ * range. Your accumulative node ranges must account for all nodes (0:n). You can nest
+ * node ranges (for example, 0:10 and 4:5). In this case, the
+ * 4:5 range properties override the 0:10 properties.
Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer - * than the number of nodes.
+ *Specifies the node index for the main node of a multi-node parallel job. This node index + * value must be fewer than the number of nodes.
*/ mainNode: number | undefined; /** - *A list of node ranges and their properties that are associated with a multi-node parallel job.
+ *A list of node ranges and their properties that are associated with a multi-node parallel + * job.
*/ nodeRangeProperties: NodeRangeProperty[] | undefined; } @@ -2674,58 +2847,64 @@ export enum RetryAction { /** * @public - *Specifies an array of up to 5 conditions to be met, and an action to take (RETRY or
- * EXIT) if all conditions are met. If none of the EvaluateOnExit conditions in a
- * RetryStrategy match, then the job is retried.
Specifies an array of up to 5 conditions to be met, and an action to take
+ * (RETRY or EXIT) if all conditions are met. If none of the
+ * EvaluateOnExit conditions in a RetryStrategy match, then the job is
+ * retried.
Contains a glob pattern to match against the StatusReason returned for a job. The pattern can
- * contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including
- * spaces or tabs). It can optionally end with
- * an asterisk (*) so that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the StatusReason returned for a job.
+ * The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.),
+ * colons (:), and white spaces (including spaces or tabs).
+ * It can
+ * optionally end with an asterisk (*) so that only the start of the string needs to be an exact
+ * match.
Contains a glob pattern to match against the Reason returned for a job. The pattern can contain up
- * to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and
- * tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact
- * match.
Contains a glob pattern to match against the Reason returned for a job. The
+ * pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons
+ * (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so
+ * that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the decimal representation of the ExitCode returned for a
- * job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so
- * that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the decimal representation of the
+ * ExitCode returned for a job. The pattern can be up to 512 characters long. It can
+ * contain only numbers, and can end with an asterisk (*) so that only the start of the string needs
+ * to be an exact match.
The string can contain up to 512 characters.
*/ onExitCode?: string; /** - *Specifies the action to take if all of the specified conditions (onStatusReason,
- * onReason, and onExitCode) are met. The values aren't case sensitive.
Specifies the action to take if all of the specified conditions
+ * (onStatusReason, onReason, and onExitCode) are met. The
+ * values aren't case sensitive.
The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.
+ *The retry strategy that's associated with a job. For more information, see Automated job retries in the + * Batch User Guide.
*/ export interface RetryStrategy { /** - *The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10
- * attempts. If the value of attempts is greater than one, the job is retried on failure the same number of
- * attempts as the value.
The number of times to move a job to the RUNNABLE status. You can specify
+ * between 1 and 10 attempts. If the value of attempts is greater than one, the job is
+ * retried on failure the same number of attempts as the value.
Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is
- * specified, then the attempts parameter must also be specified. If none of the listed conditions match,
- * then the job is retried.
Array of up to 5 objects that specify the conditions where jobs are retried or failed. If
+ * this parameter is specified, then the attempts parameter must also be specified. If
+ * none of the listed conditions match, then the job is retried.
The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After
- * this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60
- * seconds.
The job timeout time (in seconds) that's measured from the job attempt's
+ * startedAt timestamp. After this time passes, Batch terminates your jobs if they
+ * aren't finished. The minimum value for the timeout is 60 seconds.
For array jobs, the timeout applies to the child jobs, not to the parent array job.
- *For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.
+ *For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the + * individual nodes.
*/ attemptDurationSeconds?: number; } @@ -2771,52 +2951,55 @@ export interface JobDefinition { status?: string; /** - *The type of job definition. It's either container or multinode. If the job is run on
- * Fargate resources, then multinode isn't supported. For more information about multi-node parallel
- * jobs, see Creating a multi-node parallel job
- * definition in the Batch User Guide.
The type of job definition. It's either container or multinode. If
+ * the job is run on Fargate resources, then multinode isn't supported. For more
+ * information about multi-node parallel jobs, see Creating a multi-node parallel job definition in
+ * the Batch User Guide.
The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. - * Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
+ *The scheduling priority of the job definition. This only affects jobs in job queues with a + * fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower + * scheduling priority.
*/ schedulingPriority?: number; /** - *Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are
- * specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding
- * parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the
- * Batch User Guide.
Default parameters or parameter substitution placeholders that are set in the job
+ * definition. Parameters are specified as a key-value pair mapping. Parameters in a
+ * SubmitJob request override any corresponding parameter defaults from the job
+ * definition. For more information about specifying parameters, see Job definition parameters in the
+ * Batch User Guide.
The retry strategy to use for failed jobs that are submitted with this job definition.
+ *The retry strategy to use for failed jobs that are submitted with this job + * definition.
*/ retryStrategy?: RetryStrategy; /** *An object with various properties specific to Amazon ECS based jobs. Valid values are
- * containerProperties, eksProperties, and nodeProperties. Only one can be
- * specified.
containerProperties, eksProperties, and nodeProperties.
+ * Only one can be specified.
*/
containerProperties?: ContainerProperties;
/**
- * The timeout time for jobs that are submitted with this job definition. After the amount of time you specify - * passes, Batch terminates your jobs if they aren't finished.
+ *The timeout time for jobs that are submitted with this job definition. After the amount of + * time you specify passes, Batch terminates your jobs if they aren't finished.
*/ timeout?: JobTimeout; /** - *An object with various properties that are specific to multi-node parallel jobs. Valid values are
- * containerProperties, eksProperties, and nodeProperties. Only one can be
- * specified.
An object with various properties that are specific to multi-node parallel jobs. Valid
+ * values are containerProperties, eksProperties, and
+ * nodeProperties. Only one can be specified.
If the job runs on Fargate resources, don't specify nodeProperties. Use
- * containerProperties instead.
containerProperties instead.
* Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no
- * value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created.
- * For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined
- * tags from the job and job definition is over 50, the job is moved to the FAILED state.
Specifies whether to propagate the tags from the job or job definition to the corresponding
+ * Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to
+ * the tasks when the tasks are created. For tags with the same name, job tags are given priority
+ * over job definitions tags. If the total number of combined tags from the job and job definition
+ * is over 50, the job is moved to the FAILED state.
The platform capabilities required by the job definition. If no value is specified, it defaults to
- * EC2. Jobs run on Fargate resources specify FARGATE.
The platform capabilities required by the job definition. If no value is specified, it
+ * defaults to EC2. Jobs run on Fargate resources specify
+ * FARGATE.
An object with various properties that are specific to Amazon EKS based jobs. Valid values are
- * containerProperties, eksProperties, and nodeProperties. Only one can be
- * specified.
containerProperties, eksProperties, and nodeProperties.
+ * Only one can be specified.
*/
eksProperties?: EksProperties;
/**
- * The orchestration type of the compute environment. The valid values are ECS (default) or
- * EKS.
The orchestration type of the compute environment. The valid values are ECS
+ * (default) or EKS.
Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can
- * accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already
- * in the queue can finish.
Describes the ability of the queue to accept new jobs. If the job queue state is
+ * ENABLED, it can accept jobs. If the job queue state is DISABLED, new
+ * jobs can't be added to the queue, but jobs already in the queue can finish.
The Amazon Resource Name (ARN) of the scheduling policy. The format is
- * aws:Partition:batch:Region:Account:scheduling-policy/Name
+ * aws:Partition:batch:Region:Account:scheduling-policy/Name
* .
* For example,
- * aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
*/
schedulingPolicyArn?: string;
/**
- * The status of the job queue (for example, CREATING or VALID).
The status of the job queue (for example, CREATING or
+ * VALID).
A short, human-readable string to provide additional details for the current status of the job queue.
+ *A short, human-readable string to provide additional details for the current status of the + * job queue.
*/ statusReason?: string; /** - *The priority of the job queue. Job queues with a higher priority (or a higher integer value for the
- * priority parameter) are evaluated first when associated with the same compute environment. Priority is
- * determined in descending order. For example, a job queue with a priority value of 10 is given scheduling
- * preference over a job queue with a priority value of 1. All of the compute environments must be either
- * EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and
+ *
The priority of the job queue. Job queues with a higher priority (or a higher integer value
+ * for the priority parameter) are evaluated first when associated with the same
+ * compute environment. Priority is determined in descending order. For example, a job queue with a
+ * priority value of 10 is given scheduling preference over a job queue with a priority
+ * value of 1. All of the compute environments must be either EC2 (EC2 or
+ * SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and
* Fargate compute environments can't be mixed.
The compute environments that are attached to the job queue and the order that job placement is preferred. - * Compute environments are selected for job placement in ascending order.
+ *The compute environments that are attached to the job queue and the order that job placement + * is preferred. Compute environments are selected for job placement in ascending order.
*/ computeEnvironmentOrder: ComputeEnvironmentOrder[] | undefined; /** *The tags that are applied to the job queue. For more information, see Tagging your Batch resources in - * Batch User Guide.
+ * Batch User Guide. */ tags?: RecordThe number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU
- * requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both
- * the vcpus and resourceRequirements object. This parameter maps to CpuShares in
- * the Create a container section of the Docker Remote API and the --cpu-shares option to
- * docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify
- * at least one vCPU. This is required but can be specified in several places. It must be specified for each node at
- * least once.
The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can
+ * specify the vCPU requirement for the job using resourceRequirements, but you can't
+ * specify the vCPU requirements in both the vcpus and
+ * resourceRequirements object. This parameter maps to CpuShares in the
+ * Create a container section of the Docker Remote API and the
+ * --cpu-shares option to docker run. Each
+ * vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but
+ * can be specified in several places. It must be specified for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate
- * resources, you must specify the vCPU requirement for the job using resourceRequirements.
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run
+ * on Fargate resources, you must specify the vCPU requirement for the job using
+ * resourceRequirements.
For jobs running on EC2 resources that didn't specify memory requirements using
- * resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all
- * run on Fargate resources, see resourceRequirements.
resourceRequirements, the number of MiB of memory reserved for the job. For other
+ * jobs, including all run on Fargate resources, see resourceRequirements.
*/
memory?: number;
@@ -3053,8 +3243,9 @@ export interface ContainerDetail {
/**
* The Amazon Resource Name (ARN) of the * execution - * role that Batch can assume. For more information, see Batch execution IAM role in the - * Batch User Guide.
+ * role that Batch can assume. For more information, + * see Batch execution IAM + * role in the Batch User Guide. */ executionRoleArn?: string; @@ -3078,17 +3269,21 @@ export interface ContainerDetail { mountPoints?: MountPoint[]; /** - *When this parameter is true, the container is given read-only access to its root file system. This parameter
- * maps to When this parameter is true, the container is given read-only access to its root file
+ * system. This parameter maps to A list of A list of This parameter isn't applicable to jobs that are running on Fargate resources. When this parameter is true, the container is given elevated permissions on the host container instance (similar
- * to the When this parameter is true, the container is given elevated permissions on the host
+ * container instance (similar to the This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or
- * specified as This parameter isn't applicable to jobs that are running on Fargate resources and
+ * shouldn't be provided, or specified as The user name to use inside the container. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and
- * the --read-only option to
- * docker run
+ * ReadonlyRootfs in the
+ * Create a container section of the Docker Remote API and the
+ * --read-only option to
+ * docker
+ * run
* .ulimit values to set in the container. This parameter maps to Ulimits in the
- * Create a container section of the Docker Remote API and the --ulimit option to docker run.ulimit values to set in the container. This parameter maps to
+ * Ulimits in the Create a container section of the Docker Remote API
+ * and the --ulimit option to docker
+ * run.root user). The default value is false.root user). The default value is
+ * false.false.false.User in the
- * Create a container section of the Docker Remote API and the --user option to docker run.--user
+ * option to docker run.
A short (255 max characters) human-readable string to provide additional details for a running or stopped - * container.
+ *A short (255 max characters) human-readable string to provide additional details for a + * running or stopped container.
*/ reason?: string; @@ -3128,15 +3325,15 @@ export interface ContainerDetail { containerInstanceArn?: string; /** - *The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task
- * ARN when they reach the STARTING status.
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container
+ * attempt receives a task ARN when they reach the STARTING status.
The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is
- * /aws/batch/job. Each container attempt receives a log stream name when they reach the
- * RUNNING status.
The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for
+ * Batch jobs is /aws/batch/job. Each container attempt receives a log stream name
+ * when they reach the RUNNING status.
The type and amount of resources to assign to a container. The supported resources include GPU,
- * MEMORY, and VCPU.
The type and amount of resources to assign to a container. The supported resources include
+ * GPU, MEMORY, and VCPU.
Linux-specific modifications that are applied to the container, such as details for device mappings.
+ *Linux-specific modifications that are applied to the container, such as details for device + * mappings.
*/ linuxParameters?: LinuxParameters; /** *The log configuration specification for the container.
- *This parameter maps to LogConfig in the Create a container section of the
- * Docker Remote API and the --log-driver option to docker run.
- * By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a
- * different logging driver than the Docker daemon by specifying a log driver with this parameter in the container
- * definition. To use a different logging driver for a container, the log system must be configured properly on the
- * container instance. Or, alternatively, it must be configured on a different log server for remote logging options.
- * For more information on the options for different supported log drivers, see Configure logging drivers in the Docker
- * documentation.
This parameter maps to LogConfig in the Create a container
+ * section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging
+ * driver that the Docker daemon uses. However, the container might use a different logging driver
+ * than the Docker daemon by specifying a log driver with this parameter in the container
+ * definition. To use a different logging driver for a container, the log system must be configured
+ * properly on the container instance. Or, alternatively, it must be configured on a different log
+ * server for remote logging options. For more information on the options for different supported
+ * log drivers, see Configure
+ * logging drivers in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS - * container agent.
+ *Batch currently supports a subset of the logging drivers available to the Docker daemon + * (shown in the LogConfiguration data type). Additional log drivers might be + * available in future releases of the Amazon ECS container agent.
*This parameter requires version 1.18 of the Docker Remote API or greater on your
* container instance. To check the Docker Remote API version on your container instance, log in to your
* container instance and run the following command: sudo docker version | grep "Server API version"
*
The Amazon ECS container agent running on a container instance must register the logging drivers available on that
- * instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that
- * instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the
- * Amazon Elastic Container Service Developer Guide.
The Amazon ECS container agent running on a container instance must register the logging drivers
+ * available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment
+ * variable before containers placed on that instance can use these log configuration options. For
+ * more information, see Amazon ECS container agent
+ * configuration in the Amazon Elastic Container Service Developer Guide.
The secrets to pass to the container. For more information, see Specifying sensitive data in the - * Batch User Guide.
+ * Batch User Guide. */ secrets?: Secret[]; /** - *The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 - * resources must not specify this parameter.
+ *The network configuration for jobs that are running on Fargate resources. Jobs that are + * running on EC2 resources must not specify this parameter.
*/ networkConfiguration?: NetworkConfiguration; /** - *The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2 - * resources must not specify this parameter.
+ *The platform configuration for jobs that are running on Fargate resources. Jobs that are + * running on EC2 resources must not specify this parameter.
*/ fargatePlatformConfiguration?: FargatePlatformConfiguration; + + /** + *The amount of ephemeral storage to allocate for the task. This parameter is used to expand + * the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on + * Fargate.
+ */ + ephemeralStorage?: EphemeralStorage; } /** @@ -3228,7 +3436,8 @@ export interface JobDependency { /** * @public - *An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.
+ *An object that represents the details for an attempt for a job attempt that an Amazon EKS + * container runs.
*/ export interface EksAttemptContainerDetail { /** @@ -3237,15 +3446,16 @@ export interface EksAttemptContainerDetail { exitCode?: number; /** - *A short (255 max characters) human-readable string to provide additional details for a running or stopped - * container.
+ *A short (255 max characters) human-readable string to provide additional details for a + * running or stopped container.
*/ reason?: string; } /** * @public - *An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.
+ *An object that represents the details of a job attempt for a job attempt by an Amazon EKS + * container.
*/ export interface EksAttemptDetail { /** @@ -3264,33 +3474,34 @@ export interface EksAttemptDetail { nodeName?: string; /** - *The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the
- * STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt
+ * transitioned from the STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the attempt
- * transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or
- * FAILED.
The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the
+ * attempt transitioned from the RUNNING state to a terminal state, such as
+ * SUCCEEDED or FAILED.
A short, human-readable string to provide additional details for the current status of the job attempt.
+ *A short, human-readable string to provide additional details for the current status of the + * job attempt.
*/ statusReason?: string; } /** * @public - *The details for container properties that are returned by DescribeJobs for jobs that use
- * Amazon EKS.
The details for container properties that are returned by DescribeJobs for jobs
+ * that use Amazon EKS.
The name of the container. If the name isn't specified, the default name "Default" is used. Each
- * container in a pod must have a unique name.
The name of the container. If the name isn't specified, the default name
+ * "Default" is used. Each container in a pod must have a unique name.
The image pull policy for the container. Supported values are Always, IfNotPresent,
- * and Never. This parameter defaults to Always if the :latest tag is specified,
- * IfNotPresent otherwise. For more information, see Updating images in the
- * Kubernetes documentation.
The image pull policy for the container. Supported values are Always,
+ * IfNotPresent, and Never. This parameter defaults to
+ * Always if the :latest tag is specified, IfNotPresent
+ * otherwise. For more information, see Updating
+ * images in the Kubernetes documentation.
The entrypoint for the container. For more information, see Entrypoint in - * the Kubernetes documentation.
+ *The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
*/ command?: string[]; /** - *An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is
- * used. This corresponds to the args member in the Entrypoint
- * portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example,
- * if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the
- * command string will remain "$(NAME1)". $$ is replaced with $ and the resulting
- * string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not
- * the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile
- * reference and Define a command
- * and arguments for a pod in the Kubernetes documentation.
An array of arguments to the entrypoint. If this isn't specified, the CMD of
+ * the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod
+ * in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't
+ * changed. For example, if the reference is to "$(NAME1)" and the NAME1
+ * environment variable doesn't exist, the command string will remain "$(NAME1)".
+ * $$ is replaced with $ and the resulting string isn't expanded. For
+ * example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the
+ * VAR_NAME environment variable exists. For more information, see CMD in the
+ * Dockerfile reference and Define a command and arguments for a pod in the Kubernetes
+ * documentation.
The type and amount of resources to assign to a container. The supported resources include memory,
- * cpu, and nvidia.com/gpu. For more information, see Resource management for pods
- * and containers in the Kubernetes documentation.
The type and amount of resources to assign to a container. The supported resources include
+ * memory, cpu, and nvidia.com/gpu. For more information,
+ * see Resource management for pods and containers in the Kubernetes
+ * documentation.
A short human-readable string to provide additional details for a running or stopped container. It can be up to - * 255 characters long.
+ *A short human-readable string to provide additional details for a running or stopped + * container. It can be up to 255 characters long.
*/ reason?: string; /** - *The volume mounts for the container. Batch supports emptyDir, hostPath, and
- * secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes
- * documentation.
The volume mounts for the container. Batch supports emptyDir,
+ * hostPath, and secret volume types. For more information about volumes
+ * and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
The security context for a job. For more information, see Configure a security context for a - * pod or container in the Kubernetes documentation.
+ *The security context for a job. For more information, see Configure a + * security context for a pod or container in the Kubernetes + * documentation.
*/ securityContext?: EksContainerSecurityContext; } @@ -3374,31 +3588,36 @@ export interface EksContainerDetail { */ export interface EksPodPropertiesDetail { /** - *The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account - * to assume an IAM role in the Amazon EKS User Guide and Configure service accounts - * for pods in the Kubernetes documentation.
+ *The name of the service account that's used to run the pod. For more information, see + * Kubernetes service + * accounts and Configure a Kubernetes service account + * to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes + * documentation.
*/ serviceAccountName?: string; /** - *Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this
- * to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't
- * require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and
- * Pod networking in the
- * Kubernetes documentation.
Indicates if the pod uses the hosts' network IP address. The default value is
+ * true. Setting this to false enables the Kubernetes pod networking model.
+ * Most Batch workloads are egress-only and don't require the overhead of IP allocation for each
+ * pod for incoming connections. For more information, see Host
+ * namespaces and Pod networking
+ * in the Kubernetes documentation.
The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork
- * parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates
- * that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver
- * inherited from the node. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no
- * value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The
- * pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending
- * on the value of the hostNetwork parameter. For more information, see Pod's DNS
- * policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst | ClusterFirstWithHostNet
+ *
The DNS policy for the pod. The default value is ClusterFirst. If the
+ * hostNetwork parameter is not specified, the default is
+ * ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query
+ * that does not match the configured cluster domain suffix is forwarded to the upstream nameserver
+ * inherited from the node. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for
+ * dnsPolicy by either of DescribeJobDefinitions
+ * or DescribeJobs API operations. The pod spec setting will contain either
+ * ClusterFirst or ClusterFirstWithHostNet, depending on the value of the
+ * hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst |
+ * ClusterFirstWithHostNet
*
The node index for the node. Node index numbering starts at zero. This index is also available on the node with
- * the AWS_BATCH_JOB_NODE_INDEX environment variable.
The node index for the node. Node index numbering starts at zero. This index is also
+ * available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
The current status for the job.
*If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the
- * troubleshooting section of the Batch User Guide.
If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE
+ * status in the troubleshooting section of the
+ * Batch User Guide.
The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs - * with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
+ *The scheduling policy of the job definition. This only affects jobs in job queues with a + * fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower + * scheduling priority.
*/ schedulingPriority?: number; @@ -3516,14 +3737,16 @@ export interface JobDetail { attempts?: AttemptDetail[]; /** - *A short, human-readable string to provide more details for the current status of the job.
+ *A short, human-readable string to provide more details for the current status of the + * job.
*/ statusReason?: string; /** - *The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs,
- * this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and
- * entered the PENDING state.
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
+ * parent array jobs, this is when the job entered the SUBMITTED state. This is
+ * specifically at the time SubmitJob was called. For array child jobs, this is
+ * when the child job was spawned by its parent and entered the PENDING state.
The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job
- * transitioned from the STARTING state to the RUNNING state. This parameter isn't provided
- * for child jobs of array jobs or multi-node parallel jobs.
The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's
+ * when the job transitioned from the STARTING state to the RUNNING state.
+ * This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job
- * transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or
- * FAILED.
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's
+ * when the job transitioned from the RUNNING state to a terminal state, such as
+ * SUCCEEDED or FAILED.
Additional parameters that are passed to the job that replace parameter substitution placeholders or override - * any corresponding parameter defaults from the job definition.
+ *Additional parameters that are passed to the job that replace parameter substitution + * placeholders or override any corresponding parameter defaults from the job definition.
*/ parameters?: RecordAn object that represents the details for the container that's associated with the job.
+ *An object that represents the details for the container that's associated with the + * job.
*/ container?: ContainerDetail; /** - *An object that represents the details of a node that's associated with a multi-node parallel job.
+ *An object that represents the details of a node that's associated with a multi-node parallel + * job.
*/ nodeDetails?: NodeDetails; @@ -3596,22 +3821,25 @@ export interface JobDetail { tags?: RecordSpecifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no
- * value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created.
- * For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined
- * tags from the job and job definition is over 50, the job is moved to the FAILED state.
Specifies whether to propagate the tags from the job or job definition to the corresponding
+ * Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to
+ * the tasks when the tasks are created. For tags with the same name, job tags are given priority
+ * over job definitions tags. If the total number of combined tags from the job and job definition
+ * is over 50, the job is moved to the FAILED state.
The platform capabilities required by the job definition. If no value is specified, it defaults to
- * EC2. Jobs run on Fargate resources specify FARGATE.
The platform capabilities required by the job definition. If no value is specified, it
+ * defaults to EC2. Jobs run on Fargate resources specify
+ * FARGATE.
An object with various properties that are specific to Amazon EKS based jobs. Only one of container,
- * eksProperties, or nodeDetails is specified.
An object with various properties that are specific to Amazon EKS based jobs. Only one of
+ * container, eksProperties, or nodeDetails is
+ * specified.
The Amazon Resource Name (ARN) of the scheduling policy. An example is
- * arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority
+ * arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority
* .
The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of - * a key and an optional value. For more information, see Tagging Amazon Web Services resources in Amazon Web Services General - * Reference.
+ *The tags that you apply to the scheduling policy to categorize and organize your resources. + * Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services resources in + * Amazon Web Services General Reference.
*/ tags?: RecordA filter name and value pair that's used to return a more specific list of results from a ListJobs
- * API operation.
A filter name and value pair that's used to return a more specific list of results from a
+ * ListJobs API operation.
A short (255 max characters) human-readable string to provide additional details for a running or stopped - * container.
+ *A short (255 max characters) human-readable string to provide additional details for a + * running or stopped container.
*/ reason?: string; } /** * @public - *An object that represents the properties of a node that's associated with a multi-node parallel job.
+ *An object that represents the properties of a node that's associated with a multi-node + * parallel job.
*/ export interface NodePropertiesSummary { /** @@ -3836,8 +4065,8 @@ export interface NodePropertiesSummary { numNodes?: number; /** - *The node index for the node. Node index numbering begins at zero. This index is also available on the node with
- * the AWS_BATCH_JOB_NODE_INDEX environment variable.
The node index for the node. Node index numbering begins at zero. This index is also
+ * available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs,
- * this is when the job entered the SUBMITTED state (at the time SubmitJob was called).
- * For array child jobs, this is when the child job was spawned by its parent and entered the PENDING
- * state.
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and
+ * parent array jobs, this is when the job entered the SUBMITTED state (at the time
+ * SubmitJob was called). For array child jobs, this is when the child job was
+ * spawned by its parent and entered the PENDING state.
A short, human-readable string to provide more details for the current status of the job.
+ *A short, human-readable string to provide more details for the current status of the + * job.
*/ statusReason?: string; /** - *The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the
- * STARTING state to the RUNNING state.
The Unix timestamp for when the job was started. More specifically, it's when the job
+ * transitioned from the STARTING state to the RUNNING state.
The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the
- * RUNNING state to a terminal state, such as SUCCEEDED or FAILED.
The Unix timestamp for when the job was stopped. More specifically, it's when the job
+ * transitioned from the RUNNING state to a terminal state, such as
+ * SUCCEEDED or FAILED.
An object that represents the details of the container that's associated with the job.
+ *An object that represents the details of the container that's associated with the + * job.
*/ container?: ContainerSummary; @@ -3966,7 +4198,7 @@ export interface ListSchedulingPoliciesRequest { /** * @public *An object that contains the details of a scheduling policy that's returned in a
- * ListSchedulingPolicy action.
ListSchedulingPolicy action.
*/
export interface SchedulingPolicyListingDetail {
/**
@@ -4160,50 +4392,54 @@ export interface ContainerOverrides {
/**
* @deprecated
*
- * This parameter is deprecated, use resourceRequirements to override the vcpus parameter
- * that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2
- * resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU
- * requirement specified in the resourceRequirements structure in the job definition. To override vCPU
- * requirements that are specified in the resourceRequirements structure in the job definition,
- * resourceRequirements must be specified in the SubmitJob request, with type set
- * to VCPU and value set to the new value. For more information, see Can't override job
- * definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the
+ * vcpus parameter that's set in the job definition. It's not supported for jobs
+ * running on Fargate resources. For jobs that run on EC2 resources, it overrides the
+ * vcpus parameter set in the job definition, but doesn't override any vCPU
+ * requirement specified in the resourceRequirements structure in the job definition.
+ * To override vCPU requirements that are specified in the resourceRequirements
+ * structure in the job definition, resourceRequirements must be specified in the
+ * SubmitJob request, with type set to VCPU and
+ * value set to the new value. For more information, see Can't override job
+ * definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the memory requirements
- * specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2
- * resources, it overrides the memory parameter set in the job definition, but doesn't override any memory
- * requirement that's specified in the resourceRequirements structure in the job definition. To override
- * memory requirements that are specified in the resourceRequirements structure in the job definition,
- * resourceRequirements must be specified in the SubmitJob request, with type set
- * to MEMORY and value set to the new value. For more information, see Can't override job
- * definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the memory
+ * requirements specified in the job definition. It's not supported for jobs running on Fargate
+ * resources. For jobs that run on EC2 resources, it overrides the memory parameter set
+ * in the job definition, but doesn't override any memory requirement that's specified in the
+ * resourceRequirements structure in the job definition. To override memory
+ * requirements that are specified in the resourceRequirements structure in the job
+ * definition, resourceRequirements must be specified in the SubmitJob
+ * request, with type set to MEMORY and value set to the new
+ * value. For more information, see Can't override job
+ * definition resource requirements in the Batch User Guide.
The command to send to the container that overrides the default command from the Docker image or the job - * definition.
+ *The command to send to the container that overrides the default command from the Docker + * image or the job definition.
*/ command?: string[]; /** *The instance type to use for a multi-node parallel job.
*This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and - * shouldn't be provided.
+ *This parameter isn't applicable to single-node container jobs or jobs that run on Fargate + * resources, and shouldn't be provided.
*The environment variables to send to the container. You can add new environment variables, which are added to - * the container at launch, or you can override the existing environment variables from the Docker image or the job - * definition.
+ *The environment variables to send to the container. You can add new environment variables, + * which are added to the container at launch, or you can override the existing environment + * variables from the Docker image or the job definition.
*Environment variables cannot start with "AWS_BATCH". This naming
* convention is reserved for variables that Batch sets.
The type and amount of resources to assign to a container. This overrides the settings in the job definition.
- * The supported resources include GPU, MEMORY, and VCPU.
The type and amount of resources to assign to a container. This overrides the settings in
+ * the job definition. The supported resources include GPU, MEMORY, and
+ * VCPU.
Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API - * operation.
+ *Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.
*/ export interface EksContainerOverride { /** @@ -4230,23 +4466,23 @@ export interface EksContainerOverride { image?: string; /** - *The command to send to the container that overrides the default command from the Docker image or the job - * definition.
+ *The command to send to the container that overrides the default command from the Docker + * image or the job definition.
*/ command?: string[]; /** - *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 CMD in the Dockerfile - * reference and Define a command an - * arguments for a pod in the Kubernetes documentation.
+ *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 CMD in the + * Dockerfile reference and Define a command an arguments for a pod in the Kubernetes + * documentation.
*/ args?: string[]; /** - *The environment variables to send to the container. You can add new environment variables, which are added to - * the container at launch. Or, you can override the existing environment variables from the Docker image or the job - * definition.
+ *The environment variables to send to the container. You can add new environment variables, + * which are added to the container at launch. Or, you can override the existing environment + * variables from the Docker image or the job definition.
*Environment variables cannot start with "AWS_BATCH". This naming
* convention is reserved for variables that Batch sets.
The type and amount of resources to assign to a container. These override the settings in the job definition.
- * The supported resources include memory, cpu, and nvidia.com/gpu. For more
- * information, see Resource
- * management for pods and containers in the Kubernetes documentation.
The type and amount of resources to assign to a container. These override the settings in
+ * the job definition. The supported resources include memory, cpu, and
+ * nvidia.com/gpu. For more information, see Resource
+ * management for pods and containers in the Kubernetes
+ * documentation.
The overrides for the container that's used on the Amazon EKS pod.
*/ containers?: EksContainerOverride[]; + + metadata?: EksMetadata; } /** @@ -4287,15 +4526,15 @@ export interface EksPropertiesOverride { /** * @public - *The object that represents any node overrides to a job definition that's used in a SubmitJob - * API operation.
+ *The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
*/ export interface NodePropertyOverride { /** - *The range of nodes, using node index values, that's used to override. A range of 0:3 indicates
- * nodes with index values of 0 through 3. If the starting range value is omitted
- * (:n), then 0 is used to start the range. If the ending range value is omitted
- * (n:), then the highest possible node index is used to end the range.
The range of nodes, using node index values, that's used to override. A range of
+ * 0:3 indicates nodes with index values of 0 through 3. If
+ * the starting range value is omitted (:n), then 0 is used to start the
+ * range. If the ending range value is omitted (n:), then the highest possible node
+ * index is used to end the range.
An object that represents any node overrides to a job definition that's used in a SubmitJob - * API operation.
+ *An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these
- * jobs. Rather, use containerOverrides instead.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't
+ * provide it for these jobs. Rather, use containerOverrides instead.
The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are - * specified in the job definition. To use this override, you must meet the following conditions:
+ *The number of nodes to use with a multi-node parallel job. This value overrides the number + * of nodes that are specified in the job definition. To use this override, you must meet the + * following conditions:
*There must be at least one node range in your job definition that has an open upper boundary, such as
- * : or n:.
There must be at least one node range in your job definition that has an open upper
+ * boundary, such as : or n:.
The lower boundary of the node range that's specified in the job definition must be fewer than the number of - * nodes specified in the override.
+ *The lower boundary of the node range that's specified in the job definition must be fewer + * than the number of nodes specified in the override.
*The main node index that's specified in the job definition must be fewer than the number of nodes specified in - * the override.
+ *The main node index that's specified in the job definition must be fewer than the number + * of nodes specified in the override.
*The job definition used by this job. This value can be one of name, name:revision, or
- * the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active
- * revision is used.
The job definition used by this job. This value can be one of definition-name,
+ * definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with or without the revision
+ * (arn:aws:batch:region:account:job-definition/definition-name:revision
+ * ,
+ * or
+ * arn:aws:batch:region:account:job-definition/definition-name
+ * ).
If the revision is not specified, then the latest active revision is used.
*/ jobDefinition: string | undefined; @@ -4558,14 +4802,14 @@ export enum CRUpdateAllocationStrategy { /** * @public - *An object that represents the attributes of a compute environment that can be updated. For more information, see - * Updating compute environments - * in the Batch User Guide.
+ *An object that represents the attributes of a compute environment that can be updated. For + * more information, see Updating compute environments in the + * Batch User Guide.
*/ export interface ComputeResourceUpdate { /** - *The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is
- * DISABLED).
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute
+ * environment is DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The maximum number of Amazon EC2 vCPUs that an environment can reach.
*With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies
- * using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never
- * exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among
- * those specified in your compute environment.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED
+ * allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy
+ * using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity
+ * requirements. In this event, Batch never exceeds maxvCpus by more than a single
+ * instance. That is, no more than a single instance from among those specified in your compute
+ * environment.
The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum - * and maximum values based on job queue demand.
+ *The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value + * between the minimum and maximum values based on job queue demand.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*Batch doesn't support changing the desired number of vCPUs of an existing compute environment. Don't specify - * this parameter for compute environments using Amazon EKS clusters.
+ *Batch doesn't support changing the desired number of vCPUs of an existing compute + * environment. Don't specify this parameter for compute environments using Amazon EKS clusters.
+ *When you update the desiredvCpus setting, the value must be between the
+ * minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to
+ * the current desiredvCpus value. For more information, see Troubleshooting
+ * Batch in the Batch User Guide.
Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see - * Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local - * Zones in the Amazon EKS User Guide and - * Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the - * Amazon ECS Developer Guide.
+ *Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local + * Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local + * Zones in the Amazon EKS User Guide and Amazon ECS + * clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS + * Developer Guide.
*Batch on Fargate doesn't currently support Local Zones.
*The Amazon EC2 security groups that are associated with instances launched in the compute environment. This parameter - * is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute - * resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For EC2 - * compute resources, providing an empty list removes the security groups from the compute resource.
- *When updating a compute environment, changing the EC2 security groups requires an infrastructure update of the - * compute environment. For more information, see Updating compute environments in the - * Batch User Guide.
+ *The Amazon EC2 security groups that are associated with instances launched in the compute + * environment. This parameter is required for Fargate compute resources, where it can contain up + * to 5 security groups. For Fargate compute resources, providing an empty list is handled as if + * this parameter wasn't specified and no change is made. For EC2 compute resources, providing an + * empty list removes the security groups from the compute resource.
+ *When updating a compute environment, changing the EC2 security groups requires an + * infrastructure update of the compute environment. For more information, see Updating compute + * environments in the Batch User Guide.
*/ securityGroupIds?: string[]; /** - *The allocation strategy to use for the compute resource if there's not enough instances of the best fitting - * instance type that can be allocated. This might be because of availability of the instance type in the Region or - * Amazon EC2 service limits. For - * more information, see Allocation - * strategies in the Batch User Guide.
- *When updating a compute environment, changing the allocation strategy requires an infrastructure update of the
- * compute environment. For more information, see Updating compute environments in the
- * Batch User Guide. BEST_FIT isn't supported when updating a compute
- * environment.
The allocation strategy to use for the compute resource if there's not enough instances of + * the best fitting instance type that can be allocated. This might be because of availability of + * the instance type in the Region or Amazon EC2 service limits. For more + * information, see Allocation strategies in the Batch User Guide.
+ *When updating a compute environment, changing the allocation strategy requires an
+ * infrastructure update of the compute environment. For more information, see Updating compute
+ * environments in the Batch User Guide. BEST_FIT isn't
+ * supported when updating a compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*Batch selects additional instance types that are large enough to meet the requirements of the jobs in the - * queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously - * selected instance types aren't available, Batch selects new instance types.
+ *Batch selects additional instance types that are large enough to meet the requirements + * of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If + * additional instances of the previously selected instance types aren't available, Batch + * selects new instance types.
*Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the - * queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is - * only available for Spot Instance compute resources.
+ *Batch selects one or more instance types that are large enough to meet the requirements + * of the jobs in the queue. Its preference is for instance types that are less likely to be + * interrupted. This allocation strategy is only available for Spot Instance compute + * resources.
*With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using On-Demand
- * or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed
- * maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus
- * by more than a single instance.
With both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED
+ * strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot
+ * Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.
+ * In this event, Batch never exceeds maxvCpus by more than a single instance.
The instances types that can be launched. You can specify instance families to launch any instance type within
- * those families (for example, c5 or p3), or you can specify specific sizes within a family
- * (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,
- * M4, and R4 instance families) that match the demand of your job queues.
When updating a compute environment, changing this setting requires an infrastructure update of the compute - * environment. For more information, see Updating compute environments in the Batch User Guide.
+ *The instances types that can be launched. You can specify instance families to launch any
+ * instance type within those families (for example, c5 or p3), or you can
+ * specify specific sizes within a family (such as c5.8xlarge). You can also choose
+ * optimal to select instance types (from the C4, M4, and R4 instance families) that
+ * match the demand of your job queues.
When updating a compute environment, changing this setting requires an infrastructure update + * of the compute environment. For more information, see Updating compute environments in the + * Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that
- * don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are
- * used.
Currently, optimal uses instance types from the C4, M4, and R4 instance
+ * families. In Regions that don't have instance types from those instance families, instance types
+ * from the C5, M5, and R5 instance families are used.
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to - * log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.
- *When updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute - * environment. For more information, see Updating compute environments in the Batch User Guide.
+ *The Amazon EC2 key pair that's used for instances launched in the compute environment. You can + * use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this + * value to an empty string.
+ *When updating a compute environment, changing the EC2 key pair requires an infrastructure + * update of the compute environment. For more information, see Updating compute environments in the + * Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name
- * or full Amazon Resource Name (ARN) of an instance profile. For example, The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can
+ * specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,
+ * When updating a compute environment, changing this setting requires an infrastructure update of the compute
- * environment. For more information, see Updating compute environments in the Batch User Guide.
+ *
* ecsInstanceRole
* or
- * arn:aws:iam::arn:aws:iam::.
- * For more information, see Amazon ECS instance
- * role in the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update + * of the compute environment. For more information, see Updating compute environments in the + * Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,
- * these take the form of "String1": "String2", where String1 is the tag key and
- * String2 is the tag value-for example, \{ "Name": "Batch Instance - C4OnDemand" \}. This is
- * helpful for recognizing your Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch
- * ListTagsForResource API operation.
When updating a compute environment, changing this setting requires an infrastructure update of the compute - * environment. For more information, see Updating compute environments in the Batch User Guide.
+ *Key-value pair tags to be applied to EC2 resources that are launched in the compute
+ * environment. For Batch, these take the form of "String1": "String2", where
+ * String1 is the tag key and String2 is the tag value-for example,
+ * \{ "Name": "Batch Instance - C4OnDemand" \}. This is helpful for recognizing your
+ * Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch
+ * ListTagsForResource API operation.
When updating a compute environment, changing this setting requires an infrastructure update + * of the compute environment. For more information, see Updating compute environments in the + * Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel - * jobs to your compute environment, you should consider creating a cluster placement group and associate it with your - * compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single - * Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for - * Linux Instances.
- *When updating a compute environment, changing the placement group requires an infrastructure update of the - * compute environment. For more information, see Updating compute environments in the - * Batch User Guide.
+ *The Amazon EC2 placement group to associate with your compute resources. If you intend to submit + * multi-node parallel jobs to your compute environment, you should consider creating a cluster + * placement group and associate it with your compute resources. This keeps your multi-node parallel + * job on a logical grouping of instances within a single Availability Zone with high network flow + * potential. For more information, see Placement groups in the + * Amazon EC2 User Guide for Linux Instances.
+ *When updating a compute environment, changing the placement group requires an infrastructure + * update of the compute environment. For more information, see Updating compute environments in the + * Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that - * instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be - * less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and - * never more than your maximum percentage. For - * most use cases, we recommend leaving this field empty.
- *When updating a compute environment, changing the bid percentage requires an infrastructure update of the - * compute environment. For more information, see Updating compute environments in the - * Batch User Guide.
+ *The maximum percentage that a Spot Instance price can be when compared with the On-Demand + * price for that instance type before instances are launched. For example, if your maximum + * percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that + * Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum + * percentage. For most use + * cases, we recommend leaving this field empty.
+ *When updating a compute environment, changing the bid percentage requires an infrastructure + * update of the compute environment. For more information, see Updating compute environments in the + * Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*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 Launch template support in the Batch User Guide.
- * To remove the custom launch template and use the default launch template, set launchTemplateId or
- * launchTemplateName 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 updateToLatestImageVersion parameter must be set to
- * true.
When updating a compute environment, changing the launch template requires an infrastructure update of the - * compute environment. For more information, see Updating compute environments in the - * Batch User Guide.
+ *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 Launch template
+ * support in the Batch User Guide. To remove the custom launch
+ * template and use the default launch template, set launchTemplateId or
+ * launchTemplateName 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
+ * updateToLatestImageVersion parameter must be set to true.
When updating a compute environment, changing the launch template requires an infrastructure + * update of the compute environment. For more information, see Updating compute environments in the + * Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.
- * If Ec2Configuration isn't specified, the default is ECS_AL2.
When updating a compute environment, changing this setting requires an infrastructure update of the compute
- * environment. For more information, see Updating compute environments in the Batch User Guide. To remove the EC2 configuration
- * and any custom AMI ID specified in imageIdOverride, set this value to an empty string.
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the
+ * compute environment. If Ec2Configuration isn't specified, the default is
+ * ECS_AL2.
When updating a compute environment, changing this setting requires an infrastructure update
+ * of the compute environment. For more information, see Updating compute environments in the
+ * Batch User Guide. To remove the EC2 configuration and any custom AMI ID
+ * specified in imageIdOverride, set this value to an empty string.
One or two values can be provided.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
@@ -4788,39 +5056,44 @@ export interface ComputeResourceUpdate { ec2Configuration?: Ec2Configuration[]; /** - *Specifies whether the AMI ID is updated to the latest one that's supported by Batch when the compute
- * environment has an infrastructure update. The default value is false.
Specifies whether the AMI ID is updated to the latest one that's supported by Batch when
+ * the compute environment has an infrastructure update. The default value is
+ * false.
An AMI ID can either be specified in the imageId or imageIdOverride parameters or be
- * determined by the launch template that's specified in the launchTemplate parameter. If an AMI ID is
- * specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an
- * infrastructure update, see Updating the AMI ID in
- * the Batch User Guide.
An AMI ID can either be specified in the imageId or
+ * imageIdOverride parameters or be determined by the launch template that's
+ * specified in the launchTemplate parameter. If an AMI ID is specified any of these
+ * ways, this parameter is ignored. For more information about to update AMI IDs during an
+ * infrastructure update, see Updating
+ * the AMI ID in the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update of the compute - * environment. For more information, see Updating compute environments in the Batch User Guide.
+ *When updating a compute environment, changing this setting requires an infrastructure update + * of the compute environment. For more information, see Updating compute environments in the + * Batch User Guide.
*/ updateToLatestImageVersion?: boolean; /** - *The type of compute environment: EC2, SPOT, FARGATE, or
- * FARGATE_SPOT. For more information, see Compute environments in the
- * Batch User Guide.
The type of compute environment: EC2, SPOT, FARGATE,
+ * or FARGATE_SPOT. For more information, see Compute environments in the
+ * Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the
- * spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the
- * Batch User Guide.
When updating a compute environment, changing the type of a compute environment requires an infrastructure - * update of the compute environment. For more information, see Updating compute environments in the - * Batch User Guide.
+ *spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the
+ * Batch User Guide.
+ * When updating a compute environment, changing the type of a compute environment requires an + * infrastructure update of the compute environment. For more information, see Updating compute + * environments in the Batch User Guide.
*/ type?: CRType | string; /** - *The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is
- * overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the
- * custom AMI ID and use the default AMI ID, set this value to an empty string.
When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute - * environment. For more information, see Updating compute environments in the Batch User Guide.
+ *The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
+ * This parameter is overridden by the imageIdOverride member of the
+ * Ec2Configuration structure. To remove the custom AMI ID and use the default AMI ID,
+ * set this value to an empty string.
When updating a compute environment, changing the AMI ID requires an infrastructure update + * of the compute environment. For more information, see Updating compute environments in the + * Batch User Guide.
*This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
*The state of the compute environment. Compute environments in the ENABLED state can accept jobs
- * from a queue and scale in or out automatically based on the workload demand of its associated queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated
- * job queue on the compute resources within the environment. If the compute environment is managed, then it can scale
- * its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the
- * environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed
- * compute environments in the DISABLED state don't scale out. However, they scale in to
- * minvCpus value after instances become idle.
The state of the compute environment. Compute environments in the ENABLED
+ * state can accept jobs from a queue and scale in or out automatically based on the workload
+ * demand of its associated queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs
+ * from an associated job queue on the compute resources within the environment. If the compute
+ * environment is managed, then it can scale its instances out or in automatically, based on the
+ * job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place
+ * jobs within the environment. Jobs in a STARTING or RUNNING state
+ * continue to progress normally. Managed compute environments in the DISABLED state
+ * don't scale out.
Compute environments in a DISABLED state may continue to incur billing
+ * charges. To prevent additional charges, turn off and then delete the compute environment.
+ * For more information, see State in the Batch User Guide.
When an instance is idle, the instance scales down to the minvCpus value.
+ * However, the instance size doesn't change. For example, consider a c5.8xlarge
+ * instance with a minvCpus value of 4 and a desiredvCpus
+ * value of 36. This instance doesn't scale down to a c5.large
+ * instance.
The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this * parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU - * capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity - * is reserved.
+ * capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is + * reserved. */ unmanagedvCpus?: number; diff --git a/clients/client-batch/src/protocols/Aws_restJson1.ts b/clients/client-batch/src/protocols/Aws_restJson1.ts index 3eda02fd9d812..4312c7bed29f3 100644 --- a/clients/client-batch/src/protocols/Aws_restJson1.ts +++ b/clients/client-batch/src/protocols/Aws_restJson1.ts @@ -117,6 +117,7 @@ import { EksContainerVolumeMount, EksEmptyDir, EksHostPath, + EksMetadata, EksPodProperties, EksPodPropertiesDetail, EksPodPropertiesOverride, @@ -125,6 +126,7 @@ import { EksPropertiesOverride, EksSecret, EksVolume, + EphemeralStorage, EvaluateOnExit, FairsharePolicy, FargatePlatformConfiguration, @@ -2075,6 +2077,9 @@ const serializeAws_restJson1ContainerProperties = (input: ContainerProperties, c ...(input.environment != null && { environment: serializeAws_restJson1EnvironmentVariables(input.environment, context), }), + ...(input.ephemeralStorage != null && { + ephemeralStorage: serializeAws_restJson1EphemeralStorage(input.ephemeralStorage, context), + }), ...(input.executionRoleArn != null && { executionRoleArn: input.executionRoleArn }), ...(input.fargatePlatformConfiguration != null && { fargatePlatformConfiguration: serializeAws_restJson1FargatePlatformConfiguration( @@ -2310,6 +2315,16 @@ const serializeAws_restJson1EksHostPath = (input: EksHostPath, context: __SerdeC }; }; +const serializeAws_restJson1EksLabelsMap = (input: RecordA summary of the number of array job children in each available job status. This parameter is returned for\n parent array jobs.
" + "smithy.api#documentation": "A summary of the number of array job children in each available job status. This parameter\n is returned for parent array jobs.
" } }, "size": { @@ -1986,7 +1198,7 @@ "index": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The job index within the array that's associated with this job. This parameter is returned for array job\n children.
" + "smithy.api#documentation": "The job index within the array that's associated with this job. This parameter is returned\n for array job children.
" } } }, @@ -2006,7 +1218,7 @@ "index": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The job index within the array that's associated with this job. This parameter is returned for children of array\n jobs.
" + "smithy.api#documentation": "The job index within the array that's associated with this job. This parameter is returned\n for children of array jobs.
" } } }, @@ -2043,7 +1255,7 @@ "taskArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container attempt receives a task\n ARN when they reach the STARTING status.
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container\n attempt receives a task ARN when they reach the STARTING status.
A short (255 max characters) human-readable string to provide additional details for a running or stopped\n container.
" + "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a\n running or stopped container.
" } }, "logStreamName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs\n is /aws/batch/job. Each container attempt receives a log stream name when they reach the\n RUNNING status.
The name of the CloudWatch Logs log stream that's associated with the container. The log\n group for Batch jobs is /aws/batch/job. Each container attempt receives a log\n stream name when they reach the RUNNING status.
The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the\n STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt\n transitioned from the STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the\n RUNNING state to a terminal state, such as SUCCEEDED or FAILED).
The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt\n transitioned from the RUNNING state to a terminal state, such as\n SUCCEEDED or FAILED).
A short, human-readable string to provide additional details for the current status of the job attempt.
" + "smithy.api#documentation": "A short, human-readable string to provide additional details for the current status of the\n job attempt.
" } } }, @@ -2277,7 +1489,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED, PENDING, or\n RUNNABLE state are canceled. Jobs that progressed to the STARTING or RUNNING\n state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be\n terminated with the TerminateJob operation.
Cancels a job in an Batch job queue. Jobs that are in the\n SUBMITTED\n or\n PENDING\n are\n canceled. A job\n inRUNNABLE remains in RUNNABLE until it reaches the head of the\n job queue. Then the job status is updated to\n FAILED.
Jobs that progressed to the STARTING or\n RUNNING state aren't canceled. However, the API operation still succeeds, even\n if no job is canceled. These jobs must be terminated with the TerminateJob\n operation.
Contains the parameters for CancelJob.
Contains the parameters for CancelJob.
The type of the compute environment: MANAGED or UNMANAGED. For more information, see\n Compute environments in the\n Batch User Guide.
The type of the compute environment: MANAGED or UNMANAGED. For\n more information, see Compute environments in the Batch User Guide.
The state of the compute environment. The valid values are ENABLED or DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated\n job queue on the compute resources within the environment. If the compute environment is managed, then it can scale\n its instances out or in automatically based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the\n environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed\n compute environments in the DISABLED state don't scale out. However, they scale in to\n minvCpus value after instances become idle.
The state of the compute environment. The valid values are ENABLED or\n DISABLED.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs\n from an associated job queue on the compute resources within the environment. If the compute\n environment is managed, then it can scale its instances out or in automatically based on the job\n queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place\n jobs within the environment. Jobs in a STARTING or RUNNING state\n continue to progress normally. Managed compute environments in the DISABLED state\n don't scale out.
Compute environments in a DISABLED state may continue to incur billing\n charges. To prevent additional charges, turn off and then delete the compute environment. For\n more information, see State in the Batch User Guide.
When an instance is idle, the instance scales down to the minvCpus value.\n However, the instance size doesn't change. For example, consider a c5.8xlarge\n instance with a minvCpus value of 4 and a desiredvCpus\n value of 36. This instance doesn't scale down to a c5.large\n instance.
The current status of the compute environment (for example, CREATING or VALID).
The current status of the compute environment (for example, CREATING or\n VALID).
A short, human-readable string to provide additional details for the current status of the compute\n environment.
" + "smithy.api#documentation": "A short, human-readable string to provide additional details for the current status of the\n compute environment.
" } }, "computeResources": { "target": "com.amazonaws.batch#ComputeResource", "traits": { - "smithy.api#documentation": "The compute resources defined for the compute environment. For more information, see Compute environments in the\n Batch User Guide.
" + "smithy.api#documentation": "The compute resources defined for the compute environment. For more information, see Compute environments in\n the Batch User Guide.
" } }, "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API\n operations on your behalf. For more information, see Batch service IAM role in the\n Batch User Guide.
" + "smithy.api#documentation": "The service role that's associated with the compute environment that allows Batch to make\n calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in\n the Batch User Guide.
" } }, "updatePolicy": { "target": "com.amazonaws.batch#UpdatePolicy", "traits": { - "smithy.api#documentation": "Specifies the infrastructure update policy for the compute environment. For more information about\n infrastructure updates, see Updating\n compute environments in the Batch User Guide.
" + "smithy.api#documentation": "Specifies the infrastructure update policy for the compute environment. For more information\n about infrastructure updates, see Updating compute environments in the\n Batch User Guide.
" } }, "eksConfiguration": { "target": "com.amazonaws.batch#EksConfiguration", "traits": { - "smithy.api#documentation": "The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this\n parameter if the containerOrchestrationType is EKS.
The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only\n specify this parameter if the containerOrchestrationType is EKS.
The orchestration type of the compute environment. The valid values are ECS (default) or\n EKS.
The orchestration type of the compute environment. The valid values are ECS\n (default) or EKS.
The order of the compute environment. Compute environments are tried in ascending order. For example, if two\n compute environments are associated with a job queue, the compute environment with a lower order integer\n value is tried for job placement first.
The order of the compute environment. Compute environments are tried in ascending order. For\n example, if two compute environments are associated with a job queue, the compute environment\n with a lower order integer value is tried for job placement first.
The order that compute environments are tried in for job placement within a queue. Compute environments are\n tried in ascending order. For example, if two compute environments are associated with a job queue, the compute\n environment with a lower order integer value is tried for job placement first. Compute environments must be in the\n VALID state before you can associate them with a job queue. All of the compute environments must be\n either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT);\n EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same architecture. Batch doesn't\n support mixing compute environment architecture types in a single job queue.
\nThe order that compute environments are tried in for job placement within a queue. Compute\n environments are tried in ascending order. For example, if two compute environments are\n associated with a job queue, the compute environment with a lower order integer value is tried\n for job placement first. Compute environments must be in the VALID state before you\n can associate them with a job queue. All of the compute environments must be either EC2\n (EC2 or SPOT) or Fargate (FARGATE or\n FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.
All compute environments that are associated with a job queue must share the same\n architecture. Batch doesn't support mixing compute environment architecture types in a single\n job queue.
\nThe type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.
The type of compute environment: EC2, SPOT, FARGATE,\n or FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.
The allocation strategy to use for the compute resource if not enough instances of the best fitting instance\n type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies\n in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost\n instance type. If additional instances of the selected instance type aren't available, Batch waits for the\n additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service limits,\n additional jobs aren't run until the currently running jobs are completed. This allocation strategy keeps costs\n lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must\n be specified. Compute resources that use a BEST_FIT allocation strategy don't support infrastructure\n updates and can't update some parameters. For more information, see Updating compute environments in the\n Batch User Guide.
Batch selects additional instance types that are large enough to meet the requirements of the jobs in the\n queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously\n selected instance types aren't available, Batch selects new instance types.
\nBatch selects one or more instance types that are large enough to meet the requirements of the jobs in the\n queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is\n only available for Spot Instance compute resources.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using On-Demand\n or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus\n by more than a single instance.
The allocation strategy to use for the compute resource if not enough instances of the best\n fitting instance type can be allocated. This might be because of availability of the instance\n type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch selects an instance type that best fits the needs of the jobs with a preference\n for the lowest-cost instance type. If additional instances of the selected instance type\n aren't available, Batch waits for the additional instances to be available. If there aren't\n enough instances available or the user is reaching Amazon EC2 service limits,\n additional jobs aren't run until the currently running jobs are completed. This allocation\n strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with\n BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use\n a BEST_FIT allocation strategy don't support infrastructure updates and can't\n update some parameters. For more information, see Updating compute environments in\n the Batch User Guide.
Batch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.
\nBatch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.
The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute\n environment is DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum number of Amazon EC2 vCPUs that a compute environment can reach.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies\n using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never\n exceeds maxvCpus by more than a single instance. For example, no more than a single instance from among\n those specified in your compute environment is allocated.
The maximum number of Amazon EC2 vCPUs that a compute environment can reach.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. For example, no more than a single instance from among those specified in your compute\n environment is allocated.
The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum\n and maximum values based on job queue demand.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value\n between the minimum and maximum values based on job queue demand.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe instances types that can be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,\n M4, and R4 instance families) that match the demand of your job queues.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nWhen you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.
\nCurrently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that\n don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are\n used.
The instances types that can be launched. You can specify instance families to launch any\n instance type within those families (for example, c5 or p3), or you can\n specify specific sizes within a family (such as c5.8xlarge). You can also choose\n optimal to select instance types (from the C4, M4, and R4 instance families) that\n match the demand of your job queues.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nWhen you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.
\nCurrently, optimal uses instance types from the C4, M4, and R4 instance\n families. In Regions that don't have instance types from those instance families, instance types\n from the C5, M5, and R5 instance families are used.
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is\n overridden by the imageIdOverride member of the Ec2Configuration structure.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.
\nThe Amazon Machine Image (AMI) ID used for instances launched in the compute environment.\n This parameter is overridden by the imageIdOverride member of the\n Ec2Configuration structure.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.
\nThe VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate\n compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User\n Guide.
\nBatch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see\n Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and \n Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the\n Amazon ECS Developer Guide.
\nBatch on Fargate doesn't currently support Local Zones.
\nThe VPC subnets where the compute resources are launched. These subnets must be within the\n same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see\n VPCs and subnets\n in the Amazon VPC User Guide.
\nBatch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local\n Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and Amazon ECS\n clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS\n Developer Guide.
\nBatch on Fargate doesn't currently support Local Zones.
\nThe Amazon EC2 security groups that are associated with instances launched in the compute environment. One or more\n security groups must be specified, either in securityGroupIds or using a launch template referenced in\n launchTemplate. This parameter is required for jobs that are running on Fargate resources and must\n contain at least one security group. Fargate doesn't support launch templates. If security groups are specified\n using both securityGroupIds and launchTemplate, the values in securityGroupIds\n are used.
The Amazon EC2 security groups that are associated with instances launched in the compute\n environment. One or more security groups must be specified, either in\n securityGroupIds or using a launch template referenced in\n launchTemplate. This parameter is required for jobs that are running on Fargate\n resources and must contain at least one security group. Fargate doesn't support launch\n templates. If security groups are specified using both securityGroupIds and\n launchTemplate, the values in securityGroupIds are used.
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon EC2 key pair that's used for instances launched in the compute environment. You can\n use this key pair to log in to your instances with SSH.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example, \n ecsInstanceRole\n or\n arn:aws:iam::.\n For more information, see Amazon ECS instance\n role in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can\n specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam::.\n For more information, see Amazon ECS instance role in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nKey-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and\n String2 is the tag value-for example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is\n helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure\n update to the compute environment. For more information, see Updating compute environments in the\n Batch User Guide. These tags aren't seen when using the Batch ListTagsForResource\n API operation.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nKey-value pair tags to be applied to EC2 resources that are launched in the compute\n environment. For Batch, these take the form of \"String1\": \"String2\", where\n String1 is the tag key and String2 is the tag value-for example,\n { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your\n Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to\n the compute environment. For more information, see Updating compute environments in the\n Batch User Guide. These tags aren't seen when using the Batch\n ListTagsForResource API operation.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel\n jobs to your compute environment, you should consider creating a cluster placement group and associate it with your\n compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single\n Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for\n Linux Instances.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon EC2 placement group to associate with your compute resources. If you intend to submit\n multi-node parallel jobs to your compute environment, you should consider creating a cluster\n placement group and associate it with your compute resources. This keeps your multi-node parallel\n job on a logical grouping of instances within a single Availability Zone with high network flow\n potential. For more information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must\n be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price. For most use cases, we recommend\n leaving this field empty.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand\n price for that instance type before instances are launched. For example, if your maximum\n percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for\n that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum\n percentage. If you leave this field empty, the default value is 100% of the On-Demand\n price. For most use cases,\n we recommend leaving this field empty.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is\n required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For\n more information, see Amazon EC2 spot fleet\n role in the Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nTo tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot\n Instances. For more information, see Spot instances not tagged on creation in the\n Batch User Guide.
\nThe Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute\n environment. This role is required if the allocation strategy set to BEST_FIT or if\n the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nTo tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use\n the newer AmazonEC2SpotFleetTaggingRole managed policy. The\n previously recommended AmazonEC2SpotFleetRole managed policy\n doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances\n not tagged on creation in the Batch User Guide.
\nThe launch template to use for your compute resources. Any other compute resource parameters that you specify in\n a CreateComputeEnvironment API operation override the same parameters in the launch template. You\n must specify either the launch template ID or launch template name in the request, but not both. For more\n information, see Launch template support in\n the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe launch template to use for your compute resources. Any other compute resource parameters\n that you specify in a CreateComputeEnvironment API operation override the same\n parameters in the launch template. You must specify either the launch template ID or launch\n template name in the request, but not both. For more information, see Launch template support in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nProvides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in the compute\n environment. If Ec2Configuration isn't specified, the default is ECS_AL2.
One or two values can be provided.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nProvides information that's used to select Amazon Machine Images (AMIs) for EC2 instances in\n the compute environment. If Ec2Configuration isn't specified, the default is\n ECS_AL2.
One or two values can be provided.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nAn object that represents an Batch compute resource. For more information, see Compute environments in the\n Batch User Guide.
" + "smithy.api#documentation": "An object that represents an Batch compute resource. For more information, see Compute environments in\n the Batch User Guide.
" } }, "com.amazonaws.batch#ComputeResourceUpdate": { @@ -2580,108 +1796,108 @@ "minvCpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute environment is\n DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe minimum number of Amazon EC2 vCPUs that an environment should maintain (even if the compute\n environment is DISABLED).
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum number of Amazon EC2 vCPUs that an environment can reach.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED allocation strategies\n using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never\n exceeds maxvCpus by more than a single instance. That is, no more than a single instance from among\n those specified in your compute environment.
The maximum number of Amazon EC2 vCPUs that an environment can reach.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n allocation strategies using On-Demand or Spot Instances, and the BEST_FIT strategy\n using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity\n requirements. In this event, Batch never exceeds maxvCpus by more than a single\n instance. That is, no more than a single instance from among those specified in your compute\n environment.
The desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value between the minimum\n and maximum values based on job queue demand.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch doesn't support changing the desired number of vCPUs of an existing compute environment. Don't specify\n this parameter for compute environments using Amazon EKS clusters.
\nThe desired number of Amazon EC2 vCPUS in the compute environment. Batch modifies this value\n between the minimum and maximum values based on job queue demand.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch doesn't support changing the desired number of vCPUs of an existing compute\n environment. Don't specify this parameter for compute environments using Amazon EKS clusters.
\nWhen you update the desiredvCpus setting, the value must be between the\n minvCpus and maxvCpus values.
Additionally, the updated desiredvCpus value must be greater than or equal to\n the current desiredvCpus value. For more information, see Troubleshooting\n Batch in the Batch User Guide.
The VPC subnets where the compute resources are launched. Fargate compute resources can\n contain up to 16 subnets. For Fargate compute resources, providing an empty list will be\n handled as if this parameter wasn't specified and no change is made. For EC2 compute resources,\n providing an empty list removes the VPC subnets from the compute resource. For more information,\n see VPCs and\n subnets in the Amazon VPC User Guide.
\nWhen updating a compute environment, changing the VPC subnets requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nBatch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see\n Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and \n Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the\n Amazon ECS Developer Guide.
\nBatch on Fargate doesn't currently support Local Zones.
\nThe VPC subnets where the compute resources are launched. Fargate compute resources can\n contain up to 16 subnets. For Fargate compute resources, providing an empty list will be\n handled as if this parameter wasn't specified and no change is made. For EC2 compute resources,\n providing an empty list removes the VPC subnets from the compute resource. For more information,\n see VPCs and\n subnets in the Amazon VPC User Guide.
\nWhen updating a compute environment, changing the VPC subnets requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nBatch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local\n Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local\n Zones in the Amazon EKS User Guide and Amazon ECS\n clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS\n Developer Guide.
\nBatch on Fargate doesn't currently support Local Zones.
\nThe Amazon EC2 security groups that are associated with instances launched in the compute environment. This parameter\n is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute\n resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For EC2\n compute resources, providing an empty list removes the security groups from the compute resource.
\nWhen updating a compute environment, changing the EC2 security groups requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
" + "smithy.api#documentation": "The Amazon EC2 security groups that are associated with instances launched in the compute\n environment. This parameter is required for Fargate compute resources, where it can contain up\n to 5 security groups. For Fargate compute resources, providing an empty list is handled as if\n this parameter wasn't specified and no change is made. For EC2 compute resources, providing an\n empty list removes the security groups from the compute resource.
\nWhen updating a compute environment, changing the EC2 security groups requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide.
" } }, "allocationStrategy": { "target": "com.amazonaws.batch#CRUpdateAllocationStrategy", "traits": { - "smithy.api#documentation": "The allocation strategy to use for the compute resource if there's not enough instances of the best fitting\n instance type that can be allocated. This might be because of availability of the instance type in the Region or\n Amazon EC2 service limits. For\n more information, see Allocation\n strategies in the Batch User Guide.
\nWhen updating a compute environment, changing the allocation strategy requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide. BEST_FIT isn't supported when updating a compute\n environment.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch selects additional instance types that are large enough to meet the requirements of the jobs in the\n queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously\n selected instance types aren't available, Batch selects new instance types.
\nBatch selects one or more instance types that are large enough to meet the requirements of the jobs in the\n queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is\n only available for Spot Instance compute resources.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED strategies using On-Demand\n or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus\n by more than a single instance.
The allocation strategy to use for the compute resource if there's not enough instances of\n the best fitting instance type that can be allocated. This might be because of availability of\n the instance type in the Region or Amazon EC2 service limits. For more\n information, see Allocation strategies in the Batch User Guide.
\nWhen updating a compute environment, changing the allocation strategy requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide. BEST_FIT isn't\n supported when updating a compute environment.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nBatch selects additional instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If\n additional instances of the previously selected instance types aren't available, Batch\n selects new instance types.
\nBatch selects one or more instance types that are large enough to meet the requirements\n of the jobs in the queue. Its preference is for instance types that are less likely to be\n interrupted. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith both BEST_FIT_PROGRESSIVE and SPOT_CAPACITY_OPTIMIZED\n strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot\n Instances, Batch might need to exceed maxvCpus to meet your capacity requirements.\n In this event, Batch never exceeds maxvCpus by more than a single instance.
The instances types that can be launched. You can specify instance families to launch any instance type within\n those families (for example, c5 or p3), or you can specify specific sizes within a family\n (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4,\n M4, and R4 instance families) that match the demand of your job queues.
When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nWhen you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.
\nCurrently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that\n don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are\n used.
The instances types that can be launched. You can specify instance families to launch any\n instance type within those families (for example, c5 or p3), or you can\n specify specific sizes within a family (such as c5.8xlarge). You can also choose\n optimal to select instance types (from the C4, M4, and R4 instance families) that\n match the demand of your job queues.
When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nWhen you create a compute environment, the instance types that you select for the compute environment must\n share the same architecture. For example, you can't mix x86 and ARM instances in the same compute\n environment.
\nCurrently, optimal uses instance types from the C4, M4, and R4 instance\n families. In Regions that don't have instance types from those instance families, instance types\n from the C5, M5, and R5 instance families are used.
The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to\n log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.
\nWhen updating a compute environment, changing the EC2 key pair requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon EC2 key pair that's used for instances launched in the compute environment. You can\n use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this\n value to an empty string.
\nWhen updating a compute environment, changing the EC2 key pair requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name\n or full Amazon Resource Name (ARN) of an instance profile. For example, \n ecsInstanceRole\n or\n arn:aws:iam::.\n For more information, see Amazon ECS instance\n role in the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can\n specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,\n \n ecsInstanceRole\n or\n arn:aws:iam::.\n For more information, see Amazon ECS instance role in the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nKey-value pair tags to be applied to EC2 resources that are launched in the compute environment. For Batch,\n these take the form of \"String1\": \"String2\", where String1 is the tag key and\n String2 is the tag value-for example, { \"Name\": \"Batch Instance - C4OnDemand\" }. This is\n helpful for recognizing your Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch\n ListTagsForResource API operation.
When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nKey-value pair tags to be applied to EC2 resources that are launched in the compute\n environment. For Batch, these take the form of \"String1\": \"String2\", where\n String1 is the tag key and String2 is the tag value-for example,\n { \"Name\": \"Batch Instance - C4OnDemand\" }. This is helpful for recognizing your\n Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch\n ListTagsForResource API operation.
When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel\n jobs to your compute environment, you should consider creating a cluster placement group and associate it with your\n compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single\n Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for\n Linux Instances.
\nWhen updating a compute environment, changing the placement group requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe Amazon EC2 placement group to associate with your compute resources. If you intend to submit\n multi-node parallel jobs to your compute environment, you should consider creating a cluster\n placement group and associate it with your compute resources. This keeps your multi-node parallel\n job on a logical grouping of instances within a single Availability Zone with high network flow\n potential. For more information, see Placement groups in the\n Amazon EC2 User Guide for Linux Instances.
\nWhen updating a compute environment, changing the placement group requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that\n instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be\n less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and\n never more than your maximum percentage. For\n most use cases, we recommend leaving this field empty.
\nWhen updating a compute environment, changing the bid percentage requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe maximum percentage that a Spot Instance price can be when compared with the On-Demand\n price for that instance type before instances are launched. For example, if your maximum\n percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that\n Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum\n percentage. For most use\n cases, we recommend leaving this field empty.
\nWhen updating a compute environment, changing the bid percentage requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe updated launch template to use for your compute resources. You must specify either the launch template ID or\n launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide.\n To remove the custom launch template and use the default launch template, set launchTemplateId or\n launchTemplateName member of the launch template specification to an empty string. Removing the launch\n template from a compute environment will not remove the AMI specified in the launch template. In order to update the\n AMI specified in a launch template, the updateToLatestImageVersion parameter must be set to\n true.
When updating a compute environment, changing the launch template requires an infrastructure update of the\n compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe updated launch template to use for your compute resources. You must specify either the\n launch template ID or launch template name in the request, but not both. For more information,\n see Launch template\n support in the Batch User Guide. To remove the custom launch\n template and use the default launch template, set launchTemplateId or\n launchTemplateName member of the launch template specification to an empty string.\n Removing the launch template from a compute environment will not remove the AMI specified in the\n launch template. In order to update the AMI specified in a launch template, the\n updateToLatestImageVersion parameter must be set to true.
When updating a compute environment, changing the launch template requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nProvides information used to select Amazon Machine Images (AMIs) for EC2 instances in the compute environment.\n If Ec2Configuration isn't specified, the default is ECS_AL2.
When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide. To remove the EC2 configuration\n and any custom AMI ID specified in imageIdOverride, set this value to an empty string.
One or two values can be provided.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nProvides information used to select Amazon Machine Images (AMIs) for EC2 instances in the\n compute environment. If Ec2Configuration isn't specified, the default is\n ECS_AL2.
When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide. To remove the EC2 configuration and any custom AMI ID\n specified in imageIdOverride, set this value to an empty string.
One or two values can be provided.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nSpecifies whether the AMI ID is updated to the latest one that's supported by Batch when the compute\n environment has an infrastructure update. The default value is false.
An AMI ID can either be specified in the imageId or imageIdOverride parameters or be\n determined by the launch template that's specified in the launchTemplate parameter. If an AMI ID is\n specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an\n infrastructure update, see Updating the AMI ID in\n the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.
" + "smithy.api#documentation": "Specifies whether the AMI ID is updated to the latest one that's supported by Batch when\n the compute environment has an infrastructure update. The default value is\n false.
An AMI ID can either be specified in the imageId or\n imageIdOverride parameters or be determined by the launch template that's\n specified in the launchTemplate parameter. If an AMI ID is specified any of these\n ways, this parameter is ignored. For more information about to update AMI IDs during an\n infrastructure update, see Updating\n the AMI ID in the Batch User Guide.
When updating a compute environment, changing this setting requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
" } }, "type": { "target": "com.amazonaws.batch#CRType", "traits": { - "smithy.api#documentation": "The type of compute environment: EC2, SPOT, FARGATE, or\n FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.
When updating a compute environment, changing the type of a compute environment requires an infrastructure\n update of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
" + "smithy.api#documentation": "The type of compute environment: EC2, SPOT, FARGATE,\n or FARGATE_SPOT. For more information, see Compute environments in the\n Batch User Guide.
If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the\n spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the\n Batch User Guide.
When updating a compute environment, changing the type of a compute environment requires an\n infrastructure update of the compute environment. For more information, see Updating compute\n environments in the Batch User Guide.
" } }, "imageId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is\n overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the\n custom AMI ID and use the default AMI ID, set this value to an empty string.
When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.
\nThe Amazon Machine Image (AMI) ID used for instances launched in the compute environment.\n This parameter is overridden by the imageIdOverride member of the\n Ec2Configuration structure. To remove the custom AMI ID and use the default AMI ID,\n set this value to an empty string.
When updating a compute environment, changing the AMI ID requires an infrastructure update\n of the compute environment. For more information, see Updating compute environments in the\n Batch User Guide.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.
\nThe AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.
\nAn object that represents the attributes of a compute environment that can be updated. For more information, see\n Updating compute environments\n in the Batch User Guide.
" + "smithy.api#documentation": "An object that represents the attributes of a compute environment that can be updated. For\n more information, see Updating compute environments in the\n Batch User Guide.
" } }, "com.amazonaws.batch#ContainerDetail": { @@ -2696,13 +1912,13 @@ "vcpus": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU\n requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both\n the vcpus and resourceRequirements object. This parameter maps to CpuShares in\n the Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify\n at least one vCPU. This is required but can be specified in several places. It must be specified for each node at\n least once.
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate\n resources, you must specify the vCPU requirement for the job using resourceRequirements.
The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can\n specify the vCPU requirement for the job using resourceRequirements, but you can't\n specify the vCPU requirements in both the vcpus and\n resourceRequirements object. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the\n --cpu-shares option to docker run. Each\n vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but\n can be specified in several places. It must be specified for each node at least once.
This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run\n on Fargate resources, you must specify the vCPU requirement for the job using\n resourceRequirements.
For jobs running on EC2 resources that didn't specify memory requirements using\n resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all\n run on Fargate resources, see resourceRequirements.
For jobs running on EC2 resources that didn't specify memory requirements using\n resourceRequirements, the number of MiB of memory reserved for the job. For other\n jobs, including all run on Fargate resources, see resourceRequirements.
The Amazon Resource Name (ARN) of the\n execution\n role that Batch can assume. For more information, see Batch execution IAM role in the\n Batch User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the\n execution\n role that Batch can assume. For more information,\n see Batch execution IAM\n role in the Batch User Guide.
" } }, "volumes": { @@ -2744,25 +1960,25 @@ "readonlyRootFilesystem": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "When this parameter is true, the container is given read-only access to its root file system. This parameter\n maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and\n the --read-only option to \n docker run\n .
When this parameter is true, the container is given read-only access to its root file\n system. This parameter maps to ReadonlyRootfs in the\n Create a container section of the Docker Remote API and the\n --read-only option to \n docker\n run\n .
A list of ulimit values to set in the container. This parameter maps to Ulimits in the\n Create a container section of the Docker Remote API and the --ulimit option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources.
\nA list of ulimit values to set in the container. This parameter maps to\n Ulimits in the Create a container section of the Docker Remote API\n and the --ulimit option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources.
\nWhen this parameter is true, the container is given elevated permissions on the host container instance (similar\n to the root user). The default value is false.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or\n specified as false.
When this parameter is true, the container is given elevated permissions on the host\n container instance (similar to the root user). The default value is\n false.
This parameter isn't applicable to jobs that are running on Fargate resources and\n shouldn't be provided, or specified as false.
The user name to use inside the container. This parameter maps to User in the\n Create a container section of the Docker Remote API and the --user option to docker run.
The user name to use inside the container. This parameter maps to User in the\n Create a container section of the Docker Remote API and the --user\n option to docker run.
A short (255 max characters) human-readable string to provide additional details for a running or stopped\n container.
" + "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a\n running or stopped container.
" } }, "containerInstanceArn": { @@ -2786,13 +2002,13 @@ "taskArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task\n ARN when they reach the STARTING status.
The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container\n attempt receives a task ARN when they reach the STARTING status.
The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is\n /aws/batch/job. Each container attempt receives a log stream name when they reach the\n RUNNING status.
The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for\n Batch jobs is /aws/batch/job. Each container attempt receives a log stream name\n when they reach the RUNNING status.
The type and amount of resources to assign to a container. The supported resources include GPU,\n MEMORY, and VCPU.
The type and amount of resources to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.
Linux-specific modifications that are applied to the container, such as details for device mappings.
" + "smithy.api#documentation": "Linux-specific modifications that are applied to the container, such as details for device\n mappings.
" } }, "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { - "smithy.api#documentation": "The log configuration specification for the container.
\nThis parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance. Or, alternatively, it must be configured on a different log server for remote logging options.\n For more information on the options for different supported log drivers, see Configure logging drivers in the Docker\n documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS\n container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the\n Amazon Elastic Container Service Developer Guide.
The log configuration specification for the container.
\nThis parameter maps to LogConfig in the Create a container\n section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging\n driver that the Docker daemon uses. However, the container might use a different logging driver\n than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured\n properly on the container instance. Or, alternatively, it must be configured on a different log\n server for remote logging options. For more information on the options for different supported\n log drivers, see Configure\n logging drivers in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon\n (shown in the LogConfiguration data type). Additional log drivers might be\n available in future releases of the Amazon ECS container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The Amazon ECS container agent running on a container instance must register the logging drivers\n available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment\n variable before containers placed on that instance can use these log configuration options. For\n more information, see Amazon ECS container agent\n configuration in the Amazon Elastic Container Service Developer Guide.
The secrets to pass to the container. For more information, see Specifying sensitive data in the\n Batch User Guide.
" + "smithy.api#documentation": "The secrets to pass to the container. For more information, see Specifying sensitive data in the\n Batch User Guide.
" } }, "networkConfiguration": { "target": "com.amazonaws.batch#NetworkConfiguration", "traits": { - "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2\n resources must not specify this parameter.
" + "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on EC2 resources must not specify this parameter.
" } }, "fargatePlatformConfiguration": { "target": "com.amazonaws.batch#FargatePlatformConfiguration", "traits": { - "smithy.api#documentation": "The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2\n resources must not specify this parameter.
" + "smithy.api#documentation": "The platform configuration for jobs that are running on Fargate resources. Jobs that are\n running on EC2 resources must not specify this parameter.
" } + }, + "ephemeralStorage": { + "target": "com.amazonaws.batch#EphemeralStorage" } }, "traits": { @@ -2857,7 +2076,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "This parameter is deprecated, use resourceRequirements to override the vcpus parameter\n that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2\n resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU\n requirement specified in the resourceRequirements structure in the job definition. To override vCPU\n requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type set\n to VCPU and value set to the new value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the\n vcpus parameter that's set in the job definition. It's not supported for jobs\n running on Fargate resources. For jobs that run on EC2 resources, it overrides the\n vcpus parameter set in the job definition, but doesn't override any vCPU\n requirement specified in the resourceRequirements structure in the job definition.\n To override vCPU requirements that are specified in the resourceRequirements\n structure in the job definition, resourceRequirements must be specified in the\n SubmitJob request, with type set to VCPU and\n value set to the new value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the memory requirements\n specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2\n resources, it overrides the memory parameter set in the job definition, but doesn't override any memory\n requirement that's specified in the resourceRequirements structure in the job definition. To override\n memory requirements that are specified in the resourceRequirements structure in the job definition,\n resourceRequirements must be specified in the SubmitJob request, with type set\n to MEMORY and value set to the new value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.
This parameter is deprecated, use resourceRequirements to override the memory\n requirements specified in the job definition. It's not supported for jobs running on Fargate\n resources. For jobs that run on EC2 resources, it overrides the memory parameter set\n in the job definition, but doesn't override any memory requirement that's specified in the\n resourceRequirements structure in the job definition. To override memory\n requirements that are specified in the resourceRequirements structure in the job\n definition, resourceRequirements must be specified in the SubmitJob\n request, with type set to MEMORY and value set to the new\n value. For more information, see Can't override job\n definition resource requirements in the Batch User Guide.
The command to send to the container that overrides the default command from the Docker image or the job\n definition.
" + "smithy.api#documentation": "The command to send to the container that overrides the default command from the Docker\n image or the job definition.
" } }, "instanceType": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The instance type to use for a multi-node parallel job.
\nThis parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and\n shouldn't be provided.
\nThe instance type to use for a multi-node parallel job.
\nThis parameter isn't applicable to single-node container jobs or jobs that run on Fargate\n resources, and shouldn't be provided.
\nThe environment variables to send to the container. You can add new environment variables, which are added to\n the container at launch, or you can override the existing environment variables from the Docker image or the job\n definition.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The environment variables to send to the container. You can add new environment variables,\n which are added to the container at launch, or you can override the existing environment\n variables from the Docker image or the job definition.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The type and amount of resources to assign to a container. This overrides the settings in the job definition.\n The supported resources include GPU, MEMORY, and VCPU.
The type and amount of resources to assign to a container. This overrides the settings in\n the job definition. The supported resources include GPU, MEMORY, and\n VCPU.
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker\n Hub registry are available by default. Other repositories are specified with\n \n repository-url/image:tag\n .\n It can be 255 characters long. It can contain uppercase and lowercase letters, numbers,\n hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of\n the Docker Remote API and the IMAGE parameter of docker\n run.
Docker image architecture must match the processor architecture of the compute resources that they're scheduled\n on. For example, ARM-based Docker images can only run on ARM-based compute resources.
\nImages in Amazon ECR Public repositories use the full registry/repository[:tag] or\n registry/repository[@digest] naming conventions. For example,\n public.ecr.aws/registry_alias/my-web-app:latest\n .
Images in Amazon ECR repositories use the full registry and repository URI (for example,\n 123456789012.dkr.ecr.).
Images in official repositories on Docker Hub use a single name (for example, ubuntu or\n mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for example,\n amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example,\n quay.io/assemblyline/ubuntu).
The image used to start a container. This string is passed directly to the Docker daemon.\n Images in the Docker Hub registry are available by default. Other repositories are specified with\n \n repository-url/image:tag\n .\n It can be 255 characters long. It can contain uppercase and lowercase letters, numbers,\n hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the\n Create a container section of the Docker Remote API and the IMAGE\n parameter of docker run.
Docker image architecture must match the processor architecture of the compute resources\n that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based\n compute resources.
\nImages in Amazon ECR Public repositories use the full registry/repository[:tag] or\n registry/repository[@digest] naming conventions. For example,\n public.ecr.aws/registry_alias/my-web-app:latest\n .
Images in Amazon ECR repositories use the full registry and repository URI (for example,\n 123456789012.dkr.ecr.).
Images in official repositories on Docker Hub use a single name (for example,\n ubuntu or mongo).
Images in other repositories on Docker Hub are qualified with an organization name (for\n example, amazon/amazon-ecs-agent).
Images in other online repositories are qualified further by a domain name (for example,\n quay.io/assemblyline/ubuntu).
This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job\n definition. It's not supported for jobs running on Fargate resources. For jobs running on EC2 resources, it specifies\n the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. The number of vCPUs must be specified but can be specified in\n several places. You must specify it at least once for each node.
This parameter is deprecated, use resourceRequirements to specify the vCPU\n requirements for the job definition. It's not supported for jobs running on Fargate resources.\n For jobs running on EC2 resources, it specifies the number of vCPUs reserved for the job.
Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares\n in the Create a container section of the Docker Remote API and the\n --cpu-shares option to docker run. The\n number of vCPUs must be specified but can be specified in several places. You must specify it at\n least once for each node.
This parameter is deprecated, use resourceRequirements to specify the memory requirements for the\n job definition. It's not supported for jobs running on Fargate resources. For jobs that run on EC2 resources, it\n specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number,\n it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can\n be specified in several places. It must be specified for each node at least once.
This parameter is deprecated, use resourceRequirements to specify the memory\n requirements for the job definition. It's not supported for jobs running on Fargate resources.\n For jobs that run on EC2 resources, it specifies the memory hard limit (in MiB) for a container.\n If your container attempts to exceed the specified number, it's terminated. You must specify at\n least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in\n several places. It must be specified for each node at least once.
The command that's passed to the container. This parameter maps to Cmd in the\n Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
The command that's passed to the container. This parameter maps to Cmd in the\n Create a container section of the Docker Remote API and the COMMAND\n parameter to docker run. For more information, see\n https://docs.docker.com/engine/reference/builder/#cmd.
The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see\n IAM roles for tasks\n in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more\n information, see IAM roles for tasks in the\n Amazon Elastic Container Service Developer Guide.
" } }, "executionRoleArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must\n provide an execution role. For more information, see Batch execution IAM role in the\n Batch User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate\n resources, you must provide an execution role. For more information, see Batch execution IAM role\n in the Batch User Guide.
" } }, "volumes": { @@ -2952,84 +2171,90 @@ "environment": { "target": "com.amazonaws.batch#EnvironmentVariables", "traits": { - "smithy.api#documentation": "The environment variables to pass to a container. This parameter maps to Env in the\n Create a container section of the Docker Remote API and the --env option to docker run.
We don't recommend using plaintext environment variables for sensitive information, such as credential\n data.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The environment variables to pass to a container. This parameter maps to Env in\n the Create a container section of the Docker Remote API and the\n --env option to docker run.
We don't recommend using plaintext environment variables for sensitive information, such as\n credential data.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The mount points for data volumes in your container. This parameter maps to Volumes in the\n Create a container section of the Docker Remote API and the --volume option to docker run.
The mount points for data volumes in your container. This parameter maps to\n Volumes in the Create a container section of the Docker Remote API\n and the --volume option to docker\n run.
When this parameter is true, the container is given read-only access to its root file system. This parameter\n maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and\n the --read-only option to docker run.
When this parameter is true, the container is given read-only access to its root file\n system. This parameter maps to ReadonlyRootfs in the\n Create a container section of the Docker Remote API and the\n --read-only option to docker run.
When this parameter is true, the container is given elevated permissions on the host container instance (similar\n to the root user). This parameter maps to Privileged in the\n Create a container section of the Docker Remote API and the --privileged option to\n docker run. The default value is false.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or\n specified as false.
\nWhen this parameter is true, the container is given elevated permissions on the host\n container instance (similar to the root user). This parameter maps to\n Privileged in the Create a container section of the\n Docker Remote API and the --privileged option to docker run. The default value is false.
This parameter isn't applicable to jobs that are running on Fargate resources and\n shouldn't be provided, or specified as false.
\nA list of ulimits to set in the container. This parameter maps to Ulimits in the\n Create a container section of the Docker Remote API and the --ulimit option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be\n provided.
\nA list of ulimits to set in the container. This parameter maps to\n Ulimits in the Create a container section of the Docker Remote API\n and the --ulimit option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources and\n shouldn't be provided.
\nThe user name to use inside the container. This parameter maps to User in the\n Create a container section of the Docker Remote API and the --user option to docker run.
The user name to use inside the container. This parameter maps to User in the\n Create a container section of the Docker Remote API and the --user\n option to docker run.
The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use\n the same instance type.
\nThis parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and\n shouldn't be provided.
\nThe instance type to use for a multi-node parallel job. All node groups in a multi-node\n parallel job must use the same instance type.
\nThis parameter isn't applicable to single-node container jobs or jobs that run on Fargate\n resources, and shouldn't be provided.
\nThe type and amount of resources to assign to a container. The supported resources include GPU,\n MEMORY, and VCPU.
The type and amount of resources to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.
Linux-specific modifications that are applied to the container, such as details for device mappings.
" + "smithy.api#documentation": "Linux-specific modifications that are applied to the container, such as details for device\n mappings.
" } }, "logConfiguration": { "target": "com.amazonaws.batch#LogConfiguration", "traits": { - "smithy.api#documentation": "The log configuration specification for the container.
\nThis parameter maps to LogConfig in the Create a container section of the\n Docker Remote API and the --log-driver option to docker run.\n By default, containers use the same logging driver that the Docker daemon uses. However the container might use a\n different logging driver than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured properly on the\n container instance (or on a different log server for remote logging options). For more information on the options for\n different supported log drivers, see Configure\n logging drivers in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The Amazon ECS container agent running on a container instance must register the logging drivers available on that\n instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that\n instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the\n Amazon Elastic Container Service Developer Guide.
The log configuration specification for the container.
\nThis parameter maps to LogConfig in the Create a container\n section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging\n driver that the Docker daemon uses. However the container might use a different logging driver\n than the Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be configured\n properly on the container instance (or on a different log server for remote logging options). For\n more information on the options for different supported log drivers, see Configure logging drivers\n in the Docker documentation.
Batch currently supports a subset of the logging drivers available to the Docker daemon\n (shown in the LogConfiguration data type).
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The Amazon ECS container agent running on a container instance must register the logging drivers\n available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment\n variable before containers placed on that instance can use these log configuration options. For\n more information, see Amazon ECS container agent\n configuration in the Amazon Elastic Container Service Developer Guide.
The secrets for the container. For more information, see Specifying sensitive data in the\n Batch User Guide.
" + "smithy.api#documentation": "The secrets for the container. For more information, see Specifying sensitive data in the\n Batch User Guide.
" } }, "networkConfiguration": { "target": "com.amazonaws.batch#NetworkConfiguration", "traits": { - "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2\n resources must not specify this parameter.
" + "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on EC2 resources must not specify this parameter.
" } }, "fargatePlatformConfiguration": { "target": "com.amazonaws.batch#FargatePlatformConfiguration", "traits": { - "smithy.api#documentation": "The platform configuration for jobs that are running on Fargate resources. Jobs that are running on EC2\n resources must not specify this parameter.
" + "smithy.api#documentation": "The platform configuration for jobs that are running on Fargate resources. Jobs that are\n running on EC2 resources must not specify this parameter.
" + } + }, + "ephemeralStorage": { + "target": "com.amazonaws.batch#EphemeralStorage", + "traits": { + "smithy.api#documentation": "The amount of ephemeral storage to allocate for the task. This parameter is used to expand\n the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\n Fargate.
" } } }, "traits": { - "smithy.api#documentation": "Container properties are used\n for\n Amazon ECS based job definitions. These properties to describe the container that's launched as part of\n a job.
" + "smithy.api#documentation": "Container properties are used\n for\n Amazon ECS based job definitions. These properties to describe the container that's\n launched as part of a job.
" } }, "com.amazonaws.batch#ContainerSummary": { @@ -3044,7 +2269,7 @@ "reason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a running or stopped\n container.
" + "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a\n running or stopped container.
" } } }, @@ -3097,7 +2322,7 @@ "state": { "target": "com.amazonaws.batch#CEState", "traits": { - "smithy.api#documentation": "The state of the compute environment. If the state is ENABLED, then the compute environment accepts\n jobs from a queue and can scale out automatically based on queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated\n job queue on the compute resources within the environment. If the compute environment is managed, then it can scale\n its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the\n environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed\n compute environments in the DISABLED state don't scale out. However, they scale in to\n minvCpus value after instances become idle.
The state of the compute environment. If the state is ENABLED, then the\n compute environment accepts jobs from a queue and can scale out automatically based on\n queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs\n from an associated job queue on the compute resources within the environment. If the compute\n environment is managed, then it can scale its instances out or in automatically, based on the\n job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place\n jobs within the environment. Jobs in a STARTING or RUNNING state\n continue to progress normally. Managed compute environments in the DISABLED state\n don't scale out.
Compute environments in a DISABLED state may continue to incur billing\n charges. To prevent additional charges, turn off and then delete the compute environment.\n For more information, see State in the Batch User Guide.
When an instance is idle, the instance scales down to the minvCpus value.\n However, the instance size doesn't change. For example, consider a c5.8xlarge\n instance with a minvCpus value of 4 and a desiredvCpus\n value of 36. This instance doesn't scale down to a c5.large\n instance.
Contains the parameters for CreateComputeEnvironment.
Contains the parameters for CreateComputeEnvironment.
The Amazon Resource Name (ARN) of the compute environment.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.batch#CreateJobQueue": { @@ -3221,7 +2450,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the parameters for CreateJobQueue.
Contains the parameters for CreateJobQueue.
Contains the parameters for CreateSchedulingPolicy.
Contains the parameters for CreateSchedulingPolicy.
Contains the parameters for DeleteComputeEnvironment.
Contains the parameters for DeleteComputeEnvironment.
Contains the parameters for DeleteJobQueue.
Contains the parameters for DeleteJobQueue.
Contains the parameters for DeleteSchedulingPolicy.
Contains the parameters for DeleteSchedulingPolicy.
Contains the parameters for DescribeComputeEnvironments.
Contains the parameters for DescribeComputeEnvironments.
The nextToken value to include in a future DescribeComputeEnvironments request. When\n the results of a DescribeComputeEnvironments request exceed maxResults, this value can be\n used to retrieve the next page of results. This value is null when there are no more results to\n return.
Contains the parameters for DescribeJobDefinitions.
Contains the parameters for DescribeJobDefinitions.
The nextToken value to include in a future DescribeJobDefinitions request. When the\n results of a DescribeJobDefinitions request exceed maxResults, this value can be used to\n retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeJobQueues.
Contains the parameters for DescribeJobQueues.
The nextToken value to include in a future DescribeJobQueues request. When the results\n of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the\n next page of results. This value is null when there are no more results to return.
Contains the parameters for DescribeJobs.
Contains the parameters for DescribeJobs.
The list of jobs.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.batch#DescribeSchedulingPolicies": { @@ -3809,7 +3080,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the parameters for DescribeSchedulingPolicies.
Contains the parameters for DescribeSchedulingPolicies.
The list of scheduling policies.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.batch#Device": { @@ -3836,18 +3111,18 @@ "containerPath": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The path inside the container that's used to expose the host device. By default, the hostPath value\n is used.
The path inside the container that's used to expose the host device. By default, the\n hostPath value is used.
The explicit permissions to provide to the container for the device. By default, the container has permissions\n for read, write, and mknod for the device.
The explicit permissions to provide to the container for the device. By default, the\n container has permissions for read, write, and mknod for\n the device.
An object that represents a container instance host device.
\nThis object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.
\nAn object that represents a container instance host device.
\nThis object isn't applicable to jobs that are running on Fargate resources and shouldn't\n be provided.
\nThe Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the\n EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on\n the EFS access point. If an access point is used, transit encryption must be enabled in the\n EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the\n Amazon Elastic File System User Guide.
The Amazon EFS access point ID to use. If an access point is specified, the root directory value\n specified in the EFSVolumeConfiguration must either be omitted or set to\n / which enforces the path set on the EFS access point. If an access point is used,\n transit encryption must be enabled in the EFSVolumeConfiguration. For more\n information, see Working\n with Amazon EFS access points in the Amazon Elastic File System User Guide.
Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system.\n If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is\n omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the\n Batch User Guide. EFS IAM authorization requires that TransitEncryption be\n ENABLED and that a JobRoleArn is specified.
Whether or not to use the Batch job IAM role defined in a job definition when mounting the\n Amazon EFS file system. If enabled, transit encryption must be enabled in the\n EFSVolumeConfiguration. If this parameter is omitted, the default value of\n DISABLED is used. For more information, see Using Amazon EFS access points in\n the Batch User Guide. EFS IAM authorization requires that\n TransitEncryption be ENABLED and that a JobRoleArn is\n specified.
The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is\n omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this\n parameter. The maximum length is 4,096 characters.
If an EFS access point is specified in the authorizationConfig, the root directory parameter must\n either be omitted or set to /, which enforces the path set on the Amazon EFS access point.
The directory within the Amazon EFS file system to mount as the root directory inside the host.\n If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying\n / has the same effect as omitting this parameter. The maximum length is 4,096\n characters.
If an EFS access point is specified in the authorizationConfig, the root\n directory parameter must either be omitted or set to /, which enforces the path set\n on the Amazon EFS access point.
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server.\n Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default\n value of DISABLED is used. For more information, see Encrypting data in transit in the\n Amazon Elastic File System User Guide.
Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and\n the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If\n this parameter is omitted, the default value of DISABLED is used. For more\n information, see Encrypting data in transit in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a\n transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be\n between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.
" + "smithy.api#documentation": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If\n you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS\n mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the\n Amazon Elastic File System User Guide.
" } }, "authorizationConfig": { @@ -3975,7 +3250,7 @@ } }, "traits": { - "smithy.api#documentation": "This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the\n Batch User Guide.
" + "smithy.api#documentation": "This is used when you're using an Amazon Elastic File System file system for job storage. For more\n information, see Amazon EFS\n Volumes in the Batch User Guide.
" } }, "com.amazonaws.batch#Ec2Configuration": { @@ -3984,25 +3259,25 @@ "imageType": { "target": "com.amazonaws.batch#ImageType", "traits": { - "smithy.api#documentation": "The image type to match with the instance type to select an AMI. The supported values are different for\n ECS and EKS resources.
If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI\n (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId\n nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type\n that's supported by Batch is used.
\n Amazon\n Linux 2: Default for all non-GPU instance families.
\n\n Amazon\n Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4)\n and can be used for all non Amazon Web Services Graviton-based instance types.
\n Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.
\nIf the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI\n (EKS_AL2) is used. If a new image type is specified in an update, but neither an imageId\n nor a imageIdOverride parameter is specified, then the latest Amazon EKS optimized AMI for that image type\n that Batch supports is used.
\n Amazon\n Linux 2: Default for all non-GPU instance families.
\n\n Amazon Linux 2\n (accelerated): Default for all GPU instance families (for example, P4 and\n G4) and can be used for all non Amazon Web Services Graviton-based instance types.
The image type to match with the instance type to select an AMI. The supported values are\n different for ECS and EKS resources.
If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is\n specified in an update, but neither an imageId nor a imageIdOverride\n parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's\n supported by Batch is used.
\n Amazon Linux\n 2: Default for all non-GPU instance families.
\n\n Amazon Linux 2\n (GPU): Default for all GPU instance families (for example P4 and\n G4) and can be used for all non Amazon Web Services Graviton-based instance types.
\n Amazon Linux. Amazon Linux has\n reached the end-of-life of standard support. For more information, see Amazon Linux AMI.
\nIf the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux\n AMI (EKS_AL2) is used. If a new image type is specified in an update,\n but neither an imageId nor a imageIdOverride parameter is specified,\n then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.
\n Amazon\n Linux 2: Default for all non-GPU instance families.
\n\n Amazon\n Linux 2 (accelerated): Default for all GPU instance families (for example,\n P4 and G4) and can be used for all non Amazon Web Services Graviton-based\n instance types.
The AMI ID used for instances launched in the compute environment that match the image type. This setting\n overrides the imageId set in the computeResource object.
The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.
\nThe AMI ID used for instances launched in the compute environment that match the image type.\n This setting overrides the imageId set in the computeResource\n object.
The AMI that you choose for a compute environment must match the architecture of the instance types that\n you intend to use for that compute environment. For example, if your compute environment uses A1 instance types,\n the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the\n Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized\n Amazon Linux 2 AMI\n in the Amazon Elastic Container Service Developer Guide.
\nThe Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch\n supports is used.
" + "smithy.api#documentation": "The Kubernetes version for the compute environment. If you don't specify a value, the latest\n version that Batch supports is used.
" } } }, "traits": { - "smithy.api#documentation": "Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If\n Ec2Configuration isn't specified, the default is ECS_AL2 (Amazon Linux 2).
This object isn't applicable to jobs that are running on Fargate resources.
\nProvides information used to select Amazon Machine Images (AMIs) for instances in the\n compute environment. If Ec2Configuration isn't specified, the default is\n ECS_AL2 (Amazon Linux 2).
This object isn't applicable to jobs that are running on Fargate resources.
\nA short (255 max characters) human-readable string to provide additional details for a running or stopped\n container.
" + "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details for a\n running or stopped container.
" } } }, "traits": { - "smithy.api#documentation": "An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.
" + "smithy.api#documentation": "An object that represents the details for an attempt for a job attempt that an Amazon EKS\n container runs.
" } }, "com.amazonaws.batch#EksAttemptContainerDetails": { @@ -4061,24 +3336,24 @@ "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { - "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the\n STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt\n transitioned from the STARTING state to the RUNNING state).
The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the attempt\n transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or\n FAILED.
The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the\n attempt transitioned from the RUNNING state to a terminal state, such as\n SUCCEEDED or FAILED.
A short, human-readable string to provide additional details for the current status of the job attempt.
" + "smithy.api#documentation": "A short, human-readable string to provide additional details for the current status of the\n job attempt.
" } } }, "traits": { - "smithy.api#documentation": "An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.
" + "smithy.api#documentation": "An object that represents the details of a job attempt for a job attempt by an Amazon EKS\n container.
" } }, "com.amazonaws.batch#EksAttemptDetails": { @@ -4093,20 +3368,20 @@ "eksClusterArn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is\n arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch\n .\n
The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is\n arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch\n .\n
The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or\n null. It must be fewer than 64 characters long, can't be set to default, can't start with\n \"kube-,\" and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more\n information, see Namespaces in the Kubernetes documentation.
The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value\n can't left empty or null. It must be fewer than 64 characters long, can't be set to\n default, can't start with \"kube-,\" and must match this regular\n expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.
Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before\n the compute environment can be created.
" + "smithy.api#documentation": "Configuration for the Amazon EKS cluster that supports the Batch compute environment. The\n cluster must exist before the compute environment can be created.
" } }, "com.amazonaws.batch#EksContainer": { @@ -4115,7 +3390,7 @@ "name": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the container. If the name isn't specified, the default name \"Default\" is used. Each\n container in a pod must have a unique name.
The name of the container. If the name isn't specified, the default name\n \"Default\" is used. Each container in a pod must have a unique name.
The image pull policy for the container. Supported values are Always, IfNotPresent,\n and Never. This parameter defaults to IfNotPresent. However, if the :latest\n tag is specified, it defaults to Always. For more information, see Updating images in the\n Kubernetes documentation.
The image pull policy for the container. Supported values are Always,\n IfNotPresent, and Never. This parameter defaults to\n IfNotPresent. However, if the :latest tag is specified, it defaults to\n Always. For more information, see Updating\n images in the Kubernetes documentation.
The entrypoint for the container. This isn't run within a shell. If this isn't specified, the\n ENTRYPOINT of the container image is used. Environment variable references are expanded using the\n container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example,\n if the reference is to \"$(NAME1)\" and the NAME1 environment variable doesn't exist, the\n command string will remain \"$(NAME1).\" $$ is replaced with $ and the resulting\n string isn't expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or\n not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see\n ENTRYPOINT in the\n Dockerfile reference and Define a command\n and arguments for a container and Entrypoint in\n the Kubernetes documentation.
The entrypoint for the container. This isn't run within a shell. If this isn't specified,\n the ENTRYPOINT of the container image is used. Environment variable references are\n expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't\n changed. For example, if the reference is to \"$(NAME1)\" and the NAME1\n environment variable doesn't exist, the command string will remain \"$(NAME1).\"\n $$ is replaced with $ and the resulting string isn't expanded. For\n example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the\n VAR_NAME environment variable exists. The entrypoint can't be updated. For more\n information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.
An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is\n used. This corresponds to the args member in the Entrypoint\n portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example,\n if the reference is to \"$(NAME1)\" and the NAME1 environment variable doesn't exist, the\n command string will remain \"$(NAME1).\" $$ is replaced with $, and the\n resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether\n or not the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile\n reference and Define a command\n and arguments for a pod in the Kubernetes documentation.
An array of arguments to the entrypoint. If this isn't specified, the CMD of\n the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod\n in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't\n changed. For example, if the reference is to \"$(NAME1)\" and the NAME1\n environment variable doesn't exist, the command string will remain \"$(NAME1).\"\n $$ is replaced with $, and the resulting string isn't expanded. For\n example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the\n VAR_NAME environment variable exists. For more information, see CMD in the\n Dockerfile reference and Define a command and arguments for a pod in the Kubernetes\n documentation.
The type and amount of resources to assign to a container. The supported resources include memory,\n cpu, and nvidia.com/gpu. For more information, see Resource management for pods\n and containers in the Kubernetes documentation.
The type and amount of resources to assign to a container. The supported resources include\n memory, cpu, and nvidia.com/gpu. For more information,\n see Resource management for pods and containers in the Kubernetes\n documentation.
The volume mounts for the container. Batch supports emptyDir, hostPath, and\n secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes\n documentation.
The volume mounts for the container. Batch supports emptyDir,\n hostPath, and secret volume types. For more information about volumes\n and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
The security context for a job. For more information, see Configure a security context for a\n pod or container in the Kubernetes documentation.
" + "smithy.api#documentation": "The security context for a job. For more information, see Configure a\n security context for a pod or container in the Kubernetes\n documentation.
" } } }, "traits": { - "smithy.api#documentation": "EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties\n for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job\n definitions.
" + "smithy.api#documentation": "EKS container properties are used in job definitions for Amazon EKS based job definitions to\n describe the properties for a container node in the pod that's launched as part of a job. This\n can't be specified for Amazon ECS based job definitions.
" } }, "com.amazonaws.batch#EksContainerDetail": { @@ -4178,7 +3453,7 @@ "name": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the container. If the name isn't specified, the default name \"Default\" is used. Each\n container in a pod must have a unique name.
The name of the container. If the name isn't specified, the default name\n \"Default\" is used. Each container in a pod must have a unique name.
The image pull policy for the container. Supported values are Always, IfNotPresent,\n and Never. This parameter defaults to Always if the :latest tag is specified,\n IfNotPresent otherwise. For more information, see Updating images in the\n Kubernetes documentation.
The image pull policy for the container. Supported values are Always,\n IfNotPresent, and Never. This parameter defaults to\n Always if the :latest tag is specified, IfNotPresent\n otherwise. For more information, see Updating\n images in the Kubernetes documentation.
The entrypoint for the container. For more information, see Entrypoint in\n the Kubernetes documentation.
" + "smithy.api#documentation": "The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.
" } }, "args": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is\n used. This corresponds to the args member in the Entrypoint\n portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example,\n if the reference is to \"$(NAME1)\" and the NAME1 environment variable doesn't exist, the\n command string will remain \"$(NAME1)\". $$ is replaced with $ and the resulting\n string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not\n the VAR_NAME environment variable exists. For more information, see CMD in the Dockerfile\n reference and Define a command\n and arguments for a pod in the Kubernetes documentation.
An array of arguments to the entrypoint. If this isn't specified, the CMD of\n the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod\n in Kubernetes. Environment variable references are expanded using the container's environment.
If the referenced environment variable doesn't exist, the reference in the command isn't\n changed. For example, if the reference is to \"$(NAME1)\" and the NAME1\n environment variable doesn't exist, the command string will remain \"$(NAME1)\".\n $$ is replaced with $ and the resulting string isn't expanded. For\n example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the\n VAR_NAME environment variable exists. For more information, see CMD in the\n Dockerfile reference and Define a command and arguments for a pod in the Kubernetes\n documentation.
The type and amount of resources to assign to a container. The supported resources include memory,\n cpu, and nvidia.com/gpu. For more information, see Resource management for pods\n and containers in the Kubernetes documentation.
The type and amount of resources to assign to a container. The supported resources include\n memory, cpu, and nvidia.com/gpu. For more information,\n see Resource management for pods and containers in the Kubernetes\n documentation.
A short human-readable string to provide additional details for a running or stopped container. It can be up to\n 255 characters long.
" + "smithy.api#documentation": "A short human-readable string to provide additional details for a running or stopped\n container. It can be up to 255 characters long.
" } }, "volumeMounts": { "target": "com.amazonaws.batch#EksContainerVolumeMounts", "traits": { - "smithy.api#documentation": "The volume mounts for the container. Batch supports emptyDir, hostPath, and\n secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes\n documentation.
The volume mounts for the container. Batch supports emptyDir,\n hostPath, and secret volume types. For more information about volumes\n and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
The security context for a job. For more information, see Configure a security context for a\n pod or container in the Kubernetes documentation.
" + "smithy.api#documentation": "The security context for a job. For more information, see Configure a\n security context for a pod or container in the Kubernetes\n documentation.
" } } }, "traits": { - "smithy.api#documentation": "The details for container properties that are returned by DescribeJobs for jobs that use\n Amazon EKS.
The details for container properties that are returned by DescribeJobs for jobs\n that use Amazon EKS.
The command to send to the container that overrides the default command from the Docker image or the job\n definition.
" + "smithy.api#documentation": "The command to send to the container that overrides the default command from the Docker\n image or the job definition.
" } }, "args": { "target": "com.amazonaws.batch#StringList", "traits": { - "smithy.api#documentation": "The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker\n image or the job definition. For more information, see CMD in the Dockerfile\n reference and Define a command an\n arguments for a pod in the Kubernetes documentation.
" + "smithy.api#documentation": "The arguments to the entrypoint to send to the container that overrides the default\n arguments from the Docker image or the job definition. For more information, see CMD in the\n Dockerfile reference and Define a command an arguments for a pod in the Kubernetes\n documentation.
" } }, "env": { "target": "com.amazonaws.batch#EksContainerEnvironmentVariables", "traits": { - "smithy.api#documentation": "The environment variables to send to the container. You can add new environment variables, which are added to\n the container at launch. Or, you can override the existing environment variables from the Docker image or the job\n definition.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The environment variables to send to the container. You can add new environment variables,\n which are added to the container at launch. Or, you can override the existing environment\n variables from the Docker image or the job definition.
\nEnvironment variables cannot start with \"AWS_BATCH\". This naming\n convention is reserved for variables that Batch sets.
The type and amount of resources to assign to a container. These override the settings in the job definition.\n The supported resources include memory, cpu, and nvidia.com/gpu. For more\n information, see Resource\n management for pods and containers in the Kubernetes documentation.
The type and amount of resources to assign to a container. These override the settings in\n the job definition. The supported resources include memory, cpu, and\n nvidia.com/gpu. For more information, see Resource\n management for pods and containers in the Kubernetes\n documentation.
Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API\n operation.
" + "smithy.api#documentation": "Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.
" } }, "com.amazonaws.batch#EksContainerOverrideList": { @@ -4329,18 +3604,18 @@ "limits": { "target": "com.amazonaws.batch#EksLimits", "traits": { - "smithy.api#documentation": "The type and quantity of the resources to reserve for the container. The values vary based on the\n name that's specified. Resources can be requested using either the limits or the\n requests objects.
The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\" suffix. If your container\n attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory\n for a job. memory can be specified in limits, requests, or both. If\n memory is specified in both places, then the value that's specified in limits must be\n equal to the value that's specified in requests.
To maximize your resource utilization, provide your jobs with as much memory as possible for the specific\n instance type that you are using. To learn how, see Memory management in the\n Batch User Guide.
\nThe number of CPUs that's reserved for the container. Values must be an even multiple of 0.25.\n cpu can be specified in limits, requests, or both. If cpu is\n specified in both places, then the value that's specified in limits must be at least as large as the\n value that's specified in requests.
The number of GPUs that's reserved for the container. Values must be a whole integer. memory can\n be specified in limits, requests, or both. If memory is specified in both\n places, then the value that's specified in limits must be equal to the value that's specified in\n requests.
The type and quantity of the resources to reserve for the container. The values vary based\n on the name that's specified. Resources can be requested using either the\n limits or the requests objects.
The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\"\n suffix. If your container attempts to exceed the memory specified, the container is\n terminated. You must specify at least 4 MiB of memory for a job. memory can be\n specified in limits, requests, or both. If memory is\n specified in both places, then the value that's specified in limits must be equal\n to the value that's specified in requests.
To maximize your resource utilization, provide your jobs with as much memory as possible\n for the specific instance type that you are using. To learn how, see Memory management in the\n Batch User Guide.
\nThe number of CPUs that's reserved for the container. Values must be an even multiple of\n 0.25. cpu can be specified in limits,\n requests, or both. If cpu is specified in both places, then the\n value that's specified in limits must be at least as large as the value that's\n specified in requests.
The number of GPUs that's reserved for the container. Values must be a whole integer.\n memory can be specified in limits, requests, or both.\n If memory is specified in both places, then the value that's specified in\n limits must be equal to the value that's specified in\n requests.
The type and quantity of the resources to request for the container. The values vary based on the\n name that's specified. Resources can be requested by using either the limits or the\n requests objects.
The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\" suffix. If your container\n attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory\n for a job. memory can be specified in limits, requests, or both. If\n memory is specified in both, then the value that's specified in limits must be equal to\n the value that's specified in requests.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n management in the Batch User Guide.
\nThe number of CPUs that are reserved for the container. Values must be an even multiple of 0.25.\n cpu can be specified in limits, requests, or both. If cpu is\n specified in both, then the value that's specified in limits must be at least as large as the value\n that's specified in requests.
The number of GPUs that are reserved for the container. Values must be a whole integer.\n nvidia.com/gpu can be specified in limits, requests, or both. If\n nvidia.com/gpu is specified in both, then the value that's specified in limits must be\n equal to the value that's specified in requests.
The type and quantity of the resources to request for the container. The values vary based\n on the name that's specified. Resources can be requested by using either the\n limits or the requests objects.
The memory hard limit (in MiB) for the container, using whole integers, with a \"Mi\"\n suffix. If your container attempts to exceed the memory specified, the container is\n terminated. You must specify at least 4 MiB of memory for a job. memory can be\n specified in limits, requests, or both. If memory is\n specified in both, then the value that's specified in limits must be equal to the\n value that's specified in requests.
If you're trying to maximize your resource utilization by providing your jobs as much\n memory as possible for a particular instance type, see Memory management in the\n Batch User Guide.
\nThe number of CPUs that are reserved for the container. Values must be an even multiple\n of 0.25. cpu can be specified in limits,\n requests, or both. If cpu is specified in both, then the value\n that's specified in limits must be at least as large as the value that's\n specified in requests.
The number of GPUs that are reserved for the container. Values must be a whole integer.\n nvidia.com/gpu can be specified in limits, requests,\n or both. If nvidia.com/gpu is specified in both, then the value that's specified\n in limits must be equal to the value that's specified in\n requests.
The type and amount of resources to assign to a container. The supported resources include memory,\n cpu, and nvidia.com/gpu. For more information, see Resource management for pods\n and containers in the Kubernetes documentation.
The type and amount of resources to assign to a container. The supported resources include\n memory, cpu, and nvidia.com/gpu. For more information,\n see Resource management for pods and containers in the Kubernetes\n documentation.
When this parameter is specified, the container is run as the specified user ID (uid). If this\n parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to\n RunAsUser and MustRanAs policy in the Users and groups pod\n security policies in the Kubernetes documentation.
When this parameter is specified, the container is run as the specified user ID\n (uid). If this parameter isn't specified, the default is the user that's specified\n in the image metadata. This parameter maps to RunAsUser and MustRanAs\n policy in the Users\n and groups pod security policies in the Kubernetes\n documentation.
When this parameter is specified, the container is run as the specified group ID (gid). If this\n parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to\n RunAsGroup and MustRunAs policy in the Users and groups pod\n security policies in the Kubernetes documentation.
When this parameter is specified, the container is run as the specified group ID\n (gid). If this parameter isn't specified, the default is the group that's specified\n in the image metadata. This parameter maps to RunAsGroup and MustRunAs\n policy in the Users\n and groups pod security policies in the Kubernetes\n documentation.
When this parameter is true, the container is given elevated permissions on the host container\n instance. The level of permissions are similar to the root user permissions. The default value is\n false. This parameter maps to privileged policy in the Privileged pod security\n policies in the Kubernetes documentation.
When this parameter is true, the container is given elevated permissions on the\n host container instance. The level of permissions are similar to the root user\n permissions. The default value is false. This parameter maps to\n privileged policy in the Privileged\n pod security policies in the Kubernetes documentation.
When this parameter is true, the container is given read-only access to its root file system. The\n default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file\n systems pod security policies in the Kubernetes documentation.
When this parameter is true, the container is given read-only access to its\n root file system. The default value is false. This parameter maps to\n ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes\n documentation.
When this parameter is specified, the container is run as a user with a uid other than 0. If this\n parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and\n MustRunAsNonRoot policy in the Users and groups pod\n security policies in the Kubernetes documentation.
When this parameter is specified, the container is run as a user with a uid\n other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to\n RunAsUser and MustRunAsNonRoot policy in the Users\n and groups pod security policies in the Kubernetes\n documentation.
The security context for a job. For more information, see Configure a security context for a\n pod or container in the Kubernetes documentation.
" + "smithy.api#documentation": "The security context for a job. For more information, see Configure a\n security context for a pod or container in the Kubernetes\n documentation.
" } }, "com.amazonaws.batch#EksContainerVolumeMount": { @@ -4387,7 +3662,7 @@ "name": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name the volume mount. This must match the name of one of the volumes in the pod.
" + "smithy.api#documentation": "The name the volume mount. This must match the name of one of the volumes in the\n pod.
" } }, "mountPath": { @@ -4399,12 +3674,12 @@ "readOnly": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "If this value is true, the container has read-only access to the volume. Otherwise, the container\n can write to the volume. The default value is false.
If this value is true, the container has read-only access to the volume.\n Otherwise, the container can write to the volume. The default value is false.
The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in\n Kubernetes, see Volumes in the Kubernetes\n documentation.
" + "smithy.api#documentation": "The volume mounts for a container for an Amazon EKS job. For more information about volumes and\n volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.
" } }, "com.amazonaws.batch#EksContainerVolumeMounts": { @@ -4425,7 +3700,7 @@ "medium": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The medium to store the volume. The default value is an empty string, which uses the storage of the node.
\n\n (Default) Use the disk storage of the node.
\nUse the tmpfs volume that's backed by the RAM of the node. Contents of the volume are lost when\n the node reboots, and any storage on the volume counts against the container's memory limit.
The medium to store the volume. The default value is an empty string, which uses the storage\n of the node.
\n\n (Default) Use the disk storage of the node.
\nUse the tmpfs volume that's backed by the RAM of the node. Contents of the\n volume are lost when the node reboots, and any storage on the volume counts against the\n container's memory limit.
Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir volume is first\n created when a pod is assigned to a node. It exists as long as that pod is running on that node. The\n emptyDir volume is initially empty. All containers in the pod can read and write the files in the\n emptyDir volume. However, the emptyDir volume can be mounted at the same or different paths\n in each container. When a pod is removed from a node for any reason, the data in the emptyDir is\n deleted permanently. For more information, see emptyDir in the Kubernetes\n documentation.
Specifies the configuration of a Kubernetes emptyDir volume. An\n emptyDir volume is first created when a pod is assigned to a node. It exists as\n long as that pod is running on that node. The emptyDir volume is initially empty.\n All containers in the pod can read and write the files in the emptyDir volume.\n However, the emptyDir volume can be mounted at the same or different paths in each\n container. When a pod is removed from a node for any reason, the data in the\n emptyDir is deleted permanently. For more information, see emptyDir in the\n Kubernetes documentation.
Specifies the configuration of a Kubernetes hostPath volume. A hostPath volume mounts an\n existing file or directory from the host node's filesystem into your pod. For more information, see hostPath in the Kubernetes\n documentation.
Specifies the configuration of a Kubernetes hostPath volume. A hostPath\n volume mounts an existing file or directory from the host node's filesystem into your pod. For\n more information, see hostPath in the Kubernetes documentation.
The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account\n to assume an IAM role in the Amazon EKS User Guide and Configure service accounts\n for pods in the Kubernetes documentation.
" + "smithy.api#documentation": "The name of the service account that's used to run the pod. For more information, see\n Kubernetes service\n accounts and Configure a Kubernetes service account\n to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes\n documentation.
" } }, "hostNetwork": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this\n to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't\n require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and\n Pod networking in the\n Kubernetes documentation.
Indicates if the pod uses the hosts' network IP address. The default value is\n true. Setting this to false enables the Kubernetes pod networking model.\n Most Batch workloads are egress-only and don't require the overhead of IP allocation for each\n pod for incoming connections. For more information, see Host\n namespaces and Pod networking\n in the Kubernetes documentation.
The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork\n parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates\n that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver\n inherited from the node. For more information, see Pod's DNS\n policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst | ClusterFirstWithHostNet\n
The DNS policy for the pod. The default value is ClusterFirst. If the\n hostNetwork parameter is not specified, the default is\n ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query\n that does not match the configured cluster domain suffix is forwarded to the upstream nameserver\n inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst |\n ClusterFirstWithHostNet\n
Specifies the volumes for a job definition that uses Amazon EKS resources.
" } + }, + "metadata": { + "target": "com.amazonaws.batch#EksMetadata" } }, "traits": { @@ -4506,19 +3801,19 @@ "serviceAccountName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account\n to assume an IAM role in the Amazon EKS User Guide and Configure service accounts\n for pods in the Kubernetes documentation.
" + "smithy.api#documentation": "The name of the service account that's used to run the pod. For more information, see\n Kubernetes service\n accounts and Configure a Kubernetes service account\n to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes\n documentation.
" } }, "hostNetwork": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this\n to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't\n require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and\n Pod networking in the\n Kubernetes documentation.
Indicates if the pod uses the hosts' network IP address. The default value is\n true. Setting this to false enables the Kubernetes pod networking model.\n Most Batch workloads are egress-only and don't require the overhead of IP allocation for each\n pod for incoming connections. For more information, see Host\n namespaces and Pod networking\n in the Kubernetes documentation.
The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork\n parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates\n that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver\n inherited from the node. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no\n value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The\n pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending\n on the value of the hostNetwork parameter. For more information, see Pod's DNS\n policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst | ClusterFirstWithHostNet\n
The DNS policy for the pod. The default value is ClusterFirst. If the\n hostNetwork parameter is not specified, the default is\n ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query\n that does not match the configured cluster domain suffix is forwarded to the upstream nameserver\n inherited from the node. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for\n dnsPolicy by either of DescribeJobDefinitions\n or DescribeJobs API operations. The pod spec setting will contain either\n ClusterFirst or ClusterFirstWithHostNet, depending on the value of the\n hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.
Valid values: Default | ClusterFirst |\n ClusterFirstWithHostNet\n
The overrides for the container that's used on the Amazon EKS pod.
" } + }, + "metadata": { + "target": "com.amazonaws.batch#EksMetadata" } }, "traits": { @@ -4621,7 +3919,7 @@ "secretName": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the secret. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain\n names in the Kubernetes documentation.
", + "smithy.api#documentation": "The name of the secret. The name must be allowed as a DNS subdomain name. For more\n information, see DNS subdomain names in the Kubernetes documentation.
", "smithy.api#required": {} } }, @@ -4633,7 +3931,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes\n documentation.
Specifies the configuration of a Kubernetes secret volume. For more information, see\n secret in the\n Kubernetes documentation.
The name of the volume. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain\n names in the Kubernetes documentation.
", + "smithy.api#documentation": "The name of the volume. The name must be allowed as a DNS subdomain name. For more\n information, see DNS subdomain names in the Kubernetes documentation.
", "smithy.api#required": {} } }, "hostPath": { "target": "com.amazonaws.batch#EksHostPath", "traits": { - "smithy.api#documentation": "Specifies the configuration of a Kubernetes hostPath volume. For more information, see hostPath in the Kubernetes\n documentation.
Specifies the configuration of a Kubernetes hostPath volume. For more information,\n see hostPath\n in the Kubernetes documentation.
Specifies the configuration of a Kubernetes emptyDir volume. For more information, see emptyDir in the Kubernetes\n documentation.
Specifies the configuration of a Kubernetes emptyDir volume. For more information,\n see emptyDir\n in the Kubernetes documentation.
Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes\n documentation.
Specifies the configuration of a Kubernetes secret volume. For more information, see\n secret in the\n Kubernetes documentation.
The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported\n value is 21 GiB and the maximum supported value is 200 GiB.
The amount of ephemeral storage to allocate for the task. This parameter is used to expand\n the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on\n Fargate.
" + } + }, "com.amazonaws.batch#EvaluateOnExit": { "type": "structure", "members": { "onStatusReason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "Contains a glob pattern to match against the StatusReason returned for a job. The pattern can\n contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including\n spaces or tabs). It can optionally end with\n an asterisk (*) so that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the StatusReason returned for a job.\n The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.),\n colons (:), and white spaces (including spaces or tabs).\n It can\n optionally end with an asterisk (*) so that only the start of the string needs to be an exact\n match.
Contains a glob pattern to match against the Reason returned for a job. The pattern can contain up\n to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and\n tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact\n match.
Contains a glob pattern to match against the Reason returned for a job. The\n pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons\n (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so\n that only the start of the string needs to be an exact match.
Contains a glob pattern to match against the decimal representation of the ExitCode returned for a\n job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so\n that only the start of the string needs to be an exact match.
The string can contain up to 512 characters.
" + "smithy.api#documentation": "Contains a glob pattern to match against the decimal representation of the\n ExitCode returned for a job. The pattern can be up to 512 characters long. It can\n contain only numbers, and can end with an asterisk (*) so that only the start of the string needs\n to be an exact match.
The string can contain up to 512 characters.
" } }, "action": { "target": "com.amazonaws.batch#RetryAction", "traits": { - "smithy.api#documentation": "Specifies the action to take if all of the specified conditions (onStatusReason,\n onReason, and onExitCode) are met. The values aren't case sensitive.
Specifies the action to take if all of the specified conditions\n (onStatusReason, onReason, and onExitCode) are met. The\n values aren't case sensitive.
Specifies an array of up to 5 conditions to be met, and an action to take (RETRY or\n EXIT) if all conditions are met. If none of the EvaluateOnExit conditions in a\n RetryStrategy match, then the job is retried.
Specifies an array of up to 5 conditions to be met, and an action to take\n (RETRY or EXIT) if all conditions are met. If none of the\n EvaluateOnExit conditions in a RetryStrategy match, then the job is\n retried.
The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in\n use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs\n to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).
" + "smithy.api#documentation": "The amount of time (in seconds) to use to calculate a fair share percentage for each fair\n share identifier in use. A value of zero (0) indicates that only current usage is measured. The\n decay allows for more recently run jobs to have more weight than jobs that ran earlier. The\n maximum supported value is 604800 (1 week).
" } }, "computeReservation": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already\n used.
\nThe reserved ratio is\n (computeReservation/100)^ActiveFairShares\n where\n \n ActiveFairShares\n is the number of active fair share identifiers.
For example, a computeReservation value of 50 indicates that Batchreserves 50% of the maximum\n available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It\n reserves 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates\n that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if\n there are two fair share identifiers, and 1.56% if there are three fair share identifiers.
The minimum value is 0 and the maximum value is 99.
" + "smithy.api#documentation": "A value used to reserve some of the available maximum vCPU for fair share identifiers that\n aren't already used.
\nThe reserved ratio is\n (computeReservation/100)^ActiveFairShares\n \n where \n ActiveFairShares\n is the number of active fair share\n identifiers.
For example, a computeReservation value of 50 indicates that Batchreserves\n 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if\n there are two fair share identifiers. It reserves 12.5% if there are three fair share\n identifiers. A computeReservation value of 25 indicates that Batch should reserve\n 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are\n two fair share identifiers, and 1.56% if there are three fair share identifiers.
The minimum value is 0 and the maximum value is 99.
" } }, "shareDistribution": { "target": "com.amazonaws.batch#ShareAttributesList", "traits": { - "smithy.api#documentation": "An array of SharedIdentifier objects that contain the weights for the fair share identifiers for\n the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.
An array of SharedIdentifier objects that contain the weights for the fair\n share identifiers for the fair share policy. Fair share identifiers that aren't included have a\n default weight of 1.0.
The Fargate platform version where the jobs are running. A platform version is specified only for jobs\n that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by\n default. This uses a recent, approved version of the Fargate platform for compute resources. For more\n information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
The Fargate platform version where the jobs are running. A platform version is\n specified only for jobs that are running on Fargate resources. If one isn't specified, the\n LATEST platform version is used by default. This uses a recent, approved version of\n the Fargate platform for compute resources. For more information, see Fargate\n platform versions in the Amazon Elastic Container Service Developer Guide.
The platform configuration for jobs that are running on Fargate resources. Jobs that run on EC2 resources must\n not specify this parameter.
" + "smithy.api#documentation": "The platform configuration for jobs that are running on Fargate resources. Jobs that run\n on EC2 resources must not specify this parameter.
" } }, "com.amazonaws.batch#Float": { @@ -4769,12 +4082,12 @@ "sourcePath": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The path on the host container instance that's presented to the container. If this parameter is empty, then the\n Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume\n persists at the specified location on the host container instance until you delete it manually. If the source path\n location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the\n contents of the source path folder are exported.
\nThis parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these\n jobs.
\nThe path on the host container instance that's presented to the container. If this parameter\n is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a\n file location, then the data volume persists at the specified location on the host container\n instance until you delete it manually. If the source path location doesn't exist on the host\n container instance, the Docker daemon creates it. If the location does exist, the contents of the\n source path folder are exported.
\nThis parameter isn't applicable to jobs that run on Fargate resources. Don't provide this\n for these jobs.
\nDetermine whether your data volume persists on the host container instance and where it's stored. If this\n parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't\n guaranteed to persist after the containers that are associated with it stop running.
" + "smithy.api#documentation": "Determine whether your data volume persists on the host container instance and where it's\n stored. If this parameter is empty, then the Docker daemon assigns a host path for your data\n volume. However, the data isn't guaranteed to persist after the containers that are associated\n with it stop running.
" } }, "com.amazonaws.batch#ImageIdOverride": { @@ -4889,44 +4202,44 @@ "type": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The type of job definition. It's either container or multinode. If the job is run on\n Fargate resources, then multinode isn't supported. For more information about multi-node parallel\n jobs, see Creating a multi-node parallel job\n definition in the Batch User Guide.
The type of job definition. It's either container or multinode. If\n the job is run on Fargate resources, then multinode isn't supported. For more\n information about multi-node parallel jobs, see Creating a multi-node parallel job definition in\n the Batch User Guide.
The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy.\n Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
" + "smithy.api#documentation": "The scheduling priority of the job definition. This only affects jobs in job queues with a\n fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority.
" } }, "parameters": { "target": "com.amazonaws.batch#ParametersMap", "traits": { - "smithy.api#documentation": "Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are\n specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding\n parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the\n Batch User Guide.
Default parameters or parameter substitution placeholders that are set in the job\n definition. Parameters are specified as a key-value pair mapping. Parameters in a\n SubmitJob request override any corresponding parameter defaults from the job\n definition. For more information about specifying parameters, see Job definition parameters in the\n Batch User Guide.
The retry strategy to use for failed jobs that are submitted with this job definition.
" + "smithy.api#documentation": "The retry strategy to use for failed jobs that are submitted with this job\n definition.
" } }, "containerProperties": { "target": "com.amazonaws.batch#ContainerProperties", "traits": { - "smithy.api#documentation": "An object with various properties specific to Amazon ECS based jobs. Valid values are\n containerProperties, eksProperties, and nodeProperties. Only one can be\n specified.
An object with various properties specific to Amazon ECS based jobs. Valid values are\n containerProperties, eksProperties, and nodeProperties.\n Only one can be specified.
The timeout time for jobs that are submitted with this job definition. After the amount of time you specify\n passes, Batch terminates your jobs if they aren't finished.
" + "smithy.api#documentation": "The timeout time for jobs that are submitted with this job definition. After the amount of\n time you specify passes, Batch terminates your jobs if they aren't finished.
" } }, "nodeProperties": { "target": "com.amazonaws.batch#NodeProperties", "traits": { - "smithy.api#documentation": "An object with various properties that are specific to multi-node parallel jobs. Valid values are\n containerProperties, eksProperties, and nodeProperties. Only one can be\n specified.
If the job runs on Fargate resources, don't specify nodeProperties. Use\n containerProperties instead.
An object with various properties that are specific to multi-node parallel jobs. Valid\n values are containerProperties, eksProperties, and\n nodeProperties. Only one can be specified.
If the job runs on Fargate resources, don't specify nodeProperties. Use\n containerProperties instead.
Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no\n value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created.\n For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined\n tags from the job and job definition is over 50, the job is moved to the FAILED state.
Specifies whether to propagate the tags from the job or job definition to the corresponding\n Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to\n the tasks when the tasks are created. For tags with the same name, job tags are given priority\n over job definitions tags. If the total number of combined tags from the job and job definition\n is over 50, the job is moved to the FAILED state.
The platform capabilities required by the job definition. If no value is specified, it defaults to\n EC2. Jobs run on Fargate resources specify FARGATE.
The platform capabilities required by the job definition. If no value is specified, it\n defaults to EC2. Jobs run on Fargate resources specify\n FARGATE.
An object with various properties that are specific to Amazon EKS based jobs. Valid values are\n containerProperties, eksProperties, and nodeProperties. Only one can be\n specified.
An object with various properties that are specific to Amazon EKS based jobs. Valid values are\n containerProperties, eksProperties, and nodeProperties.\n Only one can be specified.
The orchestration type of the compute environment. The valid values are ECS (default) or\n EKS.
The orchestration type of the compute environment. The valid values are ECS\n (default) or EKS.
The current status for the job.
\nIf your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the\n troubleshooting section of the Batch User Guide.
The current status for the job.
\nIf your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE\n status in the troubleshooting section of the\n Batch User Guide.
The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs\n with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
" + "smithy.api#documentation": "The scheduling policy of the job definition. This only affects jobs in job queues with a\n fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority.
" } }, "attempts": { @@ -5071,13 +4384,13 @@ "statusReason": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "A short, human-readable string to provide more details for the current status of the job.
" + "smithy.api#documentation": "A short, human-readable string to provide more details for the current status of the\n job.
" } }, "createdAt": { "target": "com.amazonaws.batch#Long", "traits": { - "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs,\n this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and\n entered the PENDING state.
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and\n parent array jobs, this is when the job entered the SUBMITTED state. This is\n specifically at the time SubmitJob was called. For array child jobs, this is\n when the child job was spawned by its parent and entered the PENDING state.
The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job\n transitioned from the STARTING state to the RUNNING state. This parameter isn't provided\n for child jobs of array jobs or multi-node parallel jobs.
The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's\n when the job transitioned from the STARTING state to the RUNNING state.\n This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job\n transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or\n FAILED.
The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's\n when the job transitioned from the RUNNING state to a terminal state, such as\n SUCCEEDED or FAILED.
Additional parameters that are passed to the job that replace parameter substitution placeholders or override\n any corresponding parameter defaults from the job definition.
" + "smithy.api#documentation": "Additional parameters that are passed to the job that replace parameter substitution\n placeholders or override any corresponding parameter defaults from the job definition.
" } }, "container": { "target": "com.amazonaws.batch#ContainerDetail", "traits": { - "smithy.api#documentation": "An object that represents the details for the container that's associated with the job.
" + "smithy.api#documentation": "An object that represents the details for the container that's associated with the\n job.
" } }, "nodeDetails": { "target": "com.amazonaws.batch#NodeDetails", "traits": { - "smithy.api#documentation": "An object that represents the details of a node that's associated with a multi-node parallel job.
" + "smithy.api#documentation": "An object that represents the details of a node that's associated with a multi-node parallel\n job.
" } }, "nodeProperties": { @@ -5157,19 +4470,19 @@ "propagateTags": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no\n value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created.\n For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined\n tags from the job and job definition is over 50, the job is moved to the FAILED state.
Specifies whether to propagate the tags from the job or job definition to the corresponding\n Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to\n the tasks when the tasks are created. For tags with the same name, job tags are given priority\n over job definitions tags. If the total number of combined tags from the job and job definition\n is over 50, the job is moved to the FAILED state.
The platform capabilities required by the job definition. If no value is specified, it defaults to\n EC2. Jobs run on Fargate resources specify FARGATE.
The platform capabilities required by the job definition. If no value is specified, it\n defaults to EC2. Jobs run on Fargate resources specify\n FARGATE.
An object with various properties that are specific to Amazon EKS based jobs. Only one of container,\n eksProperties, or nodeDetails is specified.
An object with various properties that are specific to Amazon EKS based jobs. Only one of\n container, eksProperties, or nodeDetails is\n specified.
Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can\n accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already\n in the queue can finish.
Describes the ability of the queue to accept new jobs. If the job queue state is\n ENABLED, it can accept jobs. If the job queue state is DISABLED, new\n jobs can't be added to the queue, but jobs already in the queue can finish.
The Amazon Resource Name (ARN) of the scheduling policy. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
The Amazon Resource Name (ARN) of the scheduling policy. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n For example,\n aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
The status of the job queue (for example, CREATING or VALID).
The status of the job queue (for example, CREATING or\n VALID).
A short, human-readable string to provide additional details for the current status of the job queue.
" + "smithy.api#documentation": "A short, human-readable string to provide additional details for the current status of the\n job queue.
" } }, "priority": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The priority of the job queue. Job queues with a higher priority (or a higher integer value for the\n priority parameter) are evaluated first when associated with the same compute environment. Priority is\n determined in descending order. For example, a job queue with a priority value of 10 is given scheduling\n preference over a job queue with a priority value of 1. All of the compute environments must be either\n EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and\n Fargate compute environments can't be mixed.
The priority of the job queue. Job queues with a higher priority (or a higher integer value\n for the priority parameter) are evaluated first when associated with the same\n compute environment. Priority is determined in descending order. For example, a job queue with a\n priority value of 10 is given scheduling preference over a job queue with a priority\n value of 1. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and\n Fargate compute environments can't be mixed.
The compute environments that are attached to the job queue and the order that job placement is preferred.\n Compute environments are selected for job placement in ascending order.
", + "smithy.api#documentation": "The compute environments that are attached to the job queue and the order that job placement\n is preferred. Compute environments are selected for job placement in ascending order.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "The tags that are applied to the job queue. For more information, see Tagging your Batch resources in\n Batch User Guide.
" + "smithy.api#documentation": "The tags that are applied to the job queue. For more information, see Tagging your Batch resources in\n Batch User Guide.
" } } }, @@ -5357,7 +4670,7 @@ "createdAt": { "target": "com.amazonaws.batch#Long", "traits": { - "smithy.api#documentation": "The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs,\n this is when the job entered the SUBMITTED state (at the time SubmitJob was called).\n For array child jobs, this is when the child job was spawned by its parent and entered the PENDING\n state.
The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and\n parent array jobs, this is when the job entered the SUBMITTED state (at the time\n SubmitJob was called). For array child jobs, this is when the child job was\n spawned by its parent and entered the PENDING state.
A short, human-readable string to provide more details for the current status of the job.
" + "smithy.api#documentation": "A short, human-readable string to provide more details for the current status of the\n job.
" } }, "startedAt": { "target": "com.amazonaws.batch#Long", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the\n STARTING state to the RUNNING state.
The Unix timestamp for when the job was started. More specifically, it's when the job\n transitioned from the STARTING state to the RUNNING state.
The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the\n RUNNING state to a terminal state, such as SUCCEEDED or FAILED.
The Unix timestamp for when the job was stopped. More specifically, it's when the job\n transitioned from the RUNNING state to a terminal state, such as\n SUCCEEDED or FAILED.
An object that represents the details of the container that's associated with the job.
" + "smithy.api#documentation": "An object that represents the details of the container that's associated with the\n job.
" } }, "arrayProperties": { @@ -5425,7 +4738,7 @@ "attemptDurationSeconds": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After\n this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60\n seconds.
For array jobs, the timeout applies to the child jobs, not to the parent array job.
\nFor multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.
" + "smithy.api#documentation": "The job timeout time (in seconds) that's measured from the job attempt's\n startedAt timestamp. After this time passes, Batch terminates your jobs if they\n aren't finished. The minimum value for the timeout is 60 seconds.
For array jobs, the timeout applies to the child jobs, not to the parent array job.
\nFor multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the\n individual nodes.
" } } }, @@ -5439,13 +4752,13 @@ "name": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the environment variable.
" + "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the\n environment variable.
" } }, "value": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the environment\n variable.
" + "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the\n environment variable.
" } } }, @@ -5470,7 +4783,7 @@ } }, "traits": { - "smithy.api#documentation": "A filter name and value pair that's used to return a more specific list of results from a ListJobs\n API operation.
A filter name and value pair that's used to return a more specific list of results from a\n ListJobs API operation.
The version number of the launch template, $Latest, or $Default.
If the value is $Latest, the latest version of the launch template is used. If the value is\n $Default, the default version of the launch template is used.
If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the\n compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the\n compute environment is set to true. During an infrastructure update, if either $Latest or\n $Default is specified, Batch re-evaluates the launch template version, and it might use a different\n version of the launch template. This is the case even if the launch template isn't specified in the update. When\n updating a compute environment, changing the launch template requires an infrastructure update of the compute\n environment. For more information, see Updating compute environments in the\n Batch User Guide.
Default: $Default.
The version number of the launch template, $Latest, or\n $Default.
If the value is $Latest, the latest version of the launch template is used. If\n the value is $Default, the default version of the launch template is used.
If the AMI ID that's used in a compute environment is from the launch template, the AMI\n isn't changed when the compute environment is updated. It's only changed if the\n updateToLatestImageVersion parameter for the compute environment is set to\n true. During an infrastructure update, if either $Latest or\n $Default is specified, Batch re-evaluates the launch template version, and it\n might use a different version of the launch template. This is the case even if the launch\n template isn't specified in the update. When updating a compute environment, changing the launch\n template requires an infrastructure update of the compute environment. For more information, see\n Updating compute\n environments in the Batch User Guide.
Default: $Default.
An object that represents a launch template that's associated with a compute resource. You must specify either\n the launch template ID or launch template name in the request, but not both.
\nIf security groups are specified using both the securityGroupIds parameter of\n CreateComputeEnvironment and the launch template, the values in the securityGroupIds\n parameter of CreateComputeEnvironment will be used.
This object isn't applicable to jobs that are running on Fargate resources.
\nAn object that represents a launch template that's associated with a compute resource. You\n must specify either the launch template ID or launch template name in the request, but not\n both.
\nIf security groups are specified using both the securityGroupIds parameter of\n CreateComputeEnvironment and the launch template, the values in the\n securityGroupIds parameter of CreateComputeEnvironment will be\n used.
This object isn't applicable to jobs that are running on Fargate resources.
\nAny of the host devices to expose to the container. This parameter maps to Devices in the\n Create a container section of the Docker Remote API and the --device option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these\n jobs.
\nAny of the host devices to expose to the container. This parameter maps to\n Devices in the Create a container section of the Docker Remote API\n and the --device option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs.
\nIf true, run an init process inside the container that forwards signals and reaps processes. This\n parameter maps to the --init option to docker run.\n This parameter requires version 1.25 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
If true, run an init process inside the container that forwards signals and\n reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the\n --shm-size option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these\n jobs.
\nThe value for the size (in MiB) of the /dev/shm volume. This parameter maps to\n the --shm-size option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs.
\nThe container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the\n --tmpfs option to docker run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter\n for this resource type.
\nThe container path, mount options, and size (in MiB) of the tmpfs mount. This\n parameter maps to the --tmpfs option to docker\n run.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide this parameter for this resource type.
\nThe total amount of swap memory (in MiB) a container can use. This parameter is translated to the\n --memory-swap option to docker run where the value is the\n sum of the container memory plus the maxSwap value. For more information, see \n --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values\n are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't\n use the swap configuration for the container instance that it's running on. A maxSwap value must be set\n for the swappiness parameter to be used.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these\n jobs.
\nThe total amount of swap memory (in MiB) a container can use. This parameter is translated\n to the --memory-swap option to docker\n run where the value is the sum of the container memory plus the maxSwap\n value. For more information, see \n --memory-swap details in the Docker documentation.
If a maxSwap value of 0 is specified, the container doesn't use\n swap. Accepted values are 0 or any positive integer. If the maxSwap\n parameter is omitted, the container doesn't use the swap configuration for the container instance\n that it's running on. A maxSwap value must be set for the swappiness\n parameter to be used.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs.
\nYou can use this parameter to tune a container's memory swappiness behavior. A swappiness value of\n 0 causes swapping to not occur unless absolutely necessary. A swappiness value of\n 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and\n 100. If the swappiness parameter isn't specified, a default value of 60 is\n used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is\n set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to\n docker run.
Consider the following when you use a per-container swap configuration.
\nSwap space must be enabled and allocated on the container instance for the containers to use.
\nBy default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use\n this feature. For more information, see Instance store swap volumes in the\n Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an\n Amazon EC2 instance by using a swap file?\n
\nThe swap space parameters are only supported for job definitions using EC2 resources.
\nIf the maxSwap and swappiness parameters are omitted from a job definition, each\n container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times\n the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these\n jobs.
\nYou can use this parameter to tune a container's memory swappiness behavior. A\n swappiness value of 0 causes swapping to not occur unless absolutely\n necessary. A swappiness value of 100 causes pages to be swapped\n aggressively. Valid values are whole numbers between 0 and 100. If the\n swappiness parameter isn't specified, a default value of 60 is used.\n If a value isn't specified for maxSwap, then this parameter is ignored. If\n maxSwap is set to 0, the container doesn't use swap. This parameter maps to the\n --memory-swappiness option to docker\n run.
Consider the following when you use a per-container swap configuration.
\nSwap space must be enabled and allocated on the container instance for the containers to\n use.
\nBy default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the\n instance to use this feature. For more information, see Instance store swap\n volumes in the Amazon EC2 User Guide for Linux Instances or How do I\n allocate memory to work as swap space in an Amazon EC2 instance by using a swap\n file?\n
\nThe swap space parameters are only supported for job definitions using EC2\n resources.
\nIf the maxSwap and swappiness parameters are omitted from a job\n definition, each container has a default swappiness value of 60. Moreover, the\n total swap usage is limited to two times the memory reservation of the container.
This parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs.
\nLinux-specific modifications that are applied to the container, such as details for device mappings.
" + "smithy.api#documentation": "Linux-specific modifications that are applied to the container, such as details for device\n mappings.
" } }, "com.amazonaws.batch#ListJobs": { @@ -5636,7 +4949,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the parameters for ListJobs.
Contains the parameters for ListJobs.
The nextToken value to include in a future ListJobs request. When the results of a\n ListJobs request exceed maxResults, this value can be used to retrieve the next page of\n results. This value is null when there are no more results to return.
Contains the parameters for ListSchedulingPolicies.
Contains the parameters for ListSchedulingPolicies.
The nextToken value to include in a future ListSchedulingPolicies request. When the\n results of a ListSchedulingPolicies request exceed maxResults, this value can be used to\n retrieve the next page of results. This value is null when there are no more results to return.
Contains the parameters for ListTagsForResource.
Contains the parameters for ListTagsForResource.
The tags for the resource.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.batch#LogConfiguration": { @@ -5783,7 +5108,7 @@ "logDriver": { "target": "com.amazonaws.batch#LogDriver", "traits": { - "smithy.api#documentation": "The log driver to use for the container. The valid values that are listed for this parameter are log drivers\n that the Amazon ECS container agent can communicate with by default.
\nThe supported log drivers are awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.
Jobs that are running on Fargate resources are restricted to the awslogs and splunk\n log drivers.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the\n Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.
\nSpecifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the\n Docker documentation.
\nSpecifies the Graylog Extended Format (GELF) logging driver. For more information including usage and\n options, see Graylog Extended Format logging\n driver in the Docker documentation.
\nSpecifies the journald logging driver. For more information including usage and options, see Journald logging driver in the\n Docker documentation.
\nSpecifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the\n Docker documentation.
\nSpecifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the\n Docker documentation.
\nSpecifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the\n Docker documentation.
\nIf you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you\n can fork the Amazon ECS container agent project that's available on\n GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that\n you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The log driver to use for the container. The valid values that are listed for this parameter\n are log drivers that the Amazon ECS container agent can communicate with by default.
\nThe supported log drivers are awslogs, fluentd, gelf,\n json-file, journald, logentries, syslog, and\n splunk.
Jobs that are running on Fargate resources are restricted to the awslogs and\n splunk log drivers.
Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver\n in the Batch User Guide and Amazon CloudWatch Logs logging\n driver in the Docker documentation.
\nSpecifies the Fluentd logging driver. For more information including usage and options,\n see Fluentd logging\n driver in the Docker documentation.
\nSpecifies the Graylog Extended Format (GELF) logging driver. For more information\n including usage and options, see Graylog Extended Format logging\n driver in the Docker documentation.
\nSpecifies the journald logging driver. For more information including usage and options,\n see Journald logging\n driver in the Docker documentation.
\nSpecifies the JSON file logging driver. For more information including usage and options,\n see JSON File\n logging driver in the Docker documentation.
\nSpecifies the Splunk logging driver. For more information including usage and options,\n see Splunk logging\n driver in the Docker documentation.
\nSpecifies the syslog logging driver. For more information including usage and options,\n see Syslog logging\n driver in the Docker documentation.
\nIf you have a custom driver that's not listed earlier that you want to work with the Amazon ECS\n container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to\n work with that driver. We encourage you to submit pull requests for changes that you want to\n have included. However, Amazon Web Services doesn't currently support running modified copies of this\n software.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your\n container instance. To check the Docker Remote API version on your container instance, log in to your\n container instance and run the following command: sudo docker version | grep \"Server API version\"\n
The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the\n Batch User Guide.
" + "smithy.api#documentation": "The secrets to pass to the log configuration. For more information, see Specifying sensitive\n data in the Batch User Guide.
" } } }, @@ -5875,7 +5200,7 @@ "readOnly": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "If this value is true, the container has read-only access to the volume. Otherwise, the container\n can write to the volume. The default value is false.
If this value is true, the container has read-only access to the volume.\n Otherwise, the container can write to the volume. The default value is false.
Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to\n Volumes in the Create a\n container section of the Docker Remote API and the --volume option to\n docker run.
Details for a Docker volume mount point that's used in a job's container properties. This\n parameter maps to Volumes in the Create a container section of the Docker Remote API and the\n --volume option to docker run.
Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private\n subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires\n a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking in the\n Amazon Elastic Container Service Developer Guide. The default value is \"DISABLED\".
Indicates whether the job has a public IP address. For a job that's running on Fargate\n resources in a private subnet to send outbound traffic to the internet (for example, to pull\n container images), the private subnet requires a NAT gateway be attached to route requests to the\n internet. For more information, see Amazon ECS task networking in the\n Amazon Elastic Container Service Developer Guide. The default value is \"DISABLED\".
The network configuration for jobs that are running on Fargate resources. Jobs that are running on EC2\n resources must not specify this parameter.
" + "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on EC2 resources must not specify this parameter.
" } }, "com.amazonaws.batch#NetworkInterface": { @@ -5932,7 +5257,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that represents the elastic network interface for a multi-node parallel job node.
" + "smithy.api#documentation": "An object that represents the elastic network interface for a multi-node parallel job\n node.
" } }, "com.amazonaws.batch#NetworkInterfaceList": { @@ -5947,7 +5272,7 @@ "nodeIndex": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The node index for the node. Node index numbering starts at zero. This index is also available on the node with\n the AWS_BATCH_JOB_NODE_INDEX environment variable.
The node index for the node. Node index numbering starts at zero. This index is also\n available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are\n specified in the job definition. To use this override, you must meet the following conditions:
\nThere must be at least one node range in your job definition that has an open upper boundary, such as\n : or n:.
The lower boundary of the node range that's specified in the job definition must be fewer than the number of\n nodes specified in the override.
\nThe main node index that's specified in the job definition must be fewer than the number of nodes specified in\n the override.
\nThe number of nodes to use with a multi-node parallel job. This value overrides the number\n of nodes that are specified in the job definition. To use this override, you must meet the\n following conditions:
\nThere must be at least one node range in your job definition that has an open upper\n boundary, such as : or n:.
The lower boundary of the node range that's specified in the job definition must be fewer\n than the number of nodes specified in the override.
\nThe main node index that's specified in the job definition must be fewer than the number\n of nodes specified in the override.
\nAn object that represents any node overrides to a job definition that's used in a SubmitJob\n API operation.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these\n jobs. Rather, use containerOverrides instead.
An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
\nThis parameter isn't applicable to jobs that are running on Fargate resources. Don't\n provide it for these jobs. Rather, use containerOverrides instead.
Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer\n than the number of nodes.
", + "smithy.api#documentation": "Specifies the node index for the main node of a multi-node parallel job. This node index\n value must be fewer than the number of nodes.
", "smithy.api#required": {} } }, "nodeRangeProperties": { "target": "com.amazonaws.batch#NodeRangeProperties", "traits": { - "smithy.api#documentation": "A list of node ranges and their properties that are associated with a multi-node parallel job.
", + "smithy.api#documentation": "A list of node ranges and their properties that are associated with a multi-node parallel\n job.
", "smithy.api#required": {} } } @@ -6028,12 +5353,12 @@ "nodeIndex": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The node index for the node. Node index numbering begins at zero. This index is also available on the node with\n the AWS_BATCH_JOB_NODE_INDEX environment variable.
The node index for the node. Node index numbering begins at zero. This index is also\n available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.
An object that represents the properties of a node that's associated with a multi-node parallel job.
" + "smithy.api#documentation": "An object that represents the properties of a node that's associated with a multi-node\n parallel job.
" } }, "com.amazonaws.batch#NodePropertyOverride": { @@ -6042,7 +5367,7 @@ "targetNodes": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The range of nodes, using node index values, that's used to override. A range of 0:3 indicates\n nodes with index values of 0 through 3. If the starting range value is omitted\n (:n), then 0 is used to start the range. If the ending range value is omitted\n (n:), then the highest possible node index is used to end the range.
The range of nodes, using node index values, that's used to override. A range of\n 0:3 indicates nodes with index values of 0 through 3. If\n the starting range value is omitted (:n), then 0 is used to start the\n range. If the ending range value is omitted (n:), then the highest possible node\n index is used to end the range.
The object that represents any node overrides to a job definition that's used in a SubmitJob\n API operation.
" + "smithy.api#documentation": "The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
" } }, "com.amazonaws.batch#NodePropertyOverrides": { @@ -6075,7 +5400,7 @@ "targetNodes": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of\n 0 through 3. If the starting range value is omitted (:n), then 0\n is used to start the range. If the ending range value is omitted (n:), then the highest possible node\n index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can\n nest node ranges (for example, 0:10 and 4:5). In this case, the 4:5 range\n properties override the 0:10 properties.
The range of nodes, using node index values. A range of 0:3 indicates nodes\n with index values of 0 through 3. If the starting range value is\n omitted (:n), then 0 is used to start the range. If the ending range\n value is omitted (n:), then the highest possible node index is used to end the\n range. Your accumulative node ranges must account for all nodes (0:n). You can nest\n node ranges (for example, 0:10 and 4:5). In this case, the\n 4:5 range properties override the 0:10 properties.
An object that represents the properties of the node range for a multi-node parallel job.
" + "smithy.api#documentation": "An object that represents the properties of the node range for a multi-node parallel\n job.
" } }, "com.amazonaws.batch#OrchestrationType": { @@ -6252,7 +5577,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the parameters for RegisterJobDefinition.
Contains the parameters for RegisterJobDefinition.
The quantity of the specified resource to reserve for the container. The values vary based on the\n type specified.
The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all\n containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched\n on.
\nGPUs aren't available for jobs that are running on Fargate resources.
\nThe memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are\n running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated.\n This parameter maps to Memory in the Create a container section of the\n Docker Remote API and the --memory option to docker run.\n You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for\n multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to\n Memory in the Create a container section of the Docker Remote API and the\n --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for\n a particular instance type, see Memory\n management in the Batch User Guide.
\nFor jobs that are running on Fargate resources, then value is the hard limit (in MiB), and\n must match one of the supported values and the VCPU values must be one of the values supported for\n that memory value.
\n VCPU = 0.25
\n VCPU = 0.25 or 0.5
\n VCPU = 0.25, 0.5, or 1
\n VCPU = 0.5, or 1
\n VCPU = 0.5, 1, or 2
\n VCPU = 1 or 2
\n VCPU = 1, 2, 4, or 8
\n VCPU = 2 or 4
\n VCPU = 2, 4, or 8
\n VCPU = 4
\n VCPU = 4 or 8
\n VCPU = 8
\n VCPU = 8 or 16
\n VCPU = 16
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the\n Create a container section of the Docker Remote API and the --cpu-shares option to\n docker run. Each vCPU is equivalent to 1,024 CPU shares. For EC2\n resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be\n specified for each node at least once.
The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about\n Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.
\nFor jobs that are running on Fargate resources, then value must match one of the supported\n values and the MEMORY values must be one of the values supported for that VCPU value.\n The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16
\n MEMORY = 512, 1024, or 2048
\n MEMORY = 1024, 2048, 3072, or 4096
\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440\n
\n MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880\n
The quantity of the specified resource to reserve for the container. The values vary based\n on the type specified.
The number of physical GPUs to reserve for the container. Make sure that the number of\n GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the\n compute resource that the job is launched on.
\nGPUs aren't available for jobs that are running on Fargate resources.
\nThe memory hard limit (in MiB) present to the container. This parameter is supported for\n jobs that are running on EC2 resources. If your container attempts to exceed the memory\n specified, the container is terminated. This parameter maps to Memory in the\n Create a container section of the Docker Remote API and the\n --memory option to docker run. You\n must specify at least 4 MiB of memory for a job. This is required but can be specified in\n several places for multi-node parallel (MNP) jobs. It must be specified for each node at least\n once. This parameter maps to Memory in the Create a container\n section of the Docker Remote API and the --memory option to docker run.
If you're trying to maximize your resource utilization by providing your jobs as much\n memory as possible for a particular instance type, see Memory management in the\n Batch User Guide.
\nFor jobs that are running on Fargate resources, then value is the hard\n limit (in MiB), and must match one of the supported values and the VCPU values\n must be one of the values supported for that memory value.
\n VCPU = 0.25
\n VCPU = 0.25 or 0.5
\n VCPU = 0.25, 0.5, or 1
\n VCPU = 0.5, or 1
\n VCPU = 0.5, 1, or 2
\n VCPU = 1 or 2
\n VCPU = 1, 2, or 4
\n VCPU = 2 or 4
\n VCPU = 2, 4, or 8
\n VCPU = 4
\n VCPU = 4 or 8
\n VCPU = 8
\n VCPU = 8 or 16
\n VCPU = 16
The number of vCPUs reserved for the container. This parameter maps to\n CpuShares in the Create a container section of the\n Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares.\n For EC2 resources, you must specify at least one vCPU. This is required but can be specified\n in several places; it must be specified for each node at least once.
The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more\n information about Fargate quotas, see Fargate quotas\n in the Amazon Web Services General Reference.
\nFor jobs that are running on Fargate resources, then value must match one\n of the supported values and the MEMORY values must be one of the values supported\n for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and\n 16
\n MEMORY = 512, 1024, or 2048
\n MEMORY = 1024, 2048, 3072, or 4096
\n MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192
\n MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384
\n MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456,\n 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720
\n MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440\n
\n MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880\n
The type of resource to assign to a container. The supported resources include GPU,\n MEMORY, and VCPU.
The type of resource to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.
The type and amount of a resource to assign to a container. The supported resources include GPU,\n MEMORY, and VCPU.
The type and amount of a resource to assign to a container. The supported resources include\n GPU, MEMORY, and VCPU.
The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10\n attempts. If the value of attempts is greater than one, the job is retried on failure the same number of\n attempts as the value.
The number of times to move a job to the RUNNABLE status. You can specify\n between 1 and 10 attempts. If the value of attempts is greater than one, the job is\n retried on failure the same number of attempts as the value.
Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is\n specified, then the attempts parameter must also be specified. If none of the listed conditions match,\n then the job is retried.
Array of up to 5 objects that specify the conditions where jobs are retried or failed. If\n this parameter is specified, then the attempts parameter must also be specified. If\n none of the listed conditions match, then the job is retried.
The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.
" + "smithy.api#documentation": "The retry strategy that's associated with a job. For more information, see Automated job retries in the\n Batch User Guide.
" } }, "com.amazonaws.batch#SchedulingPolicyDetail": { @@ -6382,7 +5711,7 @@ "arn": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduling policy. An example is\n arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority\n .
The Amazon Resource Name (ARN) of the scheduling policy. An example is\n arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority\n .
The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of\n a key and an optional value. For more information, see Tagging Amazon Web Services resources in Amazon Web Services General\n Reference.
" + "smithy.api#documentation": "The tags that you apply to the scheduling policy to categorize and organize your resources.\n Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services resources in\n Amazon Web Services General Reference.
" } } }, @@ -6421,7 +5750,7 @@ } }, "traits": { - "smithy.api#documentation": "An object that contains the details of a scheduling policy that's returned in a\n ListSchedulingPolicy action.
An object that contains the details of a scheduling policy that's returned in a\n ListSchedulingPolicy action.
The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or\n the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
\nIf the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use\n either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN\n must be specified.
\nThe secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of\n the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.
\nIf the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're\n launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter\n exists in a different Region, then the full ARN must be specified.
\nAn object that represents the secret to expose to your container. Secrets can be exposed to a container in the\n following ways:
\nTo inject sensitive data into your containers as environment variables, use the secrets container\n definition parameter.
To reference sensitive information in the log configuration of a container, use the secretOptions\n container definition parameter.
For more information, see Specifying\n sensitive data in the Batch User Guide.
" + "smithy.api#documentation": "An object that represents the secret to expose to your container. Secrets can be exposed to\n a container in the following ways:
\nTo inject sensitive data into your containers as environment variables, use the\n secrets container definition parameter.
To reference sensitive information in the log configuration of a container, use the\n secretOptions container definition parameter.
For more information, see Specifying sensitive data in the\n Batch User Guide.
" } }, "com.amazonaws.batch#SecretList": { @@ -6477,19 +5806,19 @@ "shareIdentifier": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry\n specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share\n identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a\n shareIdentifier of UserA* and another that specifies a shareIdentifier of\n UserA-1.
There can be no more than 500 fair share identifiers active in a job queue.
\nThe string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).
", + "smithy.api#documentation": "A fair share identifier or fair share identifier prefix. If the string ends with an asterisk\n (*), this entry specifies the weight factor to use for fair share identifiers that start with\n that prefix. The list of fair share identifiers in a fair share policy can't overlap. For\n example, you can't have one that specifies a shareIdentifier of UserA*\n and another that specifies a shareIdentifier of UserA-1.
There can be no more than 500 fair share identifiers active in a job queue.
\nThe string is limited to 255 alphanumeric characters, and can be followed by an asterisk\n (*).
", "smithy.api#required": {} } }, "weightFactor": { "target": "com.amazonaws.batch#Float", "traits": { - "smithy.api#documentation": "The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority\n for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times\n the compute resources of jobs that use a share identifier with a weight factor of 1.
\nThe smallest supported value is 0.0001, and the largest supported value is 999.9999.
" + "smithy.api#documentation": "The weight factor for the fair share identifier. The default value is 1.0. A lower value has\n a higher priority for compute resources. For example, jobs that use a share identifier with a\n weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share\n identifier with a weight factor of 1.
\nThe smallest supported value is 0.0001, and the largest supported value is 999.9999.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that\n aren't included have a default weight of 1.0.
Specifies the weights for the fair share identifiers for the fair share policy. Fair share\n identifiers that aren't included have a default weight of 1.0.
The job definition used by this job. This value can be one of name, name:revision, or\n the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active\n revision is used.
The job definition used by this job. This value can be one of definition-name,\n definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with or without the revision\n (arn:aws:batch:region:account:job-definition/definition-name:revision\n ,\n or\n arn:aws:batch:region:account:job-definition/definition-name\n ).
If the revision is not specified, then the latest active revision is used.
", "smithy.api#required": {} } }, @@ -6630,7 +5959,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the parameters for SubmitJob.
Contains the parameters for SubmitJob.
Contains the parameters for TagResource.
Contains the parameters for TagResource.
Contains the parameters for TerminateJob.
Contains the parameters for TerminateJob.
The absolute file path in the container where the tmpfs volume is mounted.
The absolute file path in the container where the tmpfs volume is\n mounted.
The list of tmpfs volume mount options.
Valid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" |\n \"nosuid\" | \"dev\" | \"nodev\" | \"exec\" | \"noexec\" |\n \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" |\n \"nomand\" | \"atime\" | \"noatime\" | \"diratime\" |\n \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" | \"private\" |\n \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" | \"norelatime\" |\n \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" |\n \"gid\" | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"
The list of tmpfs volume mount options.
Valid values: \"defaults\" | \"ro\" | \"rw\" |\n \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n \"exec\" | \"noexec\" | \"sync\" | \"async\" |\n \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n \"atime\" | \"noatime\" | \"diratime\" |\n \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" | \"runbindable\" |\n \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" | \"relatime\" |\n \"norelatime\" | \"strictatime\" | \"nostrictatime\" |\n \"mode\" | \"uid\" | \"gid\" | \"nr_inodes\" |\n \"nr_blocks\" | \"mpol\"
Contains the parameters for UntagResource.
Contains the parameters for UntagResource.
The state of the compute environment. Compute environments in the ENABLED state can accept jobs\n from a queue and scale in or out automatically based on the workload demand of its associated queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated\n job queue on the compute resources within the environment. If the compute environment is managed, then it can scale\n its instances out or in automatically, based on the job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the\n environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed\n compute environments in the DISABLED state don't scale out. However, they scale in to\n minvCpus value after instances become idle.
The state of the compute environment. Compute environments in the ENABLED\n state can accept jobs from a queue and scale in or out automatically based on the workload\n demand of its associated queues.
If the state is ENABLED, then the Batch scheduler can attempt to place jobs\n from an associated job queue on the compute resources within the environment. If the compute\n environment is managed, then it can scale its instances out or in automatically, based on the\n job queue demand.
If the state is DISABLED, then the Batch scheduler doesn't attempt to place\n jobs within the environment. Jobs in a STARTING or RUNNING state\n continue to progress normally. Managed compute environments in the DISABLED state\n don't scale out.
Compute environments in a DISABLED state may continue to incur billing\n charges. To prevent additional charges, turn off and then delete the compute environment.\n For more information, see State in the Batch User Guide.
When an instance is idle, the instance scales down to the minvCpus value.\n However, the instance size doesn't change. For example, consider a c5.8xlarge\n instance with a minvCpus value of 4 and a desiredvCpus\n value of 36. This instance doesn't scale down to a c5.large\n instance.
The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this\n parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU\n capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity\n is reserved.
" + "smithy.api#documentation": "The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this\n parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU\n capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is\n reserved.
" } }, "computeResources": { @@ -7004,7 +6349,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the parameters for UpdateComputeEnvironment.
Contains the parameters for UpdateComputeEnvironment.
The Amazon Resource Name (ARN) of the compute environment.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.batch#UpdateJobQueue": { @@ -7085,7 +6434,8 @@ } }, "traits": { - "smithy.api#documentation": "Contains the parameters for UpdateJobQueue.
Contains the parameters for UpdateJobQueue.
The Amazon Resource Name (ARN) of the job queue.
" } } + }, + "traits": { + "smithy.api#output": {} } }, "com.amazonaws.batch#UpdatePolicy": { @@ -7111,19 +6464,19 @@ "terminateJobsOnUpdate": { "target": "com.amazonaws.batch#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The\n default value is false.
Specifies whether jobs are automatically terminated when the computer environment\n infrastructure is updated. The default value is false.
Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value\n is 30.
" + "smithy.api#documentation": "Specifies the job timeout (in minutes) when the compute environment infrastructure is\n updated. The default value is 30.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the infrastructure update policy for the compute environment. For more information about\n infrastructure updates, see Updating\n compute environments in the Batch User Guide.
" + "smithy.api#documentation": "Specifies the infrastructure update policy for the compute environment. For more information\n about infrastructure updates, see Updating compute environments in the\n Batch User Guide.
" } }, "com.amazonaws.batch#UpdateSchedulingPolicy": { @@ -7169,12 +6522,16 @@ } }, "traits": { - "smithy.api#documentation": "Contains the parameters for UpdateSchedulingPolicy.
Contains the parameters for UpdateSchedulingPolicy.
The contents of the host parameter determine whether your data volume persists on the host\n container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path\n for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it\n stop running.
This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be\n provided.
\nThe contents of the host parameter determine whether your data volume persists\n on the host container instance and where it's stored. If the host parameter is empty, then the\n Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to\n persist after the containers that are associated with it stop running.
This parameter isn't applicable to jobs that are running on Fargate resources and\n shouldn't be provided.
\nThe name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters,\n numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume\n parameter of container definition mountPoints.
The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters,\n numbers, hyphens (-), and underscores (_). This name is referenced in the\n sourceVolume parameter of container definition mountPoints.
This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on\n Fargate resources must specify a platformVersion of at least 1.4.0.
This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs\n that are running on Fargate resources must specify a platformVersion of at least\n 1.4.0.