Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute
- * environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.
- * UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the compute resources - * within the environment. This is based on the compute resource specification that you define or the launch template that you - * specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot - * Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can - * optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a - * specified percentage of the On-Demand price.
+ *Creates an Batch compute environment. You can create MANAGED or
+ * UNMANAGED compute environments. MANAGED compute environments can
+ * use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use
+ * EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the + * compute resources within the environment. This is based on the compute resource specification + * that you define or the launch template that you + * specify when you create the compute environment. Either, you can choose to use EC2 On-Demand + * Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in + * your managed compute environment. You can optionally set a maximum price so that Spot + * Instances only launch when the Spot Instance price is less than a specified percentage of the + * On-Demand price.
*Multi-node parallel jobs aren't supported on Spot Instances.
*In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how - * you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of - * your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the - * Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch - * your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the - * Amazon Elastic Container Service Developer Guide.
+ *In an unmanaged compute environment, you can manage your own EC2 compute resources and + * have flexibility with how you configure your compute resources. For example, you can use + * custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance + * AMI specification. For more information, see container instance AMIs in the + * Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, + * you can use the DescribeComputeEnvironments operation to find the Amazon ECS + * cluster that's associated with it. Then, launch your container instances into that Amazon ECS + * cluster. For more information, see Launching an Amazon ECS container + * instance in the Amazon Elastic Container Service Developer Guide.
*To create a compute environment that uses EKS resources, the caller must have permissions to call
- * eks:DescribeCluster.
To create a compute environment that uses EKS resources, the caller must have
+ * permissions to call eks:DescribeCluster.
Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it - * also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is - * available. You're responsible for the management of the guest operating system. This includes any updates and - * security patches. You're also responsible for any additional application software or utilities that you install on - * the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete - * these steps:
+ *Batch doesn't automatically upgrade the AMIs in a compute environment after it's + * created. For example, it also doesn't update the AMIs in your compute environment when a + * newer version of the Amazon ECS optimized AMI is available. You're responsible for the management + * of the guest operating system. This includes any updates and security patches. You're also + * responsible for any additional application software or utilities that you install on the + * compute resources. There are two ways to use a new AMI for your Batch jobs. The original + * method is to complete these steps:
*Create a new compute environment with the new AMI.
@@ -71,17 +78,19 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi *Delete the earlier compute environment.
*In April 2022, Batch added enhanced support for updating compute environments. For more information, see - * Updating compute - * environments. To use the enhanced updating of compute environments to update AMIs, follow these - * rules:
+ *In April 2022, Batch added enhanced support for updating compute environments. For + * more information, see Updating compute environments. + * To use the enhanced updating of compute environments to update AMIs, follow these + * rules:
*Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.
Either don't set the service role (serviceRole) parameter or set it to
+ * the AWSBatchServiceRole service-linked role.
Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE,
- * SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.
Set the allocation strategy (allocationStrategy) parameter to
+ * BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, or
+ * SPOT_PRICE_CAPACITY_OPTIMIZED.
Set the update to latest image version (updateToLatestImageVersion)
@@ -92,24 +101,29 @@ export interface CreateComputeEnvironmentCommandOutput extends CreateComputeEnvi
* environment.
Don't specify an AMI ID in Don't specify an AMI ID in imageId, imageIdOverride (in
+ * imageId, imageIdOverride (in
+ *
* ec2Configuration
- * ), or in the launch
- * template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's
- * supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID
- * in the imageId or imageIdOverride parameters, or the launch template identified by the
- * LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the
- * AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the
- * imageId or imageIdOverride parameters. It can only be replaced by specifying a different
- * launch template, or if the launch template version is set to $Default or $Latest, by
- * setting either a new default version for the launch template (if $Default) or by adding a new version
- * to the launch template (if $Latest).launchTemplate). In that case, Batch selects the latest Amazon ECS
+ * optimized AMI that's supported by Batch at the time the infrastructure update is
+ * initiated. Alternatively, you can specify the AMI ID in the imageId or
+ * imageIdOverride parameters, or the launch template identified by the
+ * LaunchTemplate properties. Changing any of these properties starts an
+ * infrastructure update. If the AMI ID is specified in the launch template, it can't be
+ * replaced by specifying an AMI ID in either the imageId or
+ * imageIdOverride parameters. It can only be replaced by specifying a
+ * different launch template, or if the launch template version is set to
+ * $Default or $Latest, by setting either a new default version
+ * for the launch template (if $Default) or by adding a new version to the
+ * launch template (if $Latest).
If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be
- * re-selected. If the version setting in the launch template (launchTemplate) is set to
- * $Latest or $Default, the latest or default version of the launch template is evaluated up
- * at the time of the infrastructure update, even if the launchTemplate wasn't updated.
If these rules are followed, any update that starts an infrastructure update causes the
+ * AMI ID to be re-selected. If the version setting in the launch template
+ * (launchTemplate) is set to $Latest or $Default, the
+ * latest or default version of the launch template is evaluated up at the time of the
+ * infrastructure update, even if the launchTemplate wasn't updated.
Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the - * queue and assign an order of preference for the compute environments.
- *You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto - * its associated compute environments. For example, if a compute environment is associated with more than one job - * queue, the job queue with a higher priority is given preference for scheduling jobs to that compute - * environment.
+ *Creates an Batch job queue. When you create a job queue, you associate one or more + * compute environments to the queue and assign an order of preference for the compute + * environments.
+ *You also set a priority to the job queue that determines the order that the Batch + * scheduler places jobs onto its associated compute environments. For example, if a compute + * environment is associated with more than one job queue, the job queue with a higher priority + * is given preference for scheduling jobs to that compute environment.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-batch/src/commands/DeleteComputeEnvironmentCommand.ts b/clients/client-batch/src/commands/DeleteComputeEnvironmentCommand.ts index 40d98eb7c40a..68f047cb3b3a 100644 --- a/clients/client-batch/src/commands/DeleteComputeEnvironmentCommand.ts +++ b/clients/client-batch/src/commands/DeleteComputeEnvironmentCommand.ts @@ -29,9 +29,12 @@ export interface DeleteComputeEnvironmentCommandOutput extends DeleteComputeEnvi /** * @public *Deletes an Batch compute environment.
- *Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all
- * active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute
- * environment enters an invalid state.
Before you can delete a compute environment, you must set its state to
+ * DISABLED with the UpdateComputeEnvironment API operation and
+ * disassociate it from any job queues with the UpdateJobQueue API operation.
+ * Compute environments that use Fargate resources must terminate all active jobs on that
+ * compute environment before deleting the compute environment. If this isn't done, the compute
+ * environment enters an invalid state.
Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. - * The jobs are terminated at a rate of about 16 jobs each second.
+ *Deletes the specified job queue. You must first disable submissions for a queue with the + * UpdateJobQueue operation. All jobs in the queue are eventually terminated + * when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each + * second.
*It's not necessary to disassociate compute environments from a queue before submitting a
- * DeleteJobQueue request.
DeleteJobQueue request.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
diff --git a/clients/client-batch/src/commands/DeregisterJobDefinitionCommand.ts b/clients/client-batch/src/commands/DeregisterJobDefinitionCommand.ts
index 1c875c50b0c3..406eb6a8c20f 100644
--- a/clients/client-batch/src/commands/DeregisterJobDefinitionCommand.ts
+++ b/clients/client-batch/src/commands/DeregisterJobDefinitionCommand.ts
@@ -28,7 +28,8 @@ export interface DeregisterJobDefinitionCommandOutput extends DeregisterJobDefin
/**
* @public
- * Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
+ *Deregisters an Batch job definition. Job definitions are permanently deleted after 180 + * days.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-batch/src/commands/DescribeComputeEnvironmentsCommand.ts b/clients/client-batch/src/commands/DescribeComputeEnvironmentsCommand.ts index ea1429966fc3..914754dac123 100644 --- a/clients/client-batch/src/commands/DescribeComputeEnvironmentsCommand.ts +++ b/clients/client-batch/src/commands/DescribeComputeEnvironmentsCommand.ts @@ -34,9 +34,9 @@ export interface DescribeComputeEnvironmentsCommandOutput /** * @public *Describes one or more of your compute environments.
- *If you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment
- * operation to determine the ecsClusterArn that you launch your Amazon ECS container instances
- * into.
If you're using an unmanaged compute environment, you can use the
+ * DescribeComputeEnvironment operation to determine the
+ * ecsClusterArn that you launch your Amazon ECS container instances into.
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only
- * return job definitions that match that status.
Describes a list of job definitions. You can specify a status (such as
+ * ACTIVE) to only return job definitions that match that status.
An array job ID to return a list of the children for that job
* * - *You can filter the results by job status with the jobStatus parameter. If you don't specify a
- * status, only RUNNING jobs are returned.
You can filter the results by job status with the jobStatus parameter. If you
+ * don't specify a status, only RUNNING jobs are returned.
Submits an Batch job from a job definition. Parameters that are specified during SubmitJob
- * override parameters defined in the job definition. vCPU and memory requirements that are specified in the
- * resourceRequirements objects in the job definition are the exception. They can't be overridden this way
- * using the memory and vcpus parameters. Rather, you must specify updates to job definition
- * parameters in a resourceRequirements object that's included in the containerOverrides
- * parameter.
Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory
+ * requirements that are specified in the resourceRequirements objects in the job
+ * definition are the exception. They can't be overridden this way using the memory
+ * and vcpus parameters. Rather, you must specify updates to job definition
+ * parameters in a resourceRequirements object that's included in the
+ * containerOverrides parameter.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
+ *Job queues with a scheduling policy are limited to 500 active fair share identifiers at + * a time.
*Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 - * days, Fargate resources might become unavailable and job might be terminated.
+ *Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. + * This is because, after 14 days, Fargate resources might become unavailable and job might be + * terminated.
*Associates the specified tags to a resource with the specified resourceArn. If existing tags on a
- * resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that
- * are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
+ *
Associates the specified tags to a resource with the specified resourceArn.
+ * If existing tags on a resource aren't specified in the request parameters, they aren't
+ * changed. When a resource is deleted, the tags that are associated with that resource are
+ * deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues,
* and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are
- * terminated, which causes them to transition to FAILED. Jobs that have not progressed to the
- * STARTING state are cancelled.
Terminates a job in a job queue. Jobs that are in the STARTING or
+ * RUNNING state are terminated, which causes them to transition to
+ * FAILED. Jobs that have not progressed to the STARTING state are
+ * cancelled.
A message to attach to the job that explains the reason for canceling it. This message is returned by future - * DescribeJobs operations on the job. This message is also recorded in the Batch activity - * logs.
+ *A message to attach to the job that explains the reason for canceling it. This message is + * returned by future DescribeJobs operations on the job. This message is also + * recorded in the Batch activity logs.
*/ reason: string | undefined; } @@ -416,7 +416,7 @@ export interface LaunchTemplateSpecification { * 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
+ * $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
@@ -500,18 +500,18 @@ export interface ComputeResource {
*
* The price and capacity optimized allocation strategy looks at both price and capacity to + *
The price and capacity optimized allocation strategy looks at both price and capacity to * select the Spot Instance pools that are the least likely to be interrupted and have the lowest * possible price. This allocation strategy is only available for Spot Instance compute * resources.
*With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and
- * SPOT_PRICE_CAPACITY_OPTIMIZED
+ * SPOT_PRICE_CAPACITY_OPTIMIZED
* (recommended) 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.
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.
*/
allocationStrategy?: CRAllocationStrategy;
@@ -536,11 +536,11 @@ export interface ComputeResource {
* support.
* With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and
- * SPOT_PRICE_CAPACITY_OPTIMIZED
+ * SPOT_PRICE_CAPACITY_OPTIMIZED
* (recommended) 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.
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 Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This parameter is required
- * for Amazon EC2 instances types. 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. This
+ * parameter is required for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN)
+ * of an instance profile. For example, Key-value pair tags to be applied to EC2 resources that are launched in the compute
+ * Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute
* environment. For Batch, these take the form of This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it. 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
+ * 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 Provides information that's used to select Amazon Machine Images (AMIs) for Amazon EC2 instances
+ * in the compute environment. If One or two values can be provided. The type of the compute environment: The type of the compute environment: The maximum number of vCPUs for an unmanaged 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. The maximum number of vCPUs for an unmanaged 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. This parameter is only supported when the This parameter is only supported when the Details about the compute resources managed by the compute environment. This parameter is required for managed
- * compute environments. For more information, see Compute Environments in the Batch User Guide. Details about the compute resources managed by the compute environment. This parameter is
+ * required for managed compute environments. For more information, see Compute Environments
+ * in the Batch User Guide. The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For
- * more information, see Batch service IAM
- * role in the Batch User Guide. The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services
+ * services on your behalf. For more information, see Batch service IAM role in the
+ * Batch User Guide. If your account already created the Batch service-linked role, that role is used by default for your compute
- * environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your
- * account, and no role is specified here, the service attempts to create the Batch service-linked role in your
- * account. If your account already created the Batch service-linked role, that role is used by
+ * default for your compute environment unless you specify a different role here. If the
+ * Batch service-linked role doesn't exist in your account, and no role is specified here,
+ * the service attempts to create the Batch service-linked role in your account. If your specified role has a path other than If your specified role has a path other than Depending on how you created your Batch service role, its ARN might contain the Depending on how you created your Batch service role, its ARN might contain the
+ * The tags that you apply to the compute environment to help you 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. These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't
- * propagate to the underlying compute resources. The tags that you apply to the compute environment to help you 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. These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute
+ * resources.
+ *
* ecsInstanceRole
* or
* arn:aws:iam::"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
+ * Batch User Guide. These tags aren't seen when using the Batch
* ListTagsForResource API operation.Ec2Configuration isn't specified, the default is
+ * Ec2Configuration isn't specified, the default is
* ECS_AL2.MANAGED or UNMANAGED. For more information, see
- * Compute Environments in the
- * Batch User Guide.MANAGED or UNMANAGED. For
+ * more information, see Compute Environments in the Batch User Guide.type parameter is set to UNMANAGED.type parameter is set to
+ * UNMANAGED./, then you must specify either the full role ARN
- * (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path
- * of /foo/, specify /foo/bar as the role name. For more information, see Friendly names
- * and paths in the IAM User Guide./, then you must specify either
+ * the full role ARN (recommended) or prefix the role name with the path. For example, if a
+ * role with the name bar has a path of /foo/, specify
+ * /foo/bar as the role name. For more information, see Friendly
+ * names and paths in the IAM User Guide.service-role
- * path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
- * service-role path prefix. Because of this, we recommend that you specify the full ARN of your service
- * role when you create compute environments.service-role path prefix. When you only specify the name of the service role,
+ * Batch assumes that your ARN doesn't use the service-role path prefix. Because
+ * of this, we recommend that you specify the full ARN of your service role when you create
+ * compute environments.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.FARGATE_SPOT); Amazon 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 @@ -974,62 +978,66 @@ export type JQState = (typeof JQState)[keyof typeof JQState]; export interface CreateJobQueueRequest { /** * @public - *
The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, - * numbers, hyphens (-), and underscores (_).
+ *The name of the job queue. It can be up to 128 letters long. It can contain uppercase and + * lowercase letters, numbers, hyphens (-), and underscores (_).
*/ jobQueueName: string | undefined; /** * @public - *The state of the job queue. If the job queue state is ENABLED, it is able to 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 state of the job queue. If the job queue state is ENABLED, it is able to
+ * 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 fair share scheduling policy. If this parameter is specified, the job queue uses a fair
- * share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO)
- * scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy.
- * The format is
- * The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job
+ * queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue
+ * uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can
+ * replace but can't remove the fair share scheduling policy. The format is
+ * aws:Partition:batch:Region:Account:scheduling-policy/Name
+ * aws:Partition:batch:Region:Account:scheduling-policy/Name
* .
- * An example is
- * aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
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 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 set of compute environments mapped to a job queue and their order relative to each other. The job scheduler
- * uses this parameter to determine which compute environment runs a specific job. Compute environments must be in
- * the VALID state before you can associate them with a job queue. You can associate up to three compute
- * environments 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 set of compute environments mapped to a job queue and their order relative to each
+ * other. The job scheduler uses this parameter to determine which compute environment runs a
+ * specific job. Compute environments must be in the VALID state before you can
+ * associate them with a job queue. You can associate up to three compute environments 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 tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists - * of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.
+ *The tags that you apply to the job queue to help you categorize and organize your + * resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources + * in Batch User Guide.
*/ tags?: RecordThe name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase - * letters, numbers, hyphens (-), and underscores (_).
+ *The name of the scheduling policy. It can be up to 128 letters long. It can contain + * uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
*/ name: string | undefined; @@ -1145,9 +1153,9 @@ export interface CreateSchedulingPolicyRequest { /** * @public - *The tags that you apply to the scheduling policy to help you 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 help you 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.
*These tags can be updated or removed using the TagResource and UntagResource API operations.
*/ tags?: RecordThe 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.
*/
arn: string | undefined;
}
@@ -1231,7 +1239,8 @@ export interface DeleteSchedulingPolicyResponse {}
export interface DeregisterJobDefinitionRequest {
/**
* @public
- * The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.
The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition
+ * to deregister.
The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.
- * When this parameter is used, DescribeComputeEnvironments only returns maxResults results in
- * a single page along with a nextToken response element. The remaining results of the initial request can
- * be seen by sending another DescribeComputeEnvironments request with the returned nextToken
- * value. This value can be between 1 and 100. If this parameter isn't used, then
- * DescribeComputeEnvironments returns up to 100 results and a nextToken
- * value if applicable.
The maximum number of cluster results returned by DescribeComputeEnvironments
+ * in paginated output. When this parameter is used, DescribeComputeEnvironments
+ * only returns maxResults results in a single page along with a
+ * nextToken response element. The remaining results of the initial request can be
+ * seen by sending another DescribeComputeEnvironments request with the returned
+ * nextToken value. This value can be between 1 and
+ * 100. If this parameter isn't used, then DescribeComputeEnvironments
+ * returns up to 100 results and a nextToken value if
+ * applicable.
The nextToken value returned from a previous paginated DescribeComputeEnvironments
- * request where maxResults was used and the results exceeded the value of that parameter. Pagination
- * continues from the end of the previous results that returned the nextToken value. This value is
- * null when there are no more results to return.
The nextToken value returned from a previous paginated
+ * DescribeComputeEnvironments request where maxResults was used and
+ * the results exceeded the value of that parameter. Pagination continues from the end of the
+ * previous results that returned the nextToken value. This value is
+ * null when there are no more results to return.
Treat this token as an opaque identifier that's only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -1424,8 +1436,8 @@ export interface ComputeEnvironmentDetail { /** * @public *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.
+ * 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; @@ -1470,10 +1482,11 @@ export interface DescribeComputeEnvironmentsResponse { /** * @public - *The nextToken value to include in a future DescribeComputeEnvironments request. When
- * the results of a DescribeComputeEnvironments request exceed maxResults, this value can be
- * used to retrieve the next page of results. This value is null when there are no more results to
- * return.
The nextToken value to include in a future
+ * DescribeComputeEnvironments request. When the results of a
+ * DescribeComputeEnvironments request exceed maxResults, this value
+ * can be used to retrieve the next page of results. This value is null when there
+ * are no more results to return.
A list of up to 100 job definitions. Each entry in the list can either be an ARN in the
* format
* arn:aws:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}
- * or a short version using the form $\{JobDefinitionName\}:$\{Revision\}. This parameter can't be used with other parameters.
$\{JobDefinitionName\}:$\{Revision\}. This
+ * parameter can't be used with other parameters.
*/
jobDefinitions?: string[];
/**
* @public
- * The maximum number of results returned by DescribeJobDefinitions in paginated output. When this
- * parameter is used, DescribeJobDefinitions only returns maxResults results in a single page
- * and a nextToken response element. The remaining results of the initial request can be seen by sending
- * another DescribeJobDefinitions request with the returned nextToken value. This value can be
- * between 1 and 100. If this parameter isn't used, then
- * DescribeJobDefinitions returns up to 100 results and a nextToken value
- * if applicable.
The maximum number of results returned by DescribeJobDefinitions in paginated
+ * output. When this parameter is used, DescribeJobDefinitions only returns
+ * maxResults results in a single page and a nextToken response
+ * element. The remaining results of the initial request can be seen by sending another
+ * DescribeJobDefinitions request with the returned nextToken value.
+ * This value can be between 1 and 100. If this parameter isn't
+ * used, then DescribeJobDefinitions returns up to 100 results and
+ * a nextToken value if applicable.
The nextToken value returned from a previous paginated DescribeJobDefinitions request
- * where maxResults was used and the results exceeded the value of that parameter. Pagination continues
- * from the end of the previous results that returned the nextToken value. This value is null
- * when there are no more results to return.
The nextToken value returned from a previous paginated
+ * DescribeJobDefinitions request where maxResults was used and the
+ * results exceeded the value of that parameter. Pagination continues from the end of the
+ * previous results that returned the nextToken value. This value is
+ * null when there are no more results to return.
Treat this token as an opaque identifier that's only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -1568,7 +1584,7 @@ export interface EphemeralStorage { /** * @public *The platform configuration for jobs that are running on Fargate resources. Jobs that run - * on EC2 resources must not specify this parameter.
+ * on Amazon EC2 resources must not specify this parameter. */ export interface FargatePlatformConfiguration { /** @@ -1931,7 +1947,8 @@ export interface LogConfiguration { /** * @public *Details for a Docker volume mount point that's used in a job's container properties. This
- * parameter maps to Volumes in the Create a container section of the Docker Remote API and the
+ * parameter maps to Volumes in the Create a
+ * container section of the Docker Remote API and the
* --volume option to docker run.
The network configuration for jobs that are running on Fargate resources. Jobs that are - * running on EC2 resources must not specify this parameter.
+ * running on Amazon EC2 resources must not specify this parameter. */ export interface NetworkConfiguration { /** @@ -1979,7 +1996,8 @@ export interface NetworkConfiguration { export interface RepositoryCredentials { /** * @public - *The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
+ *The Amazon Resource Name (ARN) of the secret containing the private repository + * credentials.
*/ credentialsParameter: string | undefined; } @@ -2022,7 +2040,7 @@ export interface ResourceRequirement { *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
+ * jobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory
* specified, the container is terminated. This parameter maps to Memory in the
* Create a container section of the Docker Remote API and the
* --memory option to docker run. You
@@ -2116,7 +2134,7 @@ export interface ResourceRequirement {
*
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
+ * For Amazon 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 @@ -2180,52 +2198,50 @@ export interface ResourceRequirement { /** * @public - *
- * An object that represents the compute environment architecture for Batch jobs on Fargate. - *
+ *An object that represents the compute environment architecture for Batch jobs on + * Fargate.
*/ export interface RuntimePlatform { /** * @public *The operating system for the compute environment.
* Valid values are:
- * LINUX (default), WINDOWS_SERVER_2019_CORE,
- * WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and
- * WINDOWS_SERVER_2022_FULL.
LINUX (default), WINDOWS_SERVER_2019_CORE,
+ * WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and
+ * WINDOWS_SERVER_2022_FULL.
* The following parameters can’t be set for Windows containers: linuxParameters,
- * privileged, user, ulimits,
- * readonlyRootFilesystem,
- * and efsVolumeConfiguration.
privileged, user, ulimits,
+ * readonlyRootFilesystem,
+ * and efsVolumeConfiguration.
* The Batch Scheduler checks
- * the compute environments
- * that are attached to the job queue before registering a task definition with
- * Fargate. In this
- * scenario, the job queue is where the job is submitted. If the job requires a
- * Windows container and the first compute environment is LINUX, the compute
- * environment is skipped and the next compute environment is checked until a Windows-based compute
- * environment is found.
LINUX, the compute
+ * environment is skipped and the next compute environment is checked until a Windows-based compute
+ * environment is found.
* Fargate Spot is not supported for
- * ARM64 and
- * Windows-based containers on Fargate. A job queue will be blocked if a
- * Fargate
- * ARM64 or
- * Windows job is submitted to a job queue with only Fargate Spot compute environments.
- * However, you can attach both FARGATE and
- * FARGATE_SPOT compute environments to the same job queue.
ARM64 and
+ * Windows-based containers on Fargate. A job queue will be blocked if a
+ * Fargate
+ * ARM64 or
+ * Windows job is submitted to a job queue with only Fargate Spot compute environments.
+ * However, you can attach both FARGATE and
+ * FARGATE_SPOT compute environments to the same job queue.
*
- * The vCPU architecture. The default value is X86_64. Valid values are
- * X86_64 and ARM64.
The vCPU architecture. The default value is X86_64. Valid values are
+ * X86_64 and ARM64.
This parameter must be set to
* X86_64
@@ -2244,8 +2260,7 @@ export interface RuntimePlatform {
/**
* @public
- *
The ulimit settings to pass to the container. For more information, see
- * Ulimit.
The ulimit settings to pass to the container. For more information, see Ulimit.
This object isn't applicable to jobs that are running on Fargate resources.
*The type of the ulimit. Valid values are: core | cpu |
- * data | fsize | locks | memlock | msgqueue |
- * nice | nofile | nproc | rss | rtprio |
- * rttime | sigpending | stack.
The type of the ulimit. Valid values are: core |
+ * cpu | data | fsize | locks |
+ * memlock | msgqueue | nice | nofile |
+ * nproc | rss | rtprio | rttime |
+ * sigpending | stack.
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
@@ -2515,10 +2532,10 @@ export interface ContainerProperties {
*
*
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.
Batch currently supports a subset of the logging drivers available to the Docker daemon - * (shown in the LogConfiguration data type).
+ * (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 @@ -2685,14 +2702,14 @@ export interface ContainerProperties { /** * @public *
The network configuration for jobs that are running on Fargate resources. Jobs that are - * running on EC2 resources must not specify this parameter.
+ * running on Amazon EC2 resources must not specify this parameter. */ networkConfiguration?: NetworkConfiguration; /** * @public *The platform configuration for jobs that are running on Fargate resources. Jobs that are - * running on EC2 resources must not specify this parameter.
+ * running on Amazon EC2 resources must not specify this parameter. */ fargatePlatformConfiguration?: FargatePlatformConfiguration; @@ -2706,7 +2723,8 @@ export interface ContainerProperties { /** * @public - *An object that represents the compute environment architecture for Batch jobs on Fargate.
+ *An object that represents the compute environment architecture for Batch jobs on + * Fargate.
*/ runtimePlatform?: RuntimePlatform; @@ -2719,1104 +2737,1955 @@ export interface ContainerProperties { /** * @public - *An environment variable.
+ *A list of containers that this task depends on.
*/ -export interface EksContainerEnvironmentVariable { +export interface TaskContainerDependency { /** * @public - *The name of the environment variable.
+ *A unique identifier for the container.
*/ - name: string | undefined; + containerName?: string; /** * @public - *The value of the environment variable.
+ *The dependency condition of the container. The following are the available conditions and + * their behavior:
+ *
+ * START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
+ * COMPLETE - This condition validates that a dependent container runs to
+ * completion (exits) before permitting other containers to start. This can be useful for
+ * nonessential containers that run a script and then exit. This condition can't be set on an
+ * essential container.
+ * SUCCESS - This condition is the same as COMPLETE, but it also
+ * requires that the container exits with a zero status. This condition can't be set on an
+ * essential container.
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.
Container properties are used for Amazon ECS-based job definitions. These properties to describe + * the container that's launched as part of a job.
*/ -export interface EksContainerResourceRequirements { +export interface TaskContainerProperties { /** * @public - *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.
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 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 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 Dockerfile reference:
+ * CMD.
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.
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 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.
A list of containers that this container depends on.
*/ - requests?: RecordThe 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 { /** * @public - *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.
The environment variables to pass to a container. This parameter maps to Env inthe Create a container
+ * section of the Docker Remote API
+ * and the --env parameter to docker run.
We don't recommend using plaintext environment variables for sensitive information, such as + * credential data.
+ *Environment variables cannot start with AWS_BATCH. This naming convention is
+ * reserved for variables that Batch sets.
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.
If the essential parameter of a container is marked as true, and that container
+ * fails or stops for any reason, all other containers that are part of the task are stopped. If the
+ * essential parameter of a container is marked as false, its failure doesn't affect
+ * the rest of the containers in a task. If this parameter is omitted, a container is assumed to be
+ * essential.
All tasks must have at least one essential container. If you have an application that's + * composed of multiple containers, group containers that are used for a common purpose into + * components, and separate the different components into multiple task definitions. For more + * information, see Application + * Architecture in the Amazon Elastic Container Service Developer Guide.
*/ - runAsGroup?: number; + essential?: boolean; /** * @public - *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.
The image used to start a container. This string is passed directly to the Docker daemon. By
+ * default, images in the Docker Hub registry are available. Other repositories are specified with
+ * either repository-url/image:tag or repository-url/image@digest. Up to
+ * 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward
+ * slashes, and number signs are allowed. This parameter maps to Image in the Create a
+ * container section of the Docker
+ * Remote API and the IMAGE parameter of the
+ * docker
+ * run
+ * .
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.
Linux-specific modifications that are applied to the container, such as Linux kernel + * capabilities. For more information, see KernelCapabilities.
*/ - readOnlyRootFilesystem?: boolean; + linuxParameters?: LinuxParameters; /** * @public - *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 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 can 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 about the options for + * different supported log drivers, see Configure logging drivers + * in the Docker documentation.
+ *Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon
+ * (shown in the LogConfiguration data type). Additional log drivers may 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 --format
+ * '\{\{.Server.APIVersion\}\}'
+ *
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 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 { /** * @public - *The name the volume mount. This must match the name of one of the volumes in the - * pod.
+ *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.
Windows containers can mount whole directories on the same drive as
+ * $env:ProgramData. Windows containers can't mount directories on a different drive,
+ * and mount point can't be across drives.
The name of a container. The name can be used as a unique identifier to target your dependsOn and Overrides objects.
The path on the container where the volume is mounted.
+ *When this parameter is true, the container is given elevated privileges 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.
This parameter is not supported for Windows containers or tasks run on Fargate.
+ *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.
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.
This parameter is not supported for Windows containers.
+ *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 { /** * @public - *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 private repository authentication credentials to use.
*/ - name?: string; + repositoryCredentials?: RepositoryCredentials; /** * @public - *The Docker image used to start the container.
+ *The type and amount of a resource to assign to a container. The only supported resource is a + * GPU.
*/ - image: string | undefined; + resourceRequirements?: ResourceRequirement[]; /** * @public - *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 secrets to pass to the container. For more information, see Specifying Sensitive + * Data in the Amazon Elastic Container Service Developer Guide.
*/ - imagePullPolicy?: string; + secrets?: Secret[]; /** * @public - *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.
A list of ulimits to set in the container. If a ulimit value is
+ * specified in a task definition, it overrides the default values set by Docker. This parameter
+ * maps to Ulimits in the Create a
+ * container section of the Docker
+ * Remote API and the --ulimit option to docker
+ * run.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating
+ * system with the exception of the nofile resource limit parameter which Fargate overrides. The
+ * nofile resource limit sets a restriction on the number of open files that a
+ * container can use. The default nofile soft limit is 1024 and the
+ * default hard limit is 65535.
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 --format
+ * '\{\{.Server.APIVersion\}\}'
+ *
This parameter is not supported for Windows containers.
+ *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
+ *
The user 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.
+ *When running tasks using the host network mode, don't run containers using the
+ * root user (UID 0). We recommend using a non-root user for better security.
You can specify the user using the following formats. If specifying a UID or
+ * GID, you must specify it as a positive integer.
+ * user
+ *
+ * user:group
+ *
+ * uid
+ *
+ * uid:gid
+ *
+ * user:gi
+ *
+ * uid:group
+ *
This parameter is not supported for Windows containers.
+ *The properties for a task definition that describes the container and volume definitions of + * an Amazon ECS task. You can specify which Docker images to use, the required resources, and other + * configurations related to launching the task definition through an Amazon ECS service or task.
+ */ +export interface EcsTaskProperties { + /** + * @public + *This object is a list of containers.
+ */ + containers: TaskContainerProperties[] | undefined; + + /** + * @public + *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; + + /** + * @public + *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; + + /** + * @public + *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 IPC resource namespace to use for the containers in the task. The valid values are
+ * host, task, or none.
If host is specified, all containers within the tasks that specified the
+ * host IPC mode on the same container instance share the same IPC resources with the
+ * host Amazon EC2 instance.
If task is specified, all containers within the specified task
+ * share the same IPC resources.
If none is specified, the IPC resources within the containers of a task are
+ * private, and are not shared with other containers in a task or on the container instance.
If no value is specified, then the IPC resource namespace sharing depends on the Docker + * daemon setting on the container instance. For more information, see IPC settings in + * the Docker run reference.
+ */ + ipcMode?: string; + + /** + * @public + *The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
+ *This is object is comparable to ContainerProperties:jobRoleArn.
+ *The process namespace to use for the containers in the task. The valid values are
+ * host or task. For example, monitoring sidecars might need
+ * pidMode to access information about other containers running in the same
+ * task.
If host is specified, all containers within the tasks that specified the
+ * host PID mode on the same container instance share the process namespace with the
+ * host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same
+ * process namespace.
If no value is specified, the default is a private namespace for each container. For more + * information, see PID settings in the Docker run reference.
+ */ + pidMode?: string; + + /** + * @public + *The network configuration for jobs that are running on Fargate resources. Jobs that are + * running on Amazon EC2 resources must not specify this parameter.
+ */ + networkConfiguration?: NetworkConfiguration; + + /** + * @public + *An object that represents the compute environment architecture for Batch jobs on + * Fargate.
+ */ + runtimePlatform?: RuntimePlatform; + + /** + * @public + *A list of volumes that are associated with the job.
+ */ + volumes?: Volume[]; +} + +/** + * @public + *An object that contains the properties for the Amazon ECS resources of a job.
+ */ +export interface EcsProperties { + /** + * @public + *An object that contains the properties for the Amazon ECS task definition of a job.
+ *This object is currently limited to one element.
+ *An environment variable.
+ */ +export interface EksContainerEnvironmentVariable { + /** + * @public + *The name of the environment variable.
+ */ + name: string | undefined; + + /** + * @public + *The value of the environment variable.
+ */ + value?: string; +} + +/** + * @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 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.
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 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 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.
+ *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.
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 { + /** + * @public + *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 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 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.
+ */ +export interface EksContainerVolumeMount { + /** + * @public + *The name the volume mount. This must match the name of one of the volumes in the + * pod.
+ */ + name?: string; + + /** + * @public + *The path on the container where the volume is mounted.
+ */ + mountPath?: string; + + /** + * @public + *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.
+ */ +export interface EksContainer { + /** + * @public + *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 Docker image used to start the container.
+ */ + image: string | undefined; + + /** + * @public + *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.
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
+ * VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD
+ * and Define a command and arguments for a pod in the Kubernetes
+ * documentation.
The environment variables to pass to a container.
+ *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. 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 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 + *Describes and uniquely identifies Kubernetes resources. For example, the compute environment that
+ * a pod runs in or the jobID for a job running in the pod. For more information, see
+ * Understanding Kubernetes Objects in the Kubernetes documentation.
Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63 + * uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be + * added or modified at any time. Each resource can have multiple labels, but each key must be + * unique for a given object.
+ */ + labels?: RecordSpecifies 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.
+ *+ * (Default) Use the disk 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.
The maximum size of the volume. By default, there's no maximum size defined.
+ */ + sizeLimit?: string; +} + +/** + * @public + *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.
The path of the file or directory on the host to mount into containers on the pod.
+ */ + path?: string; +} + +/** + * @public + *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.
+ */ + secretName: string | undefined; + + /** + * @public + *Specifies whether the secret or the secret's keys must be defined.
+ */ + optional?: boolean; +} + +/** + * @public + *Specifies an Amazon EKS volume for a job definition.
+ */ +export interface EksVolume { + /** + * @public + *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; + + /** + * @public + *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.
The environment variables to pass to a container.
+ *Specifies the configuration of a Kubernetes secret volume. For more information, see
+ * secret in the
+ * Kubernetes documentation.
The properties for the pod.
+ */ +export interface EksPodProperties { + /** + * @public + *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; + + /** + * @public + *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 properties of the container that's used on the Amazon EKS pod.
+ */ + containers?: EksContainer[]; + + /** + * @public + *These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init + * Containers in the Kubernetes documentation.
*Environment variables cannot start with "AWS_BATCH". This naming
- * convention is reserved for variables that Batch sets.
This object is limited to 10 elements
*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.
Specifies the volumes for a job definition that uses Amazon EKS resources.
*/ - resources?: EksContainerResourceRequirements; + volumes?: EksVolume[]; /** * @public - *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.
Metadata about the + * Kubernetes + * pod. For + * more information, see Understanding Kubernetes Objects in the Kubernetes + * documentation.
*/ - volumeMounts?: EksContainerVolumeMount[]; + metadata?: EksMetadata; /** * @public - *The security context for a job. For more information, see Configure a - * security context for a pod or container in the Kubernetes - * documentation.
+ *Indicates if the processes in a container are shared, or visible, to other containers in the + * same pod. For more information, see Share + * Process Namespace between Containers in a Pod.
+ */ + shareProcessNamespace?: boolean; +} + +/** + * @public + *An object that contains the properties for the Kubernetes resources of a job.
+ */ +export interface EksProperties { + /** + * @public + *The properties for the Kubernetes pod resources of a job.
+ */ + podProperties?: EksPodProperties; +} + +/** + * @public + *This is an object that represents the properties of the node range for a multi-node parallel + * job.
+ */ +export interface NodeRangeProperty { + /** + * @public + *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 container details for the node range.
+ */ + container?: ContainerProperties; + + /** + * @public + *The instance types of the underlying host infrastructure of a multi-node parallel job.
+ *This parameter isn't applicable to jobs that are running on Fargate resources.
+ *In addition, this list object is currently limited to one element.
+ *This is an object that represents the properties of the node range for a multi-node parallel + * job.
+ */ + ecsProperties?: EcsProperties; +} + +/** + * @public + *An object that represents the node properties of a multi-node parallel job.
+ *Node properties can't be specified for Amazon EKS based job definitions.
+ *The number of nodes that are associated with a multi-node parallel job.
+ */ + numNodes: number | undefined; + + /** + * @public + *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; + + /** + * @public + *A list of node ranges and their properties that are associated with a multi-node parallel + * job.
+ */ + nodeRangeProperties: NodeRangeProperty[] | undefined; +} + +/** + * @public + * @enum + */ +export const PlatformCapability = { + EC2: "EC2", + FARGATE: "FARGATE", +} as const; + +/** + * @public + */ +export type PlatformCapability = (typeof PlatformCapability)[keyof typeof PlatformCapability]; + +/** + * @public + * @enum + */ +export const RetryAction = { + EXIT: "EXIT", + RETRY: "RETRY", +} as const; + +/** + * @public + */ +export type RetryAction = (typeof RetryAction)[keyof typeof 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.
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 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; + + /** + * @public + *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.
+ */ +export interface RetryStrategy { + /** + * @public + *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.
Describes and uniquely identifies Kubernetes resources. For example, the compute environment
- * that a pod runs in or the jobID for a job running in the pod. For more information,
- * see Understanding Kubernetes Objects in the Kubernetes
- * documentation.
An object that represents a job timeout configuration.
*/ -export interface EksMetadata { +export interface JobTimeout { /** * @public - *Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63 - * uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be - * added or modified at any time. Each resource can have multiple labels, but each key must be - * unique for a given object.
+ *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.
*/ - labels?: RecordSpecifies 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.
An object that represents an Batch job definition.
*/ -export interface EksEmptyDir { +export interface JobDefinition { /** * @public - *The medium to store the volume. The default value is an empty string, which uses the storage - * of the node.
- *- * (Default) Use the disk 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.
The name of the job definition.
*/ - medium?: string; + jobDefinitionName: string | undefined; /** * @public - *The maximum size of the volume. By default, there's no maximum size defined.
+ *The Amazon Resource Name (ARN) for the job definition.
*/ - sizeLimit?: string; -} + jobDefinitionArn: string | undefined; -/** - * @public - *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.
The path of the file or directory on the host to mount into containers on the pod.
+ *The revision of the job definition.
*/ - path?: string; -} + revision: number | undefined; -/** - * @public - *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 status of the job definition.
*/ - secretName: string | undefined; + status?: string; /** * @public - *Specifies whether the secret or the secret's keys must be defined.
+ *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.
Specifies an Amazon EKS volume for a job definition.
- */ -export interface EksVolume { /** * @public - *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 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.
*/ - name: string | undefined; + schedulingPriority?: number; /** * @public - *Specifies the configuration of a Kubernetes hostPath volume. For more information,
- * see hostPath
- * in the Kubernetes documentation.
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.
Specifies the configuration of a Kubernetes emptyDir volume. For more information,
- * see emptyDir
- * in the Kubernetes documentation.
The retry strategy to use for failed jobs that are submitted with this job + * definition.
*/ - emptyDir?: EksEmptyDir; + retryStrategy?: RetryStrategy; /** * @public - *Specifies the configuration of a Kubernetes secret volume. For more information, see
- * secret in the
- * Kubernetes documentation.
An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or
+ * nodeProperties.
The properties for the pod.
- */ -export interface EksPodProperties { /** * @public - *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 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.
*/ - serviceAccountName?: string; + timeout?: JobTimeout; /** * @public - *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.
An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.
If the job runs on Fargate resources, don't specify nodeProperties. Use
+ * containerProperties instead.
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 tags that are applied to the job definition.
*/ - dnsPolicy?: string; + tags?: RecordThe properties of the container that's used on the Amazon EKS pod.
+ *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 the volumes for a job definition that uses Amazon EKS resources.
+ *The platform capabilities required by the job definition. If no value is specified, it
+ * defaults to EC2. Jobs run on Fargate resources specify
+ * FARGATE.
Metadata about the - * Kubernetes - * pod. For - * more information, see Understanding Kubernetes Objects in the Kubernetes - * documentation.
+ *An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties
+ * is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.
An object that contains the properties for the Kubernetes resources of a job.
- */ -export interface EksProperties { /** * @public - *The properties for the Kubernetes pod resources of a job.
+ *An object with properties that are specific to Amazon EKS-based jobs. When eksProperties
+ * is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.
The orchestration type of the compute environment. The valid values are ECS
+ * (default) or EKS.
An object that represents the properties of the node range for a multi-node parallel - * job.
*/ -export interface NodeRangeProperty { +export interface DescribeJobDefinitionsResponse { /** * @public - *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 list of job definitions.
*/ - targetNodes: string | undefined; + jobDefinitions?: JobDefinition[]; /** * @public - *The container details for the node range.
+ *The nextToken value to include in a future
+ * DescribeJobDefinitions request. When the results of a
+ * DescribeJobDefinitions request exceed maxResults, this value can
+ * be used to retrieve the next page of results. This value is null when there are
+ * no more results to return.
An object that represents the node properties of a multi-node parallel job.
- *Node properties can't be specified for Amazon EKS based job definitions.
- *Contains the parameters for DescribeJobQueues.
The number of nodes that are associated with a multi-node parallel job.
+ *A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
*/ - numNodes: number | undefined; + jobQueues?: string[]; /** * @public - *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.
+ *The maximum number of results returned by DescribeJobQueues in paginated
+ * output. When this parameter is used, DescribeJobQueues only returns
+ * maxResults results in a single page and a nextToken response
+ * element. The remaining results of the initial request can be seen by sending another
+ * DescribeJobQueues request with the returned nextToken value. This
+ * value can be between 1 and 100. If this parameter isn't used,
+ * then DescribeJobQueues returns up to 100 results and a
+ * nextToken value if applicable.
A list of node ranges and their properties that are associated with a multi-node parallel - * job.
+ *The nextToken value returned from a previous paginated
+ * DescribeJobQueues request where maxResults was used and the
+ * results exceeded the value of that parameter. Pagination continues from the end of the
+ * previous results that returned the nextToken value. This value is
+ * null when there are no more results to return.
Treat this token as an opaque identifier that's only used to + * retrieve the next items in a list and not for other programmatic purposes.
+ *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.
An object that represents the details for an Batch job queue.
*/ -export interface EvaluateOnExit { +export interface JobQueueDetail { /** * @public - *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.
The job queue name.
*/ - onStatusReason?: string; + jobQueueName: string | undefined; /** * @public - *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.
The Amazon Resource Name (ARN) of the job queue.
*/ - onReason?: string; + jobQueueArn: string | undefined; /** * @public - *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.
+ *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.
Specifies the action to take if all of the specified conditions
- * (onStatusReason, onReason, and onExitCode) are met. The
- * values aren't case sensitive.
The Amazon Resource Name (ARN) of the scheduling policy. The format is
+ * aws:Partition:batch:Region:Account:scheduling-policy/Name
+ * .
+ * For example,
+ * aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
The retry strategy that's associated with a job. For more information, see Automated job retries in the - * Batch User Guide.
- */ -export interface RetryStrategy { /** * @public - *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 status of the job queue (for example, CREATING or
+ * VALID).
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.
A short, human-readable string to provide additional details for the current status of the + * job queue.
*/ - evaluateOnExit?: EvaluateOnExit[]; -} + statusReason?: string; -/** - * @public - *An object that represents a job timeout configuration.
- */ -export interface JobTimeout { /** * @public - *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.
+ *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 Amazon EC2 (EC2
+ * or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon 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.
+ */ + computeEnvironmentOrder: ComputeEnvironmentOrder[] | undefined; + + /** + * @public + *The tags that are applied to the job queue. For more information, see Tagging your Batch resources in + * Batch User Guide.
+ */ + tags?: RecordAn object that represents an Batch job definition.
*/ -export interface JobDefinition { +export interface DescribeJobQueuesResponse { /** * @public - *The name of the job definition.
+ *The list of job queues.
*/ - jobDefinitionName: string | undefined; + jobQueues?: JobQueueDetail[]; /** * @public - *The Amazon Resource Name (ARN) for the job definition.
+ *The nextToken value to include in a future DescribeJobQueues
+ * request. When the results of a DescribeJobQueues request exceed
+ * maxResults, this value can be used to retrieve the next page of results. This
+ * value is null when there are no more results to return.
Contains the parameters for DescribeJobs.
The revision of the job definition.
+ *A list of up to 100 job IDs.
*/ - revision: number | undefined; + jobs: string[] | undefined; +} +/** + * @public + *An object that represents the details of a container that's part of a job.
+ */ +export interface ContainerDetail { /** * @public - *The status of the job definition.
+ *The image used to start the container.
*/ - status?: string; + image?: string; /** * @public - *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 number of vCPUs reserved for the container. For jobs that run on Amazon 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.
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.
+ *For jobs running on Amazon 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.
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 command that's passed to the container.
*/ - parameters?: RecordThe retry strategy to use for failed jobs that are submitted with this job - * definition.
+ *The Amazon Resource Name (ARN) that's associated with the job when run.
*/ - retryStrategy?: RetryStrategy; + jobRoleArn?: string; /** * @public - *An object with various properties specific to Amazon ECS based jobs. Valid values are
- * containerProperties, eksProperties, and nodeProperties.
- * Only one can be specified.
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.
*/ - containerProperties?: ContainerProperties; + executionRoleArn?: string; /** * @public - *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.
+ *A list of volumes that are associated with the job.
*/ - timeout?: JobTimeout; + volumes?: Volume[]; /** * @public - *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.
The environment variables to pass to a container.
*If the job runs on Fargate resources, don't specify nodeProperties. Use
- * containerProperties instead.
Environment variables cannot start with "AWS_BATCH". This naming
+ * convention is reserved for variables that Batch sets.
The tags that are applied to the job definition.
+ *The mount points for data volumes in your container.
*/ - 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.
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
+ * .
The platform capabilities required by the job definition. If no value is specified, it
- * defaults to EC2. Jobs run on Fargate resources specify
- * FARGATE.
A list of 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.
This parameter isn't applicable to jobs that are running on Fargate resources.
+ *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.
When this parameter is true, the container is given elevated permissions on the host
+ * container instance (similar 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 specified as false.
The orchestration type of the compute environment. The valid values are ECS
- * (default) or EKS.
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.
The list of job definitions.
+ *The exit code returned upon completion.
*/ - jobDefinitions?: JobDefinition[]; + exitCode?: number; /** * @public - *The nextToken value to include in a future DescribeJobDefinitions request. When the
- * results of a DescribeJobDefinitions request exceed maxResults, this value can be used to
- * retrieve the next page of results. This value is null when there are no more results to return.
A short (255 max characters) human-readable string to provide additional details for a + * running or stopped container.
*/ - nextToken?: string; -} + reason?: string; + + /** + * @public + *The Amazon Resource Name (ARN) of the container instance that the container is running on.
+ */ + containerInstanceArn?: string; -/** - * @public - *Contains the parameters for DescribeJobQueues.
A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.
+ *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 maximum number of results returned by DescribeJobQueues in paginated output. When this
- * parameter is used, DescribeJobQueues only returns maxResults results in a single page and a
- * nextToken response element. The remaining results of the initial request can be seen by sending another
- * DescribeJobQueues request with the returned nextToken value. This value can be between
- * 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up
- * to 100 results and a nextToken value if applicable.
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 nextToken value returned from a previous paginated DescribeJobQueues request where
- * maxResults was used and the results exceeded the value of that parameter. Pagination continues from the
- * end of the previous results that returned the nextToken value. This value is null when
- * there are no more results to return.
The instance type of the underlying host infrastructure of a multi-node parallel job.
*Treat this token as an opaque identifier that's only used to - * retrieve the next items in a list and not for other programmatic purposes.
+ *This parameter isn't applicable to jobs that are running on Fargate resources.
*The network interfaces that are associated with the job.
+ */ + networkInterfaces?: NetworkInterface[]; -/** - * @public - *An object that represents the details for an Batch job queue.
- */ -export interface JobQueueDetail { /** * @public - *The job queue name.
+ *The type and amount of resources to assign to a container. The supported resources include
+ * GPU, MEMORY, and VCPU.
The Amazon Resource Name (ARN) of the job queue.
+ *Linux-specific modifications that are applied to the container, such as details for device + * mappings.
*/ - jobQueueArn: string | undefined; + linuxParameters?: LinuxParameters; /** * @public - *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 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.
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 Resource Name (ARN) of the scheduling policy. The format is
- * aws:Partition:batch:Region:Account:scheduling-policy/Name
- * .
- * For example,
- * aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
The secrets to pass to the container. For more information, see Specifying sensitive data in the + * Batch User Guide.
*/ - schedulingPolicyArn?: string; + secrets?: Secret[]; /** * @public - *The status of the job queue (for example, CREATING or
- * VALID).
The network configuration for jobs that are running on Fargate resources. Jobs that are + * running on Amazon EC2 resources must not specify this parameter.
*/ - status?: JQStatus; + networkConfiguration?: NetworkConfiguration; /** * @public - *A short, human-readable string to provide additional details for the current status of the - * job queue.
+ *The platform configuration for jobs that are running on Fargate resources. Jobs that are + * running on Amazon EC2 resources must not specify this parameter.
*/ - statusReason?: string; + fargatePlatformConfiguration?: FargatePlatformConfiguration; /** * @public - *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 amount of ephemeral storage allocated 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.
*/ - priority: number | undefined; + ephemeralStorage?: EphemeralStorage; /** * @public - *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.
+ *An object that represents the compute environment architecture for Batch jobs on + * Fargate.
*/ - computeEnvironmentOrder: ComputeEnvironmentOrder[] | undefined; + runtimePlatform?: RuntimePlatform; /** * @public - *The tags that are applied to the job queue. For more information, see Tagging your Batch resources in - * Batch User Guide.
+ *The private repository authentication credentials to use.
*/ - tags?: RecordAn object that represents an Batch job dependency.
*/ -export interface DescribeJobQueuesResponse { +export interface JobDependency { /** * @public - *The list of job queues.
+ *The job ID of the Batch job that's associated with this dependency.
*/ - jobQueues?: JobQueueDetail[]; + jobId?: string; /** * @public - *The nextToken value to include in a future DescribeJobQueues request. When the results
- * of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the
- * next page of results. This value is null when there are no more results to return.
The type of the job dependency.
*/ - nextToken?: string; + type?: ArrayJobDependency; } /** * @public - *Contains the parameters for DescribeJobs.
The details for the container in this task attempt.
*/ -export interface DescribeJobsRequest { +export interface TaskContainerDetails { /** * @public - *A list of up to 100 job IDs.
+ *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.
An object that represents the details of a container that's part of a job.
- */ -export interface ContainerDetail { /** * @public - *The image used to start the container.
+ *A list of containers that this container depends on.
*/ - image?: string; + dependsOn?: TaskContainerDependency[]; /** * @public - *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.
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.
+ *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.
If the essential parameter of a container is marked as true, and that container
+ * fails or stops for any reason, all other containers that are part of the task are stopped. If the
+ * essential parameter of a container is marked as false, its failure doesn't affect
+ * the rest of the containers in a task. If this parameter is omitted, a container is assumed to be
+ * essential.
All tasks must have at least one essential container. If you have an application that's + * composed of multiple containers, group containers that are used for a common purpose into + * components, and separate the different components into multiple task definitions. For more + * information, see Application + * Architecture in the Amazon Elastic Container Service Developer Guide.
*/ - memory?: number; + essential?: boolean; /** * @public - *The command that's passed to the container.
+ *The image used to start a container. This string is passed directly to the Docker daemon. By
+ * default, images in the Docker Hub registry are available. Other repositories are specified with
+ * either repository-url/image:tag or repository-url/image@digest. Up to
+ * 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward
+ * slashes, and number signs are allowed. This parameter maps to Image in the Create a
+ * container section of the Docker
+ * Remote API and the IMAGE parameter of the
+ * docker
+ * run
+ * .
The Amazon Resource Name (ARN) that's associated with the job when run.
+ *Linux-specific modifications that are applied to the container, such as Linux kernel + * capabilities. For more information, see KernelCapabilities.
+ *This parameter is not supported for Windows containers.
+ *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.
+ *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 can 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 about the options for + * different supported log drivers, see Configure logging drivers + * in the Docker documentation.
+ *Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon
+ * (shown in the LogConfiguration data type). Additional log drivers may 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 --format
+ * '\{\{.Server.APIVersion\}\}'
+ *
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.
A list of volumes that are associated with the job.
+ *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.
Windows containers can mount whole directories on the same drive as
+ * $env:ProgramData. Windows containers can't mount directories on a different drive,
+ * and mount point can't be across drives.
The environment variables to pass to a container.
- *Environment variables cannot start with "AWS_BATCH". This naming
- * convention is reserved for variables that Batch sets.
The name of a container.
*/ - environment?: KeyValuePair[]; + name?: string; /** * @public - *The mount points for data volumes in your container.
+ *When this parameter is true, the container is given elevated privileges 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.
This parameter is not supported for Windows containers or tasks run on Fargate.
+ *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
- * .
ReadonlyRootfs in the Create a
+ * container section of the Docker
+ * Remote API and the --read-only option to docker
+ * run.
+ * This parameter is not supported for Windows containers.
+ *A list of 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.
This parameter isn't applicable to jobs that are running on Fargate resources.
- *The private repository authentication credentials to use.
*/ - ulimits?: Ulimit[]; + repositoryCredentials?: RepositoryCredentials; /** * @public - *When this parameter is true, the container is given elevated permissions on the host
- * container instance (similar to the root user). The default value is
- * false.
The type and amount of a resource to assign to a container. The only supported resource is a + * GPU.
+ */ + resourceRequirements?: ResourceRequirement[]; + + /** + * @public + *The secrets to pass to the container. For more information, see Specifying Sensitive + * Data in the Amazon Elastic Container Service Developer Guide.
+ */ + secrets?: Secret[]; + + /** + * @public + *A list of ulimits to set in the container. If a ulimit value is
+ * specified in a task definition, it overrides the default values set by Docker. This parameter
+ * maps to Ulimits in the Create a
+ * container section of the Docker
+ * Remote API and the --ulimit option to docker
+ * run.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating
+ * system with the exception of the nofile resource limit parameter which Fargate overrides. The
+ * nofile resource limit sets a restriction on the number of open files that a
+ * container can use. The default nofile soft limit is 1024 and the
+ * default hard limit is 65535.
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 --format
+ * '\{\{.Server.APIVersion\}\}'
+ *
This parameter isn't applicable to jobs that are running on Fargate resources and
- * shouldn't be provided, or specified as false.
This parameter is not supported for Windows containers.
*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.
The user 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.
+ *When running tasks using the host network mode, don't run containers using the
+ * root user (UID 0). We recommend using a non-root user for better security.
You can specify the user using the following formats. If specifying a UID or
+ * GID, you must specify it as a positive integer.
+ * user
+ *
+ * user:group
+ *
+ * uid
+ *
+ * uid:gid
+ *
+ * user:gi
+ *
+ * uid:group
+ *
+ *
+ *
This parameter is not supported for Windows containers.
+ *The exit code to return upon completion.
+ *The exit code returned upon completion.
*/ exitCode?: number; @@ -3829,143 +4698,118 @@ export interface ContainerDetail { /** * @public - *The Amazon Resource Name (ARN) of the container instance that the container is running on.
+ *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 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 network interfaces that are associated with the job.
*/ - taskArn?: string; + networkInterfaces?: NetworkInterface[]; +} +/** + * @public + *The details of a task definition that describes the container and volume definitions of an + * Amazon ECS task.
+ */ +export interface EcsTaskDetails { /** * @public - *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.
A list of containers that are included in the taskProperties
+ * list.
The instance type of the underlying host infrastructure of a multi-node parallel job.
- *This parameter isn't applicable to jobs that are running on Fargate resources.
- *The Amazon Resource Name (ARN) of the container instance that hosts the task.
*/ - instanceType?: string; + containerInstanceArn?: string; /** * @public - *The network interfaces that are associated with the job.
+ *The ARN of the Amazon ECS task.
*/ - networkInterfaces?: NetworkInterface[]; + taskArn?: string; /** * @public - *The type and amount of resources to assign to a container. The supported resources include
- * GPU, MEMORY, and VCPU.
The amount of ephemeral storage allocated for the task.
*/ - resourceRequirements?: ResourceRequirement[]; + ephemeralStorage?: EphemeralStorage; /** * @public - *Linux-specific modifications that are applied to the container, such as details for device - * mappings.
+ *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.
*/ - linuxParameters?: LinuxParameters; + executionRoleArn?: string; /** * @public - *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.
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 Fargate platform version where the jobs are running.
*/ - logConfiguration?: LogConfiguration; + platformVersion?: string; /** * @public - *The secrets to pass to the container. For more information, see Specifying sensitive data in the - * Batch User Guide.
+ *The IPC resource namespace to use for the containers in the task.
*/ - secrets?: Secret[]; + ipcMode?: string; /** * @public - *The network configuration for jobs that are running on Fargate resources. Jobs that are - * running on EC2 resources must not specify this parameter.
+ *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.
+ *This is object is comparable to ContainerProperties:jobRoleArn.
+ *The platform configuration for jobs that are running on Fargate resources. Jobs that are - * running on EC2 resources must not specify this parameter.
+ *The process namespace to use for the containers in the task.
*/ - fargatePlatformConfiguration?: FargatePlatformConfiguration; + pidMode?: string; /** * @public - *The amount of ephemeral storage allocated 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.
+ *The network configuration for jobs that are running on Fargate resources. Jobs that are + * running on Amazon EC2 resources must not specify this parameter.
*/ - ephemeralStorage?: EphemeralStorage; + networkConfiguration?: NetworkConfiguration; /** * @public - *An object that represents the compute environment architecture for Batch jobs on Fargate.
+ *An object that represents the compute environment architecture for Batch jobs on + * Fargate.
*/ runtimePlatform?: RuntimePlatform; /** * @public - *The private repository authentication credentials to use.
+ *A list of data volumes used in a job.
*/ - repositoryCredentials?: RepositoryCredentials; + volumes?: Volume[]; } /** * @public - *An object that represents an Batch job dependency.
+ *An object that contains the details for the Amazon ECS resources of a job.
*/ -export interface JobDependency { - /** - * @public - *The job ID of the Batch job that's associated with this dependency.
- */ - jobId?: string; - +export interface EcsPropertiesDetail { /** * @public - *The type of the job dependency.
+ *The properties for the Amazon ECS task definition of a job.
*/ - type?: ArrayJobDependency; + taskProperties?: EcsTaskDetails[]; } /** @@ -3976,7 +4820,7 @@ export interface JobDependency { export interface EksAttemptContainerDetail { /** * @public - *The exit code for the job attempt. A non-zero exit code is considered failed.
+ *The exit code returned for the job attempt. A non-zero exit code is considered failed.
*/ exitCode?: number; @@ -4000,6 +4844,12 @@ export interface EksAttemptDetail { */ containers?: EksAttemptContainerDetail[]; + /** + * @public + *The details for the init containers.
+ */ + initContainers?: EksAttemptContainerDetail[]; + /** * @public *The name of the pod for this job attempt.
@@ -4080,8 +4930,8 @@ export interface EksContainerDetail { * 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
+ * VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD
+ * and Define a command and arguments for a pod in the Kubernetes
* documentation.
*/
args?: string[];
@@ -4107,7 +4957,7 @@ export interface EksContainerDetail {
/**
* @public
- * The exit code for the job attempt. A non-zero exit code is considered failed.
+ *The exit code returned for the job attempt. A non-zero exit code is considered failed.
*/ exitCode?: number; @@ -4184,6 +5034,13 @@ export interface EksPodPropertiesDetail { */ containers?: EksContainerDetail[]; + /** + * @public + *The container registered with the Amazon EKS Connector agent and persists the registration + * information in the Kubernetes backend data store.
+ */ + initContainers?: EksContainerDetail[]; + /** * @public *Specifies the volumes for a job definition using Amazon EKS resources.
@@ -4204,12 +5061,19 @@ export interface EksPodPropertiesDetail { /** * @public - *Describes and uniquely identifies Kubernetes resources. For example, the compute environment
- * that a pod runs in or the jobID for a job running in the pod. For more information,
- * see Understanding Kubernetes Objects in the Kubernetes
- * documentation.
Describes and uniquely identifies Kubernetes resources. For example, the compute environment that
+ * a pod runs in or the jobID for a job running in the pod. For more information, see
+ * Understanding Kubernetes Objects in the Kubernetes documentation.
Indicates if the processes in a container are shared, or visible, to other containers in the + * same pod. For more information, see Share + * Process Namespace between Containers in a Pod.
+ */ + shareProcessNamespace?: boolean; } /** @@ -4333,8 +5197,9 @@ export interface JobDetail { * @public *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.
PENDING
+ * state.
*/
createdAt?: number;
@@ -4382,7 +5247,7 @@ export interface JobDetail {
/**
* @public
* An object that represents the details for the container that's associated with the - * job.
+ * job. If the details are for a multiple-container job, this object will be empty. */ container?: ContainerDetail; @@ -4440,9 +5305,7 @@ export interface JobDetail { /** * @public - *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.
*/ eksProperties?: EksPropertiesDetail; @@ -4452,6 +5315,12 @@ export interface JobDetail { */ eksAttempts?: EksAttemptDetail[]; + /** + * @public + *An object with properties that are specific to Amazon ECS-based jobs.
+ */ + ecsProperties?: EcsPropertiesDetail; + /** * @public *Indicates whether the job is canceled.
@@ -4565,43 +5434,46 @@ export interface ListJobsRequest { /** * @public - *The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the - * specified array.
+ *The job ID for an array job. Specifying an array job ID with this parameter lists all + * child jobs from within the specified array.
*/ arrayJobId?: string; /** * @public - *The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all - * nodes that are associated with the specified job.
+ *The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with + * this parameter lists all nodes that are associated with the specified job.
*/ multiNodeJobId?: string; /** * @public - *The job status used to filter jobs in the specified queue. If the filters parameter is specified,
- * the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status,
- * only RUNNING jobs are returned.
The job status used to filter jobs in the specified queue. If the filters
+ * parameter is specified, the jobStatus parameter is ignored and jobs with any
+ * status are returned. If you don't specify a status, only RUNNING jobs are
+ * returned.
The maximum number of results returned by ListJobs in paginated output. When this parameter is
- * used, ListJobs only returns maxResults results in a single page and a
- * nextToken response element. The remaining results of the initial request can be seen by sending another
- * ListJobs request with the returned nextToken value. This value can be between
- * 1 and 100. If this parameter isn't used, then ListJobs returns up to
- * 100 results and a nextToken value if applicable.
The maximum number of results returned by ListJobs in paginated output. When
+ * this parameter is used, ListJobs only returns maxResults results in
+ * a single page and a nextToken response element. The remaining results of the
+ * initial request can be seen by sending another ListJobs request with the returned
+ * nextToken value. This value can be between 1 and
+ * 100. If this parameter isn't used, then ListJobs returns up to
+ * 100 results and a nextToken value if applicable.
The nextToken value returned from a previous paginated ListJobs request where
- * maxResults was used and the results exceeded the value of that parameter. Pagination continues from the
- * end of the previous results that returned the nextToken value. This value is null when
- * there are no more results to return.
The nextToken value returned from a previous paginated ListJobs
+ * request where maxResults was used and the results exceeded the value of that
+ * parameter. Pagination continues from the end of the previous results that returned the
+ * nextToken value. This value is null when there are no more results
+ * to return.
Treat this token as an opaque identifier that's only used to * retrieve the next items in a list and not for other programmatic purposes.
@@ -4611,42 +5483,47 @@ export interface ListJobsRequest { /** * @public - *The filter to apply to the query. Only one filter can be used at a time. When the filter is used,
- * jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP)
- * jobs. The results are sorted by the createdAt field, with the most recent jobs being first.
The filter to apply to the query. Only one filter can be used at a time. When the filter
+ * is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array
+ * or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field,
+ * with the most recent jobs being first.
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*),
- * the filter matches any job name that begins with the string before the '*'. This corresponds to the
- * jobName value. For example, test1 matches both Test1 and
- * test1, and test1* matches both test1 and Test10. When the
- * JOB_NAME filter is used, the results are grouped by the job name and version.
The value of the filter is a case-insensitive match for the job name. If the value
+ * ends with an asterisk (*), the filter matches any job name that begins with the string
+ * before the '*'. This corresponds to the jobName value. For example,
+ * test1 matches both Test1 and test1, and
+ * test1* matches both test1 and Test10. When the
+ * JOB_NAME filter is used, the results are grouped by the job name and
+ * version.
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the
- * jobDefinition value. The value is case sensitive. When the value for the filter is the job definition
- * name, the results include all the jobs that used any revision of that job definition name. If the value ends with
- * an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For
- * example, jd1 matches only jd1, and jd1* matches both jd1 and
- * jd1A. The version of the job definition that's used doesn't affect the sort order. When the
- * JOB_DEFINITION filter is used and the ARN is used (which is in the form
- * arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}), the
- * results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the
- * ARN is used.
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This
+ * corresponds to the jobDefinition value. The value is case sensitive. When
+ * the value for the filter is the job definition name, the results include all the jobs
+ * that used any revision of that job definition name. If the value ends with an asterisk
+ * (*), the filter matches any job definition name that begins with the string before the
+ * '*'. For example, jd1 matches only jd1, and jd1*
+ * matches both jd1 and jd1A. The version of the job definition
+ * that's used doesn't affect the sort order. When the JOB_DEFINITION filter
+ * is used and the ARN is used (which is in the form
+ * arn:$\{Partition\}:batch:$\{Region\}:$\{Account\}:job-definition/$\{JobDefinitionName\}:$\{Revision\}),
+ * the results include jobs that used the specified revision of the job definition.
+ * Asterisk (*) isn't supported when the ARN is used.
The value for the filter is the time that's before the job was created. This corresponds to the
- * createdAt value. The value is a string representation of the number of milliseconds since 00:00:00
- * UTC (midnight) on January 1, 1970.
The value for the filter is the time that's before the job was created. This
+ * corresponds to the createdAt value. The value is a string representation of
+ * the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
The value for the filter is the time that's after the job was created. This corresponds to the
- * createdAt value. The value is a string representation of the number of milliseconds since 00:00:00
- * UTC (midnight) on January 1, 1970.
The value for the filter is the time that's after the job was created. This
+ * corresponds to the createdAt value. The value is a string representation of
+ * the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
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.
PENDING state.
*/
createdAt?: number;
@@ -4799,9 +5677,10 @@ export interface ListJobsResponse {
/**
* @public
- * The nextToken value to include in a future ListJobs request. When the results of a
- * ListJobs request exceed maxResults, this value can be used to retrieve the next page of
- * results. This value is null when there are no more results to return.
The nextToken value to include in a future ListJobs request.
+ * When the results of a ListJobs request exceed maxResults, this value
+ * can be used to retrieve the next page of results. This value is null when there
+ * are no more results to return.
The maximum number of results that's returned by ListSchedulingPolicies in paginated output. When
- * this parameter is used, ListSchedulingPolicies only returns maxResults results in a single
- * page and a nextToken response element. You can see the remaining results of the initial request by
- * sending another ListSchedulingPolicies request with the returned nextToken value. This
- * value can be between 1 and 100. If this parameter isn't used,
- * ListSchedulingPolicies returns up to 100 results and a nextToken value
- * if applicable.
The maximum number of results that's returned by ListSchedulingPolicies in
+ * paginated output. When this parameter is used, ListSchedulingPolicies only
+ * returns maxResults results in a single page and a nextToken response
+ * element. You can see the remaining results of the initial request by sending another
+ * ListSchedulingPolicies request with the returned nextToken value.
+ * This value can be between 1 and 100. If this parameter isn't
+ * used, ListSchedulingPolicies returns up to 100 results and a
+ * nextToken value if applicable.
The nextToken value to include in a future ListSchedulingPolicies request. When the
- * results of a ListSchedulingPolicies request exceed maxResults, this value can be used to
- * retrieve the next page of results. This value is null when there are no more results to return.
The nextToken value to include in a future
+ * ListSchedulingPolicies request. When the results of a
+ * ListSchedulingPolicies request exceed maxResults, this value can
+ * be used to retrieve the next page of results. This value is null when there are
+ * no more results to return.
The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and - * lowercase letters, numbers, hyphens (-), and underscores (_).
+ *The name of the job definition to register. It can be up to 128 letters long. It can + * contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
*/ jobDefinitionName: string | undefined; /** * @public - *The type of job definition. 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. For more information about multi-node parallel jobs, see + * Creating a multi-node + * parallel job definition in the Batch User Guide.
+ *If the value is container, then one of the following is required: containerProperties, ecsProperties, or eksProperties.
If the value is multinode, then nodeProperties is required.
If the job is run on Fargate resources, then multinode isn't supported.
Default parameter substitution placeholders to 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.
Default parameter substitution placeholders to 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.
The scheduling priority for jobs that are submitted with this 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 for jobs that are submitted with this 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 minimum supported value is 0 and the maximum supported value is 9999.
*/ schedulingPriority?: number; /** * @public - *An object with various properties specific to Amazon ECS based single-node container-based jobs. If the job
- * definition's type parameter is container, then you must specify either
- * containerProperties or nodeProperties. This must not be specified for Amazon EKS based job
- * definitions.
An object with properties specific to Amazon ECS-based single-node container-based jobs. If the
+ * job definition's type parameter is container, then you must specify
+ * either containerProperties or nodeProperties. This must not be
+ * specified for Amazon EKS-based job definitions.
If the job runs on Fargate resources, then you must not specify nodeProperties; use only
- * containerProperties.
If the job runs on Fargate resources, then you must not specify
+ * nodeProperties; use only containerProperties.
An object with various properties specific to multi-node parallel jobs. If you specify node properties for a
- * job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the
- * Batch User Guide. If the job definition's type parameter is container,
- * then you must specify either containerProperties or nodeProperties.
An object with properties specific to multi-node parallel jobs. If you specify node + * properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel + * Jobs in the Batch User Guide.
*If the job runs on Fargate resources, then you must not specify nodeProperties; use
- * containerProperties instead.
If the job runs on Fargate resources, then you must not specify
+ * nodeProperties; use containerProperties instead.
If the job runs on Amazon EKS resources, then you must not specify nodeProperties.
If the job runs on Amazon EKS resources, then you must not specify
+ * nodeProperties.
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's - * specified during a SubmitJob operation overrides the retry strategy defined here. If a job is - * terminated due to a timeout, it isn't retried.
+ *The retry strategy to use for failed jobs that are submitted with this job definition. Any + * retry strategy that's specified during a SubmitJob operation overrides the + * retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
*/ retryStrategy?: RetryStrategy; /** * @public - *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 are not propagated. Tags can only be propagated to the tasks during task creation. 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 are not propagated. Tags can only
+ * be propagated to the tasks during task creation. 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.
If the job runs on Amazon EKS resources, then you must not specify propagateTags.
If the job runs on Amazon EKS resources, then you must not specify
+ * propagateTags.
The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates - * your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for - * the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation - * overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.
+ *The timeout configuration for jobs that are submitted with this job definition, after + * which Batch terminates your jobs if they have not finished. If a job is terminated due to a + * timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout + * configuration that's specified during a SubmitJob operation overrides the + * timeout configuration defined here. For more information, see Job Timeouts in the + * Batch User Guide.
*/ timeout?: JobTimeout; /** * @public - *The tags that you apply to the job definition to help you 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 Batch User Guide.
+ *The tags that you apply to the job definition to help you 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 + * Batch User Guide.
*/ tags?: RecordThe platform capabilities required by the job definition. If no value is specified, it defaults to
- * EC2. To run the job on Fargate resources, specify FARGATE.
The platform capabilities required by the job definition. If no value is specified, it
+ * defaults to EC2. To run the job on Fargate resources, specify
+ * FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
If the job runs on Amazon EKS resources, then you must not specify
+ * platformCapabilities.
An object with various properties that are specific to Amazon EKS based jobs. This must not be specified for Amazon ECS - * based job definitions.
+ *An object with properties that are specific to Amazon EKS-based jobs. This must not be + * specified for Amazon ECS based job definitions.
*/ eksProperties?: EksProperties; + + /** + * @public + *An object with properties that are specific to Amazon ECS-based jobs. This must not be + * specified for Amazon EKS-based job definitions.
+ */ + ecsProperties?: EcsProperties; } /** @@ -5057,7 +5962,7 @@ export interface RegisterJobDefinitionResponse { * @public *The overrides that should be sent to a container.
*For information about using Batch overrides when you connect event sources to targets, see - * BatchContainerOverrides.
+ * BatchContainerOverrides. */ export interface ContainerOverrides { /** @@ -5066,7 +5971,7 @@ export interface ContainerOverrides { * *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
+ * running on Fargate resources. For jobs that run on Amazon 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
@@ -5083,8 +5988,8 @@ export interface ContainerOverrides {
*
*
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
+ * resources. For jobs that run on Amazon 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
@@ -5137,9 +6042,88 @@ export interface ContainerOverrides {
/**
* @public
- *
Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.
+ *The overrides that should be sent to a container.
+ *For information about using Batch overrides when you connect event sources to targets, see + * BatchContainerOverrides.
+ */ +export interface TaskContainerOverrides { + /** + * @public + *The command to send to the container that overrides the default command from the Docker + * image or the job definition.
+ *This parameter can't contain an empty 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.
+ *Environment variables cannot start with AWS_BATCH. This naming convention is
+ * reserved for variables that Batch sets.
A pointer to the container that you want to override. The container's name provides a unique + * identifier for the container being used.
+ */ + name?: string; + + /** + * @public + *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.
An object that contains overrides for the task definition of a job.
+ */ +export interface TaskPropertiesOverride { + /** + * @public + *The overrides for the container definition of a job.
+ */ + containers?: TaskContainerOverrides[]; +} + +/** + * @public + *An object that contains overrides for the Amazon ECS task definition of a job.
+ */ +export interface EcsPropertiesOverride { + /** + * @public + *The overrides for the Amazon ECS task definition of a job.
+ *This object is currently limited to one element.
+ *Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API + * operation.
*/ export interface EksContainerOverride { + /** + * @public + *A pointer to the container that you want to override. The name must match a unique container name that you wish to override.
+ */ + name?: string; + /** * @public *The override of the Docker image that's used to start the container.
@@ -5156,8 +6140,8 @@ export interface EksContainerOverride { /** * @public *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 + * arguments from the Docker image or the job definition. For more information, see Dockerfile reference: CMD + * and Define a command an arguments for a pod in the Kubernetes * documentation.
*/ args?: string[]; @@ -5196,6 +6180,16 @@ export interface EksPodPropertiesOverride { */ containers?: EksContainerOverride[]; + /** + * @public + *The overrides for the conatainers defined in the Amazon EKS pod. These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init + * Containers in the Kubernetes documentation.
+ *This object is limited to 10 elements
+ *Metadata about the @@ -5218,7 +6212,8 @@ 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 { /** @@ -5236,11 +6231,26 @@ export interface NodePropertyOverride { *The overrides that are sent to a node range.
*/ containerOverrides?: ContainerOverrides; + + /** + * @public + *An object that contains the properties that you want to replace for the existing Amazon ECS + * resources of a job.
+ */ + ecsPropertiesOverride?: EcsPropertiesOverride; + + /** + * @public + *An object that contains the instance types that you want to replace for the existing + * resources of a job.
+ */ + instanceTypes?: string[]; } /** * @public - *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.
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain - * uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
+ *The name of the job. It can be up to 128 letters long. The first character must be + * alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and + * underscores (_).
*/ jobName: string | undefined; /** * @public - *The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
+ *The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) + * of the queue.
*/ jobQueue: string | undefined; @@ -5306,8 +6318,8 @@ export interface SubmitJobRequest { /** * @public - *The scheduling priority for the job. 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 + *
The scheduling priority for the job. 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. * This * overrides any scheduling priority in the job definition and works only within a single share @@ -5318,30 +6330,32 @@ export interface SubmitJobRequest { /** * @public - *
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and - * 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the - * Batch User Guide.
+ *The array properties for the submitted job, such as the size of the array. The array size + * can be between 2 and 10,000. If you specify array properties for a job, it becomes an array + * job. For more information, see Array Jobs in the Batch User Guide.
*/ arrayProperties?: ArrayProperties; /** * @public - *A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a
- * SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job
- * completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job
- * ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each
- * dependency to complete before it can begin.
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can
+ * specify a SEQUENTIAL type dependency without specifying a job ID for array jobs
+ * so that each child array job completes sequentially, starting at index 0. You can also specify
+ * an N_TO_N type dependency with a job ID for array jobs. In that case, each index
+ * child of this job must wait for the corresponding index child of each dependency to complete
+ * before it can begin.
The job definition used by this job. This value can be one of The job definition used by this job. This value can be one of
+ * If the revision is not specified, then the latest active revision is used. Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job
- * definition. Parameters are specified as a key and value pair mapping. Parameters in a Additional parameters passed to the job that replace parameter substitution placeholders
+ * that are set in the job definition. Parameters are specified as a key and value pair mapping.
+ * Parameters in a An object with various properties that override the defaults for the job definition that specify the name of a
- * container in the specified job definition and the overrides it should receive. You can override the default command
- * for a container, which is specified in the job definition or the Docker image, with a An object with properties that override the defaults for the job definition that specify
+ * the name of a container in the specified job definition and the overrides it should receive.
+ * You can override the default command for a container, which is specified in the job definition
+ * or the Docker image, with a A list of node overrides in JSON format that specify the node range to target and the container overrides for
- * that node range. A list of node overrides in JSON format that specify the node range to target and the
+ * container overrides for that node range. This parameter isn't applicable to jobs that are running on Fargate resources; use
- * 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
+ * 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
+ * or
+ * arn:aws:batch:region:account:job-definition/definition-name
* ).SubmitJob request
- * override any corresponding parameter defaults from the job definition.SubmitJob request override any corresponding parameter defaults
+ * from the job definition.command override.
- * You can also override existing environment variables on a container or add new environment variables to it with an
- * environment override.command override. You can also override existing
+ * environment variables on a container or add new environment variables to it with an
+ * environment override.containerOverrides instead.containerOverrides instead.
The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy - * is specified here, it overrides the retry strategy defined in the job definition.
+ *The retry strategy to use for failed jobs from this SubmitJob operation. + * When a retry strategy is specified here, it overrides the retry strategy defined in the job + * definition.
*/ retryStrategy?: RetryStrategy; /** * @public - *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 during task creation. 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. When specified, this
- * overrides the tag propagation setting in the job definition.
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 during task creation. 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. When
+ * specified, this overrides the tag propagation setting in the job definition.
The timeout configuration for this SubmitJob operation. You can specify a timeout duration - * after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't - * retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration - * specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. - * For more information, see Job - * Timeouts in the Amazon Elastic Container Service Developer Guide.
+ *The timeout configuration for this SubmitJob operation. You can specify + * a timeout duration after which Batch terminates your jobs if they haven't finished. If a job + * is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 + * seconds. This configuration overrides any timeout configuration specified in the job + * definition. For array jobs, child jobs have the same timeout configuration as the parent job. + * For more information, see Job Timeouts in the + * Amazon Elastic Container Service Developer Guide.
*/ timeout?: JobTimeout; /** * @public - *The tags that you apply to the job request to help you 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 job request to help you 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?: RecordAn object that can only be specified for jobs that are run on Amazon EKS resources with various properties that - * override defaults for the job definition.
+ *An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.
*/ eksPropertiesOverride?: EksPropertiesOverride; + + /** + * @public + *An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.
+ */ + ecsPropertiesOverride?: EcsPropertiesOverride; } /** @@ -5457,9 +6481,9 @@ export interface TagResourceRequest { /** * @public - *The tags that you apply to the resource to help you 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 resource to help you 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 message to attach to the job that explains the reason for canceling it. This message is returned by future - * DescribeJobs operations on the job. This message is also recorded in the Batch activity - * logs.
+ *A message to attach to the job that explains the reason for canceling it. This message is + * returned by future DescribeJobs operations on the job. This message is also + * recorded in the Batch activity logs.
*/ reason: string | undefined; } @@ -5556,11 +6580,11 @@ export interface ComputeResourceUpdate { *The maximum number of Amazon EC2 vCPUs that an environment can reach.
*With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and
- * SPOT_PRICE_CAPACITY_OPTIMIZED
+ * SPOT_PRICE_CAPACITY_OPTIMIZED
* (recommended) 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.
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 VPC subnets where the compute resources are launched. Fargate compute resources can * contain up to 16 subnets. For Fargate compute resources, providing an empty list will be - * handled as if this parameter wasn't specified and no change is made. For EC2 compute resources, + * handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, * providing an empty list removes the VPC subnets from the compute resource. For more information, * see VPCs and * subnets in the Amazon VPC User Guide.
@@ -5615,9 +6639,9 @@ export interface ComputeResourceUpdate { *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 + * this parameter wasn't specified and no change is made. For Amazon 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 + *
When updating a compute environment, changing the Amazon EC2 security groups requires an * infrastructure update of the compute environment. For more information, see Updating compute * environments in the Batch User Guide.
*/ @@ -5653,18 +6677,18 @@ export interface ComputeResourceUpdate { *The price and capacity optimized allocation strategy looks at both price and capacity to + *
The price and capacity optimized allocation strategy looks at both price and capacity to * select the Spot Instance pools that are the least likely to be interrupted and have the lowest * possible price. This allocation strategy is only available for Spot Instance compute * resources.
*With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and
- * SPOT_PRICE_CAPACITY_OPTIMIZED
+ * SPOT_PRICE_CAPACITY_OPTIMIZED
* (recommended) 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.
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.
*/
allocationStrategy?: CRUpdateAllocationStrategy;
@@ -5699,7 +6723,7 @@ export interface ComputeResourceUpdate {
* 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 + *
When updating a compute environment, changing the Amazon EC2 key pair 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 + *
Key-value pair tags to be applied to Amazon 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
@@ -5801,12 +6825,12 @@ export interface ComputeResourceUpdate {
/**
* @public
- *
Provides information used to select Amazon Machine Images (AMIs) for EC2 instances in the + *
Provides information used to select Amazon Machine Images (AMIs) for Amazon 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
+ * Batch User Guide. To remove the Amazon EC2 configuration and any custom AMI ID
* specified in imageIdOverride, set this value to an empty string.
One or two values can be provided.
*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.
+ *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.
*/ unmanagedvCpus?: number; /** * @public - *Details of the compute resources managed by the compute environment. Required for a managed compute environment. - * For more information, see Compute - * Environments in the Batch User Guide.
+ *Details of the compute resources managed by the compute environment. Required for a + * managed compute environment. For more information, see Compute Environments in the + * Batch User Guide.
*/ computeResources?: ComputeResourceUpdate; /** * @public - *The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. - * For more information, see Batch service IAM - * role in the Batch User Guide.
+ *The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services + * services on your behalf. For more information, see Batch service IAM role in the + * Batch User Guide.
*If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. - * Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To - * update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see - * Updating compute - * environments in the Batch User Guide.
+ *If the compute environment has a service-linked role, it can't be changed to use a + * regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't + * be changed to use a service-linked role. To update the parameters for the compute + * environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, + * see Updating + * compute environments in the Batch User Guide.
*If your specified role has a path other than /, then you must either specify the full role ARN
- * (recommended) or prefix the role name with the path.
If your specified role has a path other than /, then you must either specify
+ * the full role ARN (recommended) or prefix the role name with the path.
Depending on how you created your Batch service role, its ARN might contain the service-role
- * path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the
- * service-role path prefix. Because of this, we recommend that you specify the full ARN of your service
- * role when you create compute environments.
Depending on how you created your Batch service role, its ARN might contain the
+ * service-role path prefix. When you only specify the name of the service role,
+ * Batch assumes that your ARN doesn't use the service-role path prefix. Because
+ * of this, we recommend that you specify the full ARN of your service role when you create
+ * compute environments.
Specifies the updated infrastructure update policy for the compute environment. For more information about - * infrastructure updates, see Updating - * compute environments in the Batch User Guide.
+ *Specifies the updated infrastructure update policy for the compute environment. For more + * information about infrastructure updates, see Updating compute environments in + * the Batch User Guide.
*/ updatePolicy?: UpdatePolicy; } @@ -5989,44 +7015,47 @@ export interface UpdateJobQueueRequest { /** * @public - *Describes the queue's ability 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 queue's ability 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.
Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can
- * be replaced but not removed. The format is
- * Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share
+ * scheduling policy can be replaced but not removed. 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.
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 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.
Details the set of compute environments mapped to a job queue and their order relative to each other. This is
- * one of the parameters used by the job scheduler to determine which compute environment runs a given job. 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.
Details the set of compute environments mapped to a job queue and their order relative to
+ * each other. This is one of the parameters used by the job scheduler to determine which compute
+ * environment runs a given job. 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.
*A message to attach to the job that explains the reason for canceling it. This message is returned by future\n DescribeJobs operations on the job. This message is also recorded in the Batch activity\n logs.
", + "smithy.api#documentation": "A message to attach to the job that explains the reason for canceling it. This message is\n returned by future DescribeJobs operations on the job. This message is also\n recorded in the Batch activity logs.
", "smithy.api#required": {} } } @@ -1649,7 +1649,7 @@ "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\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.
" + "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 the\n Batch User Guide.
" } }, "updatePolicy": { @@ -1708,7 +1708,7 @@ } }, "traits": { - "smithy.api#documentation": "The 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 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); Amazon 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 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.
\nThe price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus 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.
\nThe price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.
The maximum number of\n vCPUs that a\n compute environment can\n support.
\nWith BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.
The maximum number of\n vCPUs that a\n compute environment can\n support.
\nWith BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This parameter is required \n for Amazon EC2 instances types. You can 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.
\nThe Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This\n parameter is required for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN)\n of an instance profile. For example, \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\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.
\nKey-value pair tags to be applied to Amazon 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 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.
\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 parameters in the launch\n template. You must specify either the launch template ID or launch template name in the request,\n 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\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.
\nProvides information that's used to select Amazon Machine Images (AMIs) for Amazon EC2 instances\n in 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.
\nThe maximum number of Amazon EC2 vCPUs that an environment can reach.
\nWith BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.
The maximum number of Amazon EC2 vCPUs that an environment can reach.
\nWith BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.
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 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 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 Amazon 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\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.
" + "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 Amazon EC2 compute resources, providing an\n empty list removes the security groups from the compute resource.
\nWhen updating a compute environment, changing the Amazon 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\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.
\nThe price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus 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.
\nThe price and capacity optimized allocation strategy looks at both price and capacity to\n select the Spot Instance pools that are the least likely to be interrupted and have the lowest\n possible price. This allocation strategy is only available for Spot Instance compute\n resources.
\nWith BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and\n SPOT_PRICE_CAPACITY_OPTIMIZED\n (recommended) strategies using On-Demand or Spot Instances, and the\n BEST_FIT strategy using Spot Instances, Batch might need to exceed\n maxvCpus to meet your capacity requirements. In this event, Batch never exceeds\n maxvCpus by more than a single instance.
The 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 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 Amazon 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.
\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.
\nKey-value pair tags to be applied to Amazon 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.
\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.
\nProvides information used to select Amazon Machine Images (AMIs) for Amazon 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 Amazon 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.
\nThe 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.
The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you\n can specify the vCPU requirement for the job using resourceRequirements, but you\n can't 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\n jobs, including all run on Fargate resources, see resourceRequirements.
For jobs running on Amazon 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 exit code to return upon completion.
" + "smithy.api#documentation": "The exit code returned upon completion.
" } }, "reason": { @@ -2084,7 +2084,7 @@ "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\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 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 available in future\n 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 network configuration for jobs that are running on Fargate resources. Jobs that are\n running on EC2 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 Amazon 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\n running on EC2 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 Amazon EC2 resources must not specify this parameter.
" } }, "ephemeralStorage": { @@ -2114,7 +2114,7 @@ "runtimePlatform": { "target": "com.amazonaws.batch#RuntimePlatform", "traits": { - "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on Fargate.
" + "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on\n Fargate.
" } }, "repositoryCredentials": { @@ -2137,7 +2137,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "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\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 Amazon 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\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.
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 Amazon EC2 resources, it overrides the memory parameter\n set 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 overrides that should be sent to a container.
\nFor information about using Batch overrides when you connect event sources to targets, see \n BatchContainerOverrides.
" + "smithy.api#documentation": "The overrides that should be sent to a container.
\nFor information about using Batch overrides when you connect event sources to targets, see\n BatchContainerOverrides.
" } }, "com.amazonaws.batch#ContainerProperties": { @@ -2193,7 +2193,7 @@ "smithy.api#deprecated": { "message": "This field is deprecated, use resourceRequirements instead." }, - "smithy.api#documentation": "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 vCPU\n requirements for the job definition. It's not supported for jobs running on Fargate resources.\n For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the\n 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\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.
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 Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a\n container. If your container attempts to exceed the specified number, it's terminated. You must\n specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be\n specified in several places. It must be specified for each node at least once.
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 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 network configuration for jobs that are running on Fargate resources. Jobs that are\n running on EC2 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 Amazon 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\n running on EC2 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 Amazon EC2 resources must not specify this parameter.
" } }, "ephemeralStorage": { @@ -2316,7 +2316,7 @@ "runtimePlatform": { "target": "com.amazonaws.batch#RuntimePlatform", "traits": { - "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on Fargate.
" + "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on\n Fargate.
" } }, "repositoryCredentials": { @@ -2367,7 +2367,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute\n environments. MANAGED compute environments can use Amazon EC2 or Fargate resources.\n UNMANAGED compute environments can only use EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the compute resources\n within the environment. This is based on the compute resource specification that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot\n Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can\n optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a\n specified percentage of the On-Demand price.
\nMulti-node parallel jobs aren't supported on Spot Instances.
\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how\n you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of\n your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch\n your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the\n Amazon Elastic Container Service Developer Guide.
\nTo create a compute environment that uses EKS resources, the caller must have permissions to call\n eks:DescribeCluster.
Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it\n also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is\n available. You're responsible for the management of the guest operating system. This includes any updates and\n security patches. You're also responsible for any additional application software or utilities that you install on\n the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to complete\n these steps:
\nCreate a new compute environment with the new AMI.
\nAdd the compute environment to an existing job queue.
\nRemove the earlier compute environment from your job queue.
\nDelete the earlier compute environment.
\nIn April 2022, Batch added enhanced support for updating compute environments. For more information, see\n Updating compute\n environments. To use the enhanced updating of compute environments to update AMIs, follow these\n rules:
\nEither don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.
Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE, \n SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.
Set the update to latest image version (updateToLatestImageVersion)\n parameter to\n true.\n The updateToLatestImageVersion parameter is used when you update a compute\n environment. This parameter is ignored when you create a compute\n environment.
Don't specify an AMI ID in imageId, imageIdOverride (in \n ec2Configuration\n ), or in the launch\n template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's\n supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID\n in the imageId or imageIdOverride parameters, or the launch template identified by the\n LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the\n AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the\n imageId or imageIdOverride parameters. It can only be replaced by specifying a different\n launch template, or if the launch template version is set to $Default or $Latest, by\n setting either a new default version for the launch template (if $Default) or by adding a new version\n to the launch template (if $Latest).
If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be\n re-selected. If the version setting in the launch template (launchTemplate) is set to\n $Latest or $Default, the latest or default version of the launch template is evaluated up\n at the time of the infrastructure update, even if the launchTemplate wasn't updated.
Creates an Batch compute environment. You can create MANAGED or\n UNMANAGED compute environments. MANAGED compute environments can\n use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use\n EC2 resources.
In a managed compute environment, Batch manages the capacity and instance types of the\n compute resources within the environment. This is based on the compute resource specification\n that you define or the launch template that you\n specify when you create the compute environment. Either, you can choose to use EC2 On-Demand\n Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in\n your managed compute environment. You can optionally set a maximum price so that Spot\n Instances only launch when the Spot Instance price is less than a specified percentage of the\n On-Demand price.
\nMulti-node parallel jobs aren't supported on Spot Instances.
\nIn an unmanaged compute environment, you can manage your own EC2 compute resources and\n have flexibility with how you configure your compute resources. For example, you can use\n custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance\n AMI specification. For more information, see container instance AMIs in the\n Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment,\n you can use the DescribeComputeEnvironments operation to find the Amazon ECS\n cluster that's associated with it. Then, launch your container instances into that Amazon ECS\n cluster. For more information, see Launching an Amazon ECS container\n instance in the Amazon Elastic Container Service Developer Guide.
\nTo create a compute environment that uses EKS resources, the caller must have\n permissions to call eks:DescribeCluster.
Batch doesn't automatically upgrade the AMIs in a compute environment after it's\n created. For example, it also doesn't update the AMIs in your compute environment when a\n newer version of the Amazon ECS optimized AMI is available. You're responsible for the management\n of the guest operating system. This includes any updates and security patches. You're also\n responsible for any additional application software or utilities that you install on the\n compute resources. There are two ways to use a new AMI for your Batch jobs. The original\n method is to complete these steps:
\nCreate a new compute environment with the new AMI.
\nAdd the compute environment to an existing job queue.
\nRemove the earlier compute environment from your job queue.
\nDelete the earlier compute environment.
\nIn April 2022, Batch added enhanced support for updating compute environments. For\n more information, see Updating compute environments.\n To use the enhanced updating of compute environments to update AMIs, follow these\n rules:
\nEither don't set the service role (serviceRole) parameter or set it to\n the AWSBatchServiceRole service-linked role.
Set the allocation strategy (allocationStrategy) parameter to\n BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, or\n SPOT_PRICE_CAPACITY_OPTIMIZED.
Set the update to latest image version (updateToLatestImageVersion)\n parameter to\n true.\n The updateToLatestImageVersion parameter is used when you update a compute\n environment. This parameter is ignored when you create a compute\n environment.
Don't specify an AMI ID in imageId, imageIdOverride (in\n \n ec2Configuration\n ), or in the launch template\n (launchTemplate). In that case, Batch selects the latest Amazon ECS\n optimized AMI that's supported by Batch at the time the infrastructure update is\n initiated. Alternatively, you can specify the AMI ID in the imageId or\n imageIdOverride parameters, or the launch template identified by the\n LaunchTemplate properties. Changing any of these properties starts an\n infrastructure update. If the AMI ID is specified in the launch template, it can't be\n replaced by specifying an AMI ID in either the imageId or\n imageIdOverride parameters. It can only be replaced by specifying a\n different launch template, or if the launch template version is set to\n $Default or $Latest, by setting either a new default version\n for the launch template (if $Default) or by adding a new version to the\n launch template (if $Latest).
If these rules are followed, any update that starts an infrastructure update causes the\n AMI ID to be re-selected. If the version setting in the launch template\n (launchTemplate) is set to $Latest or $Default, the\n latest or default version of the launch template is evaluated up at the time of the\n infrastructure update, even if the launchTemplate wasn't updated.
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 maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share\n scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job\n queue, no vCPU capacity is reserved.
\nThis parameter is only supported when the type parameter is set to UNMANAGED.
The maximum number of vCPUs for an unmanaged compute environment. This parameter is only\n used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this\n parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.
\nThis parameter is only supported when the type parameter is set to\n UNMANAGED.
Details about the compute resources managed by the compute environment. This parameter is required for managed\n compute environments. For more information, see Compute Environments in the Batch User Guide.
" + "smithy.api#documentation": "Details about the compute resources managed by the compute environment. This parameter is\n required for managed compute environments. For more information, see Compute Environments\n in the Batch User Guide.
" } }, "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For\n more information, see Batch service IAM\n role in the Batch User Guide.
\nIf your account already created the Batch service-linked role, that role is used by default for your compute\n environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your\n account, and no role is specified here, the service attempts to create the Batch service-linked role in your\n account.
\nIf your specified role has a path other than /, then you must specify either the full role ARN\n (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path\n of /foo/, specify /foo/bar as the role name. For more information, see Friendly names\n and paths in the IAM User Guide.
Depending on how you created your Batch service role, its ARN might contain the service-role\n path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services\n services on your behalf. For more information, see Batch service IAM role in the\n Batch User Guide.
\nIf your account already created the Batch service-linked role, that role is used by\n default for your compute environment unless you specify a different role here. If the\n Batch service-linked role doesn't exist in your account, and no role is specified here,\n the service attempts to create the Batch service-linked role in your account.
\nIf your specified role has a path other than /, then you must specify either\n the full role ARN (recommended) or prefix the role name with the path. For example, if a\n role with the name bar has a path of /foo/, specify\n /foo/bar as the role name. For more information, see Friendly\n names and paths in the IAM User Guide.
Depending on how you created your Batch service role, its ARN might contain the\n service-role path prefix. When you only specify the name of the service role,\n Batch assumes that your ARN doesn't use the service-role path prefix. Because\n of this, we recommend that you specify the full ARN of your service role when you create\n compute environments.
The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.
\nThese tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't\n propagate to the underlying compute resources.
" + "smithy.api#documentation": "The tags that you apply to the compute environment to help you categorize and organize\n your resources. Each tag consists of a key and an optional value. For more information, see\n Tagging Amazon Web Services\n Resources in Amazon Web Services General Reference.
\nThese tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute\n resources.
" } }, "eksConfiguration": { @@ -2533,7 +2533,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the\n queue and assign an order of preference for the compute environments.
\nYou also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto\n its associated compute environments. For example, if a compute environment is associated with more than one job\n queue, the job queue with a higher priority is given preference for scheduling jobs to that compute\n environment.
", + "smithy.api#documentation": "Creates an Batch job queue. When you create a job queue, you associate one or more\n compute environments to the queue and assign an order of preference for the compute\n environments.
\nYou also set a priority to the job queue that determines the order that the Batch\n scheduler places jobs onto its associated compute environments. For example, if a compute\n environment is associated with more than one job queue, the job queue with a higher priority\n is given preference for scheduling jobs to that compute environment.
", "smithy.api#examples": [ { "title": "To create a job queue with a single compute environment", @@ -2592,27 +2592,27 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters,\n numbers, hyphens (-), and underscores (_).
", + "smithy.api#documentation": "The name of the job queue. It can be up to 128 letters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.batch#JQState", "traits": { - "smithy.api#documentation": "The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the\n job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can\n finish.
The state of the job queue. If the job queue state is ENABLED, it is able to\n accept jobs. If the job queue state is DISABLED, new jobs can't be added to the\n queue, but jobs already in the queue can finish.
The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair\n share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO)\n scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy.\n The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n An example is\n aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job\n queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue\n uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can\n replace but can't remove the fair share scheduling policy. The format is\n aws:Partition:batch:Region:Account:scheduling-policy/Name\n .\n An example is\n aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.
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\n value for the priority parameter) are evaluated first when associated with the\n same compute environment. Priority is determined in descending order. For example, a job queue\n with a priority value of 10 is given scheduling preference over a job queue with\n a priority value of 1. 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.
The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler\n uses this parameter to determine which compute environment runs a specific job. Compute environments must be in\n the VALID state before you can associate them with a job queue. You can associate up to three compute\n environments with a job queue. All of the compute environments must be either EC2 (EC2 or\n SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute\n 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 set of compute environments mapped to a job queue and their order relative to each\n other. The job scheduler uses this parameter to determine which compute environment runs a\n specific job. Compute environments must be in the VALID state before you can\n associate them with a job queue. You can associate up to three compute environments with a job\n queue. 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.
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\n single job queue.
\nThe tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists\n of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.
" + "smithy.api#documentation": "The tags that you apply to the job queue to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources\n in Batch User Guide.
" } } }, @@ -2692,7 +2692,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase\n letters, numbers, hyphens (-), and underscores (_).
", + "smithy.api#documentation": "The name of the scheduling policy. It can be up to 128 letters long. It can contain\n uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, @@ -2705,7 +2705,7 @@ "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General\n Reference.
\nThese tags can be updated or removed using the TagResource and UntagResource API operations.
" + "smithy.api#documentation": "The tags that you apply to the scheduling policy to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services\n Resources in Amazon Web Services General Reference.
\nThese tags can be updated or removed using the TagResource and UntagResource API operations.
" } } }, @@ -2729,7 +2729,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "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.
Deletes an Batch compute environment.
\nBefore you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all\n active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute\n environment enters an invalid state.
Deletes an Batch compute environment.
\nBefore you can delete a compute environment, you must set its state to\n DISABLED with the UpdateComputeEnvironment API operation and\n disassociate it from any job queues with the UpdateJobQueue API operation.\n Compute environments that use Fargate resources must terminate all active jobs on that\n compute environment before deleting the compute environment. If this isn't done, the compute\n environment enters an invalid state.
Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue.\n The jobs are terminated at a rate of about 16 jobs each second.
\nIt's not necessary to disassociate compute environments from a queue before submitting a\n DeleteJobQueue request.
Deletes the specified job queue. You must first disable submissions for a queue with the\n UpdateJobQueue operation. All jobs in the queue are eventually terminated\n when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each\n second.
\nIt's not necessary to disassociate compute environments from a queue before submitting a\n DeleteJobQueue request.
Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.
", + "smithy.api#documentation": "Deregisters an Batch job definition. Job definitions are permanently deleted after 180\n days.
", "smithy.api#examples": [ { "title": "To deregister a job definition", @@ -2947,7 +2947,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.
The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition\n to deregister.
Describes one or more of your compute environments.
\nIf you're using an unmanaged compute environment, you can use the DescribeComputeEnvironment\n operation to determine the ecsClusterArn that you launch your Amazon ECS container instances\n into.
Describes one or more of your compute environments.
\nIf you're using an unmanaged compute environment, you can use the\n DescribeComputeEnvironment operation to determine the\n ecsClusterArn that you launch your Amazon ECS container instances into.
The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output.\n When this parameter is used, DescribeComputeEnvironments only returns maxResults results in\n a single page along with a nextToken response element. The remaining results of the initial request can\n be seen by sending another DescribeComputeEnvironments request with the returned nextToken\n value. This value can be between 1 and 100. If this parameter isn't used, then\n DescribeComputeEnvironments returns up to 100 results and a nextToken\n value if applicable.
The maximum number of cluster results returned by DescribeComputeEnvironments\n in paginated output. When this parameter is used, DescribeComputeEnvironments\n only returns maxResults results in a single page along with a\n nextToken response element. The remaining results of the initial request can be\n seen by sending another DescribeComputeEnvironments request with the returned\n nextToken value. This value can be between 1 and\n 100. If this parameter isn't used, then DescribeComputeEnvironments\n returns up to 100 results and a nextToken value if\n applicable.
The nextToken value returned from a previous paginated DescribeComputeEnvironments\n request where maxResults was used and the results exceeded the value of that parameter. Pagination\n continues from the end of the previous results that returned the nextToken value. This value is\n null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a previous paginated\n DescribeComputeEnvironments request where maxResults was used and\n the results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe 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.
The nextToken value to include in a future\n DescribeComputeEnvironments request. When the results of a\n DescribeComputeEnvironments request exceed maxResults, this value\n can be used to retrieve the next page of results. This value is null when there\n are no more results to return.
Describes a list of job definitions. You can specify a status (such as ACTIVE) to only\n return job definitions that match that status.
Describes a list of job definitions. You can specify a status (such as\n ACTIVE) to only return job definitions that match that status.
A list of up to 100 job definitions. Each entry in the list can either be an ARN in the\n format\n arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}\n or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.
A list of up to 100 job definitions. Each entry in the list can either be an ARN in the\n format\n arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}\n or a short version using the form ${JobDefinitionName}:${Revision}. This\n parameter can't be used with other parameters.
The maximum number of results returned by DescribeJobDefinitions in paginated output. When this\n parameter is used, DescribeJobDefinitions only returns maxResults results in a single page\n and a nextToken response element. The remaining results of the initial request can be seen by sending\n another DescribeJobDefinitions request with the returned nextToken value. This value can be\n between 1 and 100. If this parameter isn't used, then\n DescribeJobDefinitions returns up to 100 results and a nextToken value\n if applicable.
The maximum number of results returned by DescribeJobDefinitions in paginated\n output. When this parameter is used, DescribeJobDefinitions only returns\n maxResults results in a single page and a nextToken response\n element. The remaining results of the initial request can be seen by sending another\n DescribeJobDefinitions request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter isn't\n used, then DescribeJobDefinitions returns up to 100 results and\n a nextToken value if applicable.
The nextToken value returned from a previous paginated DescribeJobDefinitions request\n where maxResults was used and the results exceeded the value of that parameter. Pagination continues\n from the end of the previous results that returned the nextToken value. This value is null\n when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a previous paginated\n DescribeJobDefinitions request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe 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.
The nextToken value to include in a future\n DescribeJobDefinitions request. When the results of a\n DescribeJobDefinitions request exceed maxResults, this value can\n be used to retrieve the next page of results. This value is null when there are\n no more results to return.
The maximum number of results returned by DescribeJobQueues in paginated output. When this\n parameter is used, DescribeJobQueues only returns maxResults results in a single page and a\n nextToken response element. The remaining results of the initial request can be seen by sending another\n DescribeJobQueues request with the returned nextToken value. This value can be between\n 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up\n to 100 results and a nextToken value if applicable.
The maximum number of results returned by DescribeJobQueues in paginated\n output. When this parameter is used, DescribeJobQueues only returns\n maxResults results in a single page and a nextToken response\n element. The remaining results of the initial request can be seen by sending another\n DescribeJobQueues request with the returned nextToken value. This\n value can be between 1 and 100. If this parameter isn't used,\n then DescribeJobQueues returns up to 100 results and a\n nextToken value if applicable.
The nextToken value returned from a previous paginated DescribeJobQueues request where\n maxResults was used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value. This value is null when\n there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a previous paginated\n DescribeJobQueues request where maxResults was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value. This value is\n null when there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe 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.
The nextToken value to include in a future DescribeJobQueues\n request. When the results of a DescribeJobQueues request exceed\n maxResults, this value can be used to retrieve the next page of results. This\n value is null when there are no more results to return.
An object that contains the properties for the Amazon ECS task definition of a job.
\nThis object is currently limited to one element.
\nAn object that contains the properties for the Amazon ECS resources of a job.
" + } + }, + "com.amazonaws.batch#EcsPropertiesDetail": { + "type": "structure", + "members": { + "taskProperties": { + "target": "com.amazonaws.batch#ListEcsTaskDetails", + "traits": { + "smithy.api#documentation": "The properties for the Amazon ECS task definition of a job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains the details for the Amazon ECS resources of a job.
" + } + }, + "com.amazonaws.batch#EcsPropertiesOverride": { + "type": "structure", + "members": { + "taskProperties": { + "target": "com.amazonaws.batch#ListTaskPropertiesOverride", + "traits": { + "smithy.api#documentation": "The overrides for the Amazon ECS task definition of a job.
\nThis object is currently limited to one element.
\nAn object that contains overrides for the Amazon ECS task definition of a job.
" + } + }, + "com.amazonaws.batch#EcsTaskDetails": { + "type": "structure", + "members": { + "containers": { + "target": "com.amazonaws.batch#ListTaskContainerDetails", + "traits": { + "smithy.api#documentation": "A list of containers that are included in the taskProperties\n list.
The Amazon Resource Name (ARN) of the container instance that hosts the task.
" + } + }, + "taskArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The ARN of the Amazon ECS task.
" + } + }, + "ephemeralStorage": { + "target": "com.amazonaws.batch#EphemeralStorage", + "traits": { + "smithy.api#documentation": "The amount of ephemeral storage allocated for the task.
" + } + }, + "executionRoleArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see\n Batch execution IAM\n role in the Batch User Guide.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The Fargate platform version where the jobs are running.
" + } + }, + "ipcMode": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The IPC resource namespace to use for the containers in the task.
" + } + }, + "taskRoleArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "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.
\nThis is object is comparable to ContainerProperties:jobRoleArn.
\nThe process namespace to use for the containers in the task.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.batch#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on Amazon EC2 resources must not specify this parameter.
" + } + }, + "runtimePlatform": { + "target": "com.amazonaws.batch#RuntimePlatform", + "traits": { + "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on\n Fargate.
" + } + }, + "volumes": { + "target": "com.amazonaws.batch#Volumes", + "traits": { + "smithy.api#documentation": "A list of data volumes used in a job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details of a task definition that describes the container and volume definitions of an\n Amazon ECS task.
" + } + }, + "com.amazonaws.batch#EcsTaskProperties": { + "type": "structure", + "members": { + "containers": { + "target": "com.amazonaws.batch#ListTaskContainerProperties", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "This object is a list of containers.
", + "smithy.api#required": {} + } + }, + "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.
" + } + }, + "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\n resources, you must provide an execution role. For more information, see Batch execution IAM role\n in the Batch User Guide.
" + } + }, + "platformVersion": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The Fargate platform version where the jobs are running. A platform version is specified\n 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 IPC resource namespace to use for the containers in the task. The valid values are\n host, task, or none.
If host is specified, all containers within the tasks that specified the\n host IPC mode on the same container instance share the same IPC resources with the\n host Amazon EC2 instance.
If task is specified, all containers within the specified task\n share the same IPC resources.
If none is specified, the IPC resources within the containers of a task are\n private, and are not shared with other containers in a task or on the container instance.
If no value is specified, then the IPC resource namespace sharing depends on the Docker\n daemon setting on the container instance. For more information, see IPC settings in\n the Docker run reference.
" + } + }, + "taskRoleArn": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.
\nThis is object is comparable to ContainerProperties:jobRoleArn.
\nThe process namespace to use for the containers in the task. The valid values are\n host or task. For example, monitoring sidecars might need\n pidMode to access information about other containers running in the same\n task.
If host is specified, all containers within the tasks that specified the\n host PID mode on the same container instance share the process namespace with the\n host Amazon EC2 instance.
If task is specified, all containers within the specified task share the same\n process namespace.
If no value is specified, the default is a private namespace for each container. For more\n information, see PID settings in the Docker run reference.
" + } + }, + "networkConfiguration": { + "target": "com.amazonaws.batch#NetworkConfiguration", + "traits": { + "smithy.api#documentation": "The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on Amazon EC2 resources must not specify this parameter.
" + } + }, + "runtimePlatform": { + "target": "com.amazonaws.batch#RuntimePlatform", + "traits": { + "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on\n Fargate.
" + } + }, + "volumes": { + "target": "com.amazonaws.batch#Volumes", + "traits": { + "smithy.api#documentation": "A list of volumes that are associated with the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The properties for a task definition that describes the container and volume definitions of\n an Amazon ECS task. You can specify which Docker images to use, the required resources, and other\n configurations related to launching the task definition through an Amazon ECS service or task.
" + } + }, "com.amazonaws.batch#EksAttemptContainerDetail": { "type": "structure", "members": { "exitCode": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The exit code for the job attempt. A non-zero exit code is considered failed.
" + "smithy.api#documentation": "The exit code returned for the job attempt. A non-zero exit code is considered failed.
" } }, "reason": { @@ -3686,6 +3880,12 @@ "smithy.api#documentation": "The details for the final status of the containers for this job attempt.
" } }, + "initContainers": { + "target": "com.amazonaws.batch#EksAttemptContainerDetails", + "traits": { + "smithy.api#documentation": "The details for the init containers.
" + } + }, "podName": { "target": "com.amazonaws.batch#String", "traits": { @@ -3783,7 +3983,7 @@ "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\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.
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 Dockerfile reference: CMD\n and Define a command and arguments for a pod in the Kubernetes\n 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.
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 Dockerfile reference: CMD\n and Define a command and arguments for a pod in the Kubernetes\n documentation.
The exit code for the job attempt. A non-zero exit code is considered failed.
" + "smithy.api#documentation": "The exit code returned for the job attempt. A non-zero exit code is considered failed.
" } }, "reason": { @@ -3926,6 +4126,12 @@ "com.amazonaws.batch#EksContainerOverride": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "A pointer to the container that you want to override. The name must match a unique container name that you wish to override.
" + } + }, "image": { "target": "com.amazonaws.batch#String", "traits": { @@ -3941,7 +4147,7 @@ "args": { "target": "com.amazonaws.batch#StringList", "traits": { - "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.
" + "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 Dockerfile reference: CMD\n and Define a command an arguments for a pod in the Kubernetes\n documentation.
" } }, "env": { @@ -3958,7 +4164,7 @@ } }, "traits": { - "smithy.api#documentation": "Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.
" + "smithy.api#documentation": "Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API\n operation.
" } }, "com.amazonaws.batch#EksContainerOverrideList": { @@ -4126,7 +4332,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes and uniquely identifies Kubernetes resources. For example, the compute environment\n that a pod runs in or the jobID for a job running in the pod. For more information,\n see Understanding Kubernetes Objects in the Kubernetes\n documentation.
Describes and uniquely identifies Kubernetes resources. For example, the compute environment that\n a pod runs in or the jobID for a job running in the pod. For more information, see\n Understanding Kubernetes Objects in the Kubernetes documentation.
The properties of the container that's used on the Amazon EKS pod.
" } }, + "initContainers": { + "target": "com.amazonaws.batch#EksContainers", + "traits": { + "smithy.api#documentation": "These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init\n Containers in the Kubernetes documentation.
\nThis object is limited to 10 elements
\nMetadata about the\n Kubernetes\n pod. For\n more information, see Understanding Kubernetes Objects in the Kubernetes\n documentation.
" } + }, + "shareProcessNamespace": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the processes in a container are shared, or visible, to other containers in the\n same pod. For more information, see Share\n Process Namespace between Containers in a Pod.
" + } } }, "traits": { @@ -4200,6 +4418,12 @@ "smithy.api#documentation": "The properties of the container that's used on the Amazon EKS pod.
" } }, + "initContainers": { + "target": "com.amazonaws.batch#EksContainerDetails", + "traits": { + "smithy.api#documentation": "The container registered with the Amazon EKS Connector agent and persists the registration\n information in the Kubernetes backend data store.
" + } + }, "volumes": { "target": "com.amazonaws.batch#EksVolumes", "traits": { @@ -4221,7 +4445,13 @@ "metadata": { "target": "com.amazonaws.batch#EksMetadata", "traits": { - "smithy.api#documentation": "Describes and uniquely identifies Kubernetes resources. For example, the compute environment\n that a pod runs in or the jobID for a job running in the pod. For more information,\n see Understanding Kubernetes Objects in the Kubernetes\n documentation.
Describes and uniquely identifies Kubernetes resources. For example, the compute environment that\n a pod runs in or the jobID for a job running in the pod. For more information, see\n Understanding Kubernetes Objects in the Kubernetes documentation.
Indicates if the processes in a container are shared, or visible, to other containers in the\n same pod. For more information, see Share\n Process Namespace between Containers in a Pod.
" } } }, @@ -4238,6 +4468,12 @@ "smithy.api#documentation": "The overrides for the container that's used on the Amazon EKS pod.
" } }, + "initContainers": { + "target": "com.amazonaws.batch#EksContainerOverrideList", + "traits": { + "smithy.api#documentation": "The overrides for the conatainers defined in the Amazon EKS pod. These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init\n Containers in the Kubernetes documentation.
\nThis object is limited to 10 elements
\nThe platform configuration for jobs that are running on Fargate resources. Jobs that run\n on EC2 resources must not specify this parameter.
" + "smithy.api#documentation": "The platform configuration for jobs that are running on Fargate resources. Jobs that run\n on Amazon EC2 resources must not specify this parameter.
" } }, "com.amazonaws.batch#Float": { @@ -4622,7 +4858,7 @@ "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.\n Only one can be specified.
An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or\n nodeProperties.
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.
An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.
If the job runs on Fargate resources, don't specify nodeProperties. Use\n containerProperties instead.
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 that contains the properties for the Amazon ECS resources of a job.When ecsProperties\n is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.
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.
An object with properties that are specific to Amazon EKS-based jobs. When eksProperties\n is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.
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 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\n jobs, this is when the child job was spawned by its parent and entered the PENDING\n state.
An object that represents the details for the container that's associated with the\n job.
" + "smithy.api#documentation": "An object that represents the details for the container that's associated with the\n job. If the details are for a multiple-container job, this object will be empty.
" } }, "nodeDetails": { @@ -4883,7 +5125,7 @@ "eksProperties": { "target": "com.amazonaws.batch#EksPropertiesDetail", "traits": { - "smithy.api#documentation": "An object with various properties that are specific to Amazon EKS based jobs. Only one of\n container, eksProperties, or nodeDetails is\n specified.
An object with various properties that are specific to Amazon EKS based jobs.
" } }, "eksAttempts": { @@ -4892,6 +5134,12 @@ "smithy.api#documentation": "A list of job attempts that are associated with this job.
" } }, + "ecsProperties": { + "target": "com.amazonaws.batch#EcsPropertiesDetail", + "traits": { + "smithy.api#documentation": "An object with properties that are specific to Amazon ECS-based jobs.
" + } + }, "isCancelled": { "target": "com.amazonaws.batch#Boolean", "traits": { @@ -4973,7 +5221,7 @@ "target": "com.amazonaws.batch#Integer", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "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 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 Amazon EC2 (EC2\n or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and\n Fargate compute environments can't be mixed.
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.
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\n was called). For array child jobs, this is when the child job was spawned by its parent and\n entered the PENDING state.
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.
" + "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.
" } } }, @@ -5220,7 +5468,7 @@ "version": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "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.
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.
Linux-specific modifications that are applied to the container, such as details for device\n mappings.
" } }, + "com.amazonaws.batch#ListEcsTaskDetails": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#EcsTaskDetails" + } + }, + "com.amazonaws.batch#ListEcsTaskProperties": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#EcsTaskProperties" + } + }, "com.amazonaws.batch#ListJobs": { "type": "operation", "input": { @@ -5289,7 +5549,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of Batch jobs.
\nYou must specify only one of the following items:
\nA job queue ID to return a list of jobs in that job queue
\nA multi-node parallel job ID to return a list of nodes for that job
\nAn array job ID to return a list of the children for that job
\nYou can filter the results by job status with the jobStatus parameter. If you don't specify a\n status, only RUNNING jobs are returned.
Returns a list of Batch jobs.
\nYou must specify only one of the following items:
\nA job queue ID to return a list of jobs in that job queue
\nA multi-node parallel job ID to return a list of nodes for that job
\nAn array job ID to return a list of the children for that job
\nYou can filter the results by job status with the jobStatus parameter. If you\n don't specify a status, only RUNNING jobs are returned.
The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the\n specified array.
" + "smithy.api#documentation": "The job ID for an array job. Specifying an array job ID with this parameter lists all\n child jobs from within the specified array.
" } }, "multiNodeJobId": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all\n nodes that are associated with the specified job.
" + "smithy.api#documentation": "The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with\n this parameter lists all nodes that are associated with the specified job.
" } }, "jobStatus": { "target": "com.amazonaws.batch#JobStatus", "traits": { - "smithy.api#documentation": "The job status used to filter jobs in the specified queue. If the filters parameter is specified,\n the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status,\n only RUNNING jobs are returned.
The job status used to filter jobs in the specified queue. If the filters\n parameter is specified, the jobStatus parameter is ignored and jobs with any\n status are returned. If you don't specify a status, only RUNNING jobs are\n returned.
The maximum number of results returned by ListJobs in paginated output. When this parameter is\n used, ListJobs only returns maxResults results in a single page and a\n nextToken response element. The remaining results of the initial request can be seen by sending another\n ListJobs request with the returned nextToken value. This value can be between\n 1 and 100. If this parameter isn't used, then ListJobs returns up to\n 100 results and a nextToken value if applicable.
The maximum number of results returned by ListJobs in paginated output. When\n this parameter is used, ListJobs only returns maxResults results in\n a single page and a nextToken response element. The remaining results of the\n initial request can be seen by sending another ListJobs request with the returned\n nextToken value. This value can be between 1 and\n 100. If this parameter isn't used, then ListJobs returns up to\n 100 results and a nextToken value if applicable.
The nextToken value returned from a previous paginated ListJobs request where\n maxResults was used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken value. This value is null when\n there are no more results to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken value returned from a previous paginated ListJobs\n request where maxResults was used and the results exceeded the value of that\n parameter. Pagination continues from the end of the previous results that returned the\n nextToken value. This value is null when there are no more results\n to return.
Treat this token as an opaque identifier that's only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe filter to apply to the query. Only one filter can be used at a time. When the filter is used,\n jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP)\n jobs. The results are sorted by the createdAt field, with the most recent jobs being first.
The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*),\n the filter matches any job name that begins with the string before the '*'. This corresponds to the\n jobName value. For example, test1 matches both Test1 and\n test1, and test1* matches both test1 and Test10. When the\n JOB_NAME filter is used, the results are grouped by the job name and version.
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the\n jobDefinition value. The value is case sensitive. When the value for the filter is the job definition\n name, the results include all the jobs that used any revision of that job definition name. If the value ends with\n an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For\n example, jd1 matches only jd1, and jd1* matches both jd1 and\n jd1A. The version of the job definition that's used doesn't affect the sort order. When the\n JOB_DEFINITION filter is used and the ARN is used (which is in the form\n arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the\n results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the\n ARN is used.
The value for the filter is the time that's before the job was created. This corresponds to the\n createdAt value. The value is a string representation of the number of milliseconds since 00:00:00\n UTC (midnight) on January 1, 1970.
The value for the filter is the time that's after the job was created. This corresponds to the\n createdAt value. The value is a string representation of the number of milliseconds since 00:00:00\n UTC (midnight) on January 1, 1970.
The filter to apply to the query. Only one filter can be used at a time. When the filter\n is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array\n or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field,\n with the most recent jobs being first.
The value of the filter is a case-insensitive match for the job name. If the value\n ends with an asterisk (*), the filter matches any job name that begins with the string\n before the '*'. This corresponds to the jobName value. For example,\n test1 matches both Test1 and test1, and\n test1* matches both test1 and Test10. When the\n JOB_NAME filter is used, the results are grouped by the job name and\n version.
The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This\n corresponds to the jobDefinition value. The value is case sensitive. When\n the value for the filter is the job definition name, the results include all the jobs\n that used any revision of that job definition name. If the value ends with an asterisk\n (*), the filter matches any job definition name that begins with the string before the\n '*'. For example, jd1 matches only jd1, and jd1*\n matches both jd1 and jd1A. The version of the job definition\n that's used doesn't affect the sort order. When the JOB_DEFINITION filter\n is used and the ARN is used (which is in the form\n arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}),\n the results include jobs that used the specified revision of the job definition.\n Asterisk (*) isn't supported when the ARN is used.
The value for the filter is the time that's before the job was created. This\n corresponds to the createdAt value. The value is a string representation of\n the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
The value for the filter is the time that's after the job was created. This\n corresponds to the createdAt value. The value is a string representation of\n the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.
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.
The nextToken value to include in a future ListJobs request.\n When the results of a ListJobs request exceed maxResults, this value\n can be used to retrieve the next page of results. This value is null when there\n are no more results to return.
The maximum number of results that's returned by ListSchedulingPolicies in paginated output. When\n this parameter is used, ListSchedulingPolicies only returns maxResults results in a single\n page and a nextToken response element. You can see the remaining results of the initial request by\n sending another ListSchedulingPolicies request with the returned nextToken value. This\n value can be between 1 and 100. If this parameter isn't used,\n ListSchedulingPolicies returns up to 100 results and a nextToken value\n if applicable.
The maximum number of results that's returned by ListSchedulingPolicies in\n paginated output. When this parameter is used, ListSchedulingPolicies only\n returns maxResults results in a single page and a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListSchedulingPolicies request with the returned nextToken value.\n This value can be between 1 and 100. If this parameter isn't\n used, ListSchedulingPolicies returns up to 100 results and a\n nextToken value if applicable.
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.
The nextToken value to include in a future\n ListSchedulingPolicies request. When the results of a\n ListSchedulingPolicies request exceed maxResults, this value can\n be used to retrieve the next page of results. This value is null when there are\n no more results to return.
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.
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\n container section of the Docker Remote API and the\n --volume option to docker run.
The network configuration for jobs that are running on Fargate resources. Jobs that are\n running on EC2 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 Amazon EC2 resources must not specify this parameter.
" } }, "com.amazonaws.batch#NetworkInterface": { @@ -5761,7 +6045,7 @@ } }, "traits": { - "smithy.api#documentation": "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.
An object that represents any node overrides to a job definition that's used in a SubmitJob API\n 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.
The overrides that are sent to a node range.
" } + }, + "ecsPropertiesOverride": { + "target": "com.amazonaws.batch#EcsPropertiesOverride", + "traits": { + "smithy.api#documentation": "An object that contains the properties that you want to replace for the existing Amazon ECS\n resources of a job.
" + } + }, + "instanceTypes": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "An object that contains the instance types that you want to replace for the existing\n resources of a job.
" + } } }, "traits": { - "smithy.api#documentation": "The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.
" + "smithy.api#documentation": "The object that represents any node overrides to a job definition that's used in a SubmitJob API\n operation.
" } }, "com.amazonaws.batch#NodePropertyOverrides": { @@ -5872,10 +6168,22 @@ "traits": { "smithy.api#documentation": "The container details for the node range.
" } + }, + "instanceTypes": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "The instance types of the underlying host infrastructure of a multi-node parallel job.
\nThis parameter isn't applicable to jobs that are running on Fargate resources.
\nIn addition, this list object is currently limited to one element.
\nThis is an object that represents the properties of the node range for a multi-node parallel\n job.
" + } } }, "traits": { - "smithy.api#documentation": "An object that represents the properties of the node range for a multi-node parallel\n job.
" + "smithy.api#documentation": "This is an object that represents the properties of the node range for a multi-node parallel\n job.
" } }, "com.amazonaws.batch#OrchestrationType": { @@ -6028,7 +6336,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and\n lowercase letters, numbers, hyphens (-), and underscores (_).
", + "smithy.api#documentation": "The name of the job definition to register. It can be up to 128 letters long. It can\n contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
", "smithy.api#required": {} } }, @@ -6036,68 +6344,74 @@ "target": "com.amazonaws.batch#JobDefinitionType", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the\n Batch User Guide.
\nIf the job is run on Fargate resources, then multinode isn't supported.
The type of job definition. For more information about multi-node parallel jobs, see\n Creating a multi-node\n parallel job definition in the Batch User Guide.
\nIf the value is container, then one of the following is required: containerProperties, ecsProperties, or eksProperties.
If the value is multinode, then nodeProperties is required.
If the job is run on Fargate resources, then multinode isn't supported.
Default parameter substitution placeholders to set in the job definition. Parameters are specified as a\n key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults\n from the job definition.
Default parameter substitution placeholders to set in the job definition. Parameters are\n specified as a key-value pair mapping. Parameters in a SubmitJob request override\n any corresponding parameter defaults from the job definition.
The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job\n queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority.
\nThe minimum supported value is 0 and the maximum supported value is 9999.
" + "smithy.api#documentation": "The scheduling priority for jobs that are submitted with this job definition. This only\n affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority\n are scheduled before jobs with a lower scheduling priority.
\nThe minimum supported value is 0 and the maximum supported value is 9999.
" } }, "containerProperties": { "target": "com.amazonaws.batch#ContainerProperties", "traits": { - "smithy.api#documentation": "An object with various properties specific to Amazon ECS based single-node container-based jobs. If the job\n definition's type parameter is container, then you must specify either\n containerProperties or nodeProperties. This must not be specified for Amazon EKS based job\n definitions.
If the job runs on Fargate resources, then you must not specify nodeProperties; use only\n containerProperties.
An object with properties specific to Amazon ECS-based single-node container-based jobs. If the\n job definition's type parameter is container, then you must specify\n either containerProperties or nodeProperties. This must not be\n specified for Amazon EKS-based job definitions.
If the job runs on Fargate resources, then you must not specify\n nodeProperties; use only containerProperties.
An object with various properties specific to multi-node parallel jobs. If you specify node properties for a\n job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the\n Batch User Guide. If the job definition's type parameter is container,\n then you must specify either containerProperties or nodeProperties.
If the job runs on Fargate resources, then you must not specify nodeProperties; use\n containerProperties instead.
If the job runs on Amazon EKS resources, then you must not specify nodeProperties.
An object with properties specific to multi-node parallel jobs. If you specify node\n properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel\n Jobs in the Batch User Guide.
\nIf the job runs on Fargate resources, then you must not specify\n nodeProperties; use containerProperties instead.
If the job runs on Amazon EKS resources, then you must not specify\n nodeProperties.
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's\n specified during a SubmitJob operation overrides the retry strategy defined here. If a job is\n terminated due to a timeout, it isn't retried.
" + "smithy.api#documentation": "The retry strategy to use for failed jobs that are submitted with this job definition. Any\n retry strategy that's specified during a SubmitJob operation overrides the\n retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
" } }, "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 are not propagated. Tags can only be propagated to the tasks during task creation. For\n tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags\n from the job and job definition is over 50, the job is moved to the FAILED state.
If the job runs on Amazon EKS resources, then you must not specify propagateTags.
Specifies whether to propagate the tags from the job or job definition to the\n corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only\n be propagated to the tasks during task creation. For tags with the same name, job tags are\n given priority over job definitions tags. If the total number of combined tags from the job\n and job definition is over 50, the job is moved to the FAILED state.
If the job runs on Amazon EKS resources, then you must not specify\n propagateTags.
The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates\n your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for\n the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation\n overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.
" + "smithy.api#documentation": "The timeout configuration for jobs that are submitted with this job definition, after\n which Batch terminates your jobs if they have not finished. If a job is terminated due to a\n timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout\n configuration that's specified during a SubmitJob operation overrides the\n timeout configuration defined here. For more information, see Job Timeouts in the\n Batch User Guide.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "The tags that you apply to the job definition to help you categorize and organize your resources. Each tag\n consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.
" + "smithy.api#documentation": "The tags that you apply to the job definition to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in\n Batch User Guide.
" } }, "platformCapabilities": { "target": "com.amazonaws.batch#PlatformCapabilityList", "traits": { - "smithy.api#documentation": "The platform capabilities required by the job definition. If no value is specified, it defaults to\n EC2. To run the job on Fargate resources, specify FARGATE.
If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.
The platform capabilities required by the job definition. If no value is specified, it\n defaults to EC2. To run the job on Fargate resources, specify\n FARGATE.
If the job runs on Amazon EKS resources, then you must not specify\n platformCapabilities.
An object with various properties that are specific to Amazon EKS based jobs. This must not be specified for Amazon ECS\n based job definitions.
" + "smithy.api#documentation": "An object with properties that are specific to Amazon EKS-based jobs. This must not be\n specified for Amazon ECS based job definitions.
" + } + }, + "ecsProperties": { + "target": "com.amazonaws.batch#EcsProperties", + "traits": { + "smithy.api#documentation": "An object with properties that are specific to Amazon ECS-based jobs. This must not be\n specified for Amazon EKS-based job definitions.
" } } }, @@ -6145,7 +6459,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret containing the private repository credentials.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret containing the private repository\n credentials.
", "smithy.api#required": {} } } @@ -6161,7 +6475,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "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 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 Amazon 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 Amazon 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 operating system for the compute environment.\n Valid values are:\n LINUX (default), WINDOWS_SERVER_2019_CORE,\n WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and\n WINDOWS_SERVER_2022_FULL.
The following parameters can’t be set for Windows containers: linuxParameters,\n privileged, user, ulimits,\n readonlyRootFilesystem,\n and efsVolumeConfiguration.
The Batch Scheduler checks\n the compute environments\n that are attached to the job queue before registering a task definition with\n Fargate. In this\n scenario, the job queue is where the job is submitted. If the job requires a\n Windows container and the first compute environment is LINUX, the compute\n environment is skipped and the next compute environment is checked until a Windows-based compute\n environment is found.
Fargate Spot is not supported for\n ARM64 and\n Windows-based containers on Fargate. A job queue will be blocked if a\n Fargate\n ARM64 or\n Windows job is submitted to a job queue with only Fargate Spot compute environments.\n However, you can attach both FARGATE and\n FARGATE_SPOT compute environments to the same job queue.
The operating system for the compute environment.\n Valid values are:\n LINUX (default), WINDOWS_SERVER_2019_CORE,\n WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and\n WINDOWS_SERVER_2022_FULL.
The following parameters can’t be set for Windows containers: linuxParameters,\n privileged, user, ulimits,\n readonlyRootFilesystem,\n and efsVolumeConfiguration.
The Batch Scheduler checks\n the compute environments\n that are attached to the job queue before registering a task definition with\n Fargate. In this\n scenario, the job queue is where the job is submitted. If the job requires a\n Windows container and the first compute environment is LINUX, the compute\n environment is skipped and the next compute environment is checked until a Windows-based compute\n environment is found.
Fargate Spot is not supported for\n ARM64 and\n Windows-based containers on Fargate. A job queue will be blocked if a\n Fargate\n ARM64 or\n Windows job is submitted to a job queue with only Fargate Spot compute environments.\n However, you can attach both FARGATE and\n FARGATE_SPOT compute environments to the same job queue.
\n The vCPU architecture. The default value is X86_64. Valid values are\n X86_64 and ARM64.
This parameter must be set to\n X86_64\n for Windows containers.
Fargate Spot is not supported for ARM64 and Windows-based containers on\n Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is\n submitted to a job queue with only Fargate Spot compute environments. However, you can attach\n both FARGATE and FARGATE_SPOT compute environments to the same job\n queue.
The vCPU architecture. The default value is X86_64. Valid values are\n X86_64 and ARM64.
This parameter must be set to\n X86_64\n for Windows containers.
Fargate Spot is not supported for ARM64 and Windows-based containers on\n Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is\n submitted to a job queue with only Fargate Spot compute environments. However, you can attach\n both FARGATE and FARGATE_SPOT compute environments to the same job\n queue.
\n An object that represents the compute environment architecture for Batch jobs on Fargate.\n
" + "smithy.api#documentation": "An object that represents the compute environment architecture for Batch jobs on\n Fargate.
" } }, "com.amazonaws.batch#SchedulingPolicyDetail": { @@ -6425,7 +6739,7 @@ } ], "traits": { - "smithy.api#documentation": "Submits an Batch job from a job definition. Parameters that are specified during SubmitJob\n override parameters defined in the job definition. vCPU and memory requirements that are specified in the\n resourceRequirements objects in the job definition are the exception. They can't be overridden this way\n using the memory and vcpus parameters. Rather, you must specify updates to job definition\n parameters in a resourceRequirements object that's included in the containerOverrides\n parameter.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.
\nJobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14\n days, Fargate resources might become unavailable and job might be terminated.
\nSubmits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory\n requirements that are specified in the resourceRequirements objects in the job\n definition are the exception. They can't be overridden this way using the memory\n and vcpus parameters. Rather, you must specify updates to job definition\n parameters in a resourceRequirements object that's included in the\n containerOverrides parameter.
Job queues with a scheduling policy are limited to 500 active fair share identifiers at\n a time.
\nJobs that run on Fargate resources can't be guaranteed to run for more than 14 days.\n This is because, after 14 days, Fargate resources might become unavailable and job might be\n terminated.
\nThe name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain\n uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
", + "smithy.api#documentation": "The name of the job. It can be up to 128 letters long. The first character must be\n alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and\n underscores (_).
", "smithy.api#required": {} } }, @@ -6463,7 +6777,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.
", + "smithy.api#documentation": "The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN)\n of the queue.
", "smithy.api#required": {} } }, @@ -6476,75 +6790,81 @@ "schedulingPriorityOverride": { "target": "com.amazonaws.batch#Integer", "traits": { - "smithy.api#documentation": "The scheduling priority for the job. This only affects jobs in job queues with a fair share\n policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority.\n This\n overrides any scheduling priority in the job definition and works only within a single share\n identifier.
\nThe minimum supported value is 0 and the maximum supported value is 9999.
" + "smithy.api#documentation": "The scheduling priority for the job. This only affects jobs in job queues with a fair\n share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower\n scheduling priority.\n This\n overrides any scheduling priority in the job definition and works only within a single share\n identifier.
\nThe minimum supported value is 0 and the maximum supported value is 9999.
" } }, "arrayProperties": { "target": "com.amazonaws.batch#ArrayProperties", "traits": { - "smithy.api#documentation": "The array properties for the submitted job, such as the size of the array. The array size can be between 2 and\n 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the\n Batch User Guide.
" + "smithy.api#documentation": "The array properties for the submitted job, such as the size of the array. The array size\n can be between 2 and 10,000. If you specify array properties for a job, it becomes an array\n job. For more information, see Array Jobs in the Batch User Guide.
" } }, "dependsOn": { "target": "com.amazonaws.batch#JobDependencyList", "traits": { - "smithy.api#documentation": "A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a\n SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job\n completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job\n ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each\n dependency to complete before it can begin.
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can\n specify a SEQUENTIAL type dependency without specifying a job ID for array jobs\n so that each child array job completes sequentially, starting at index 0. You can also specify\n an N_TO_N type dependency with a job ID for array jobs. In that case, each index\n child of this job must wait for the corresponding index child of each dependency to complete\n before it can begin.
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#documentation": "The job definition used by this job. This value can be one of\n definition-name, definition-name:revision, or the Amazon Resource Name (ARN) for the\n 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": {} } }, "parameters": { "target": "com.amazonaws.batch#ParametersMap", "traits": { - "smithy.api#documentation": "Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job\n definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request\n override any corresponding parameter defaults from the job definition.
Additional parameters passed to the job that replace parameter substitution placeholders\n that are set in the job definition. Parameters are specified as a key and value pair mapping.\n Parameters in a SubmitJob request override any corresponding parameter defaults\n from the job definition.
An object with various properties that override the defaults for the job definition that specify the name of a\n container in the specified job definition and the overrides it should receive. You can override the default command\n for a container, which is specified in the job definition or the Docker image, with a command override.\n You can also override existing environment variables on a container or add new environment variables to it with an\n environment override.
An object with properties that override the defaults for the job definition that specify\n the name of a container in the specified job definition and the overrides it should receive.\n You can override the default command for a container, which is specified in the job definition\n or the Docker image, with a command override. You can also override existing\n environment variables on a container or add new environment variables to it with an\n environment override.
A list of node overrides in JSON format that specify the node range to target and the container overrides for\n that node range.
\nThis parameter isn't applicable to jobs that are running on Fargate resources; use\n containerOverrides instead.
A list of node overrides in JSON format that specify the node range to target and the\n container overrides for that node range.
\nThis parameter isn't applicable to jobs that are running on Fargate resources; use\n containerOverrides instead.
The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy\n is specified here, it overrides the retry strategy defined in the job definition.
" + "smithy.api#documentation": "The retry strategy to use for failed jobs from this SubmitJob operation.\n When a retry strategy is specified here, it overrides the retry strategy defined in the job\n definition.
" } }, "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 during task creation. For\n tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags\n from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this\n overrides the tag propagation setting in the job definition.
Specifies whether to propagate the tags from the job or job definition to the\n corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only\n be propagated to the tasks during task creation. For tags with the same name, job tags are\n given priority over job definitions tags. If the total number of combined tags from the job\n and job definition is over 50, the job is moved to the FAILED state. When\n specified, this overrides the tag propagation setting in the job definition.
The timeout configuration for this SubmitJob operation. You can specify a timeout duration\n after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't\n retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration\n specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job.\n For more information, see Job\n Timeouts in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The timeout configuration for this SubmitJob operation. You can specify\n a timeout duration after which Batch terminates your jobs if they haven't finished. If a job\n is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60\n seconds. This configuration overrides any timeout configuration specified in the job\n definition. For array jobs, child jobs have the same timeout configuration as the parent job.\n For more information, see Job Timeouts in the\n Amazon Elastic Container Service Developer Guide.
" } }, "tags": { "target": "com.amazonaws.batch#TagrisTagsMap", "traits": { - "smithy.api#documentation": "The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists\n of 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 job request to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services\n Resources in Amazon Web Services General Reference.
" } }, "eksPropertiesOverride": { "target": "com.amazonaws.batch#EksPropertiesOverride", "traits": { - "smithy.api#documentation": "An object that can only be specified for jobs that are run on Amazon EKS resources with various properties that\n override defaults for the job definition.
" + "smithy.api#documentation": "An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.
" + } + }, + "ecsPropertiesOverride": { + "target": "com.amazonaws.batch#EcsPropertiesOverride", + "traits": { + "smithy.api#documentation": "An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.
" } } }, @@ -6621,7 +6941,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates the specified tags to a resource with the specified resourceArn. If existing tags on a\n resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags that\n are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
Associates the specified tags to a resource with the specified resourceArn.\n If existing tags on a resource aren't specified in the request parameters, they aren't\n changed. When a resource is deleted, the tags that are associated with that resource are\n deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues,\n and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.
The tags that you apply to the resource to help you 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 resource to help you categorize and organize your\n resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services\n Resources in Amazon Web Services General Reference.
", "smithy.api#required": {} } } @@ -6707,6 +7027,312 @@ "target": "com.amazonaws.batch#String" } }, + "com.amazonaws.batch#TaskContainerDependency": { + "type": "structure", + "members": { + "containerName": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "A unique identifier for the container.
" + } + }, + "condition": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The dependency condition of the container. The following are the available conditions and\n their behavior:
\n\n START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.
\n COMPLETE - This condition validates that a dependent container runs to\n completion (exits) before permitting other containers to start. This can be useful for\n nonessential containers that run a script and then exit. This condition can't be set on an\n essential container.
\n SUCCESS - This condition is the same as COMPLETE, but it also\n requires that the container exits with a zero status. This condition can't be set on an\n essential container.
A list of containers that this task depends on.
" + } + }, + "com.amazonaws.batch#TaskContainerDependencyList": { + "type": "list", + "member": { + "target": "com.amazonaws.batch#TaskContainerDependency" + } + }, + "com.amazonaws.batch#TaskContainerDetails": { + "type": "structure", + "members": { + "command": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "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.
A list of containers that this container depends on.
" + } + }, + "environment": { + "target": "com.amazonaws.batch#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "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.
\nIf the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.
All tasks must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "image": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#documentation": "The image used to start a container. This string is passed directly to the Docker daemon. By\n default, images in the Docker Hub registry are available. Other repositories are specified with\n either repository-url/image:tag or repository-url/image@digest. Up to\n 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward\n slashes, and number signs are allowed. This parameter maps to Image in the Create a\n container section of the Docker\n Remote API and the IMAGE parameter of the \n docker\n run\n .
Linux-specific modifications that are applied to the container, such as Linux kernel\n capabilities. For more information, see KernelCapabilities.
\nThis parameter is not supported for Windows containers.
\nThe log configuration specification for the container.
\nThis parameter maps to LogConfig in the Create a\n container section of the Docker\n Remote API and the --log-driver option to docker\n run.
By default, containers use the same logging driver that the Docker daemon uses. However the\n container can use a different logging driver than the Docker daemon by specifying a log driver\n with this parameter in the container definition. To use a different logging driver for a\n container, the log system must be configured properly on the container instance (or on a\n different log server for remote logging options). For more information about the options for\n different supported log drivers, see Configure logging drivers \n in the Docker documentation.
\nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon\n (shown in the LogConfiguration data type). Additional log drivers may be available\n 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\n 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 --format\n '{{.Server.APIVersion}}'\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 mount points for data volumes in your container.
\nThis parameter maps to Volumes in the Create a\n container section of the Docker\n Remote API and the --volume option to docker\n run.
Windows containers can mount whole directories on the same drive as\n $env:ProgramData. Windows containers can't mount directories on a different drive,\n and mount point can't be across drives.
The name of a container.
" + } + }, + "privileged": { + "target": "com.amazonaws.batch#Boolean", + "traits": { + "smithy.api#documentation": "When this parameter is true, the container is given elevated privileges on the\n host container instance (similar to the root user). This parameter maps to\n Privileged in the Create a\n container section of the Docker\n Remote API and the --privileged option to docker\n run.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nWhen this parameter is true, the container is given read-only access to its root file\n system. This parameter maps to ReadonlyRootfs in the Create a\n container section of the Docker\n Remote API and the --read-only option to docker\n run.
This parameter is not supported for Windows containers.
\nThe private repository authentication credentials to use.
" + } + }, + "resourceRequirements": { + "target": "com.amazonaws.batch#ResourceRequirements", + "traits": { + "smithy.api#documentation": "The type and amount of a resource to assign to a container. The only supported resource is a\n GPU.
" + } + }, + "secrets": { + "target": "com.amazonaws.batch#SecretList", + "traits": { + "smithy.api#documentation": "The secrets to pass to the container. For more information, see Specifying Sensitive\n Data in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "ulimits": { + "target": "com.amazonaws.batch#Ulimits", + "traits": { + "smithy.api#documentation": "A list of ulimits to set in the container. If a ulimit value is\n specified in a task definition, it overrides the default values set by Docker. This parameter\n maps to Ulimits in the Create a\n container section of the Docker\n Remote API and the --ulimit option to docker\n run.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating\n system with the exception of the nofile resource limit parameter which Fargate overrides. The\n nofile resource limit sets a restriction on the number of open files that a\n container can use. The default nofile soft limit is 1024 and the\n default hard limit is 65535.
This parameter requires version 1.18 of the Docker Remote API or greater on your container\n 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 --format\n '{{.Server.APIVersion}}'\n
This parameter is not supported for Windows containers.
\nThe user to use inside the container. This parameter maps to User in the Create a container\n section of the Docker Remote API and the --user option to docker run.
\nWhen running tasks using the host network mode, don't run containers using the\n root user (UID 0). We recommend using a non-root user for better security.
You can specify the user using the following formats. If specifying a UID or\n GID, you must specify it as a positive integer.
\n user\n
\n user:group\n
\n uid\n
\n uid:gid\n
\n user:gi\n
\n uid:group\n
\n \n
This parameter is not supported for Windows containers.
\nThe exit code returned upon completion.
" + } + }, + "reason": { + "target": "com.amazonaws.batch#String", + "traits": { + "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\n Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach\n the RUNNING status.
The network interfaces that are associated with the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The details for the container in this task attempt.
" + } + }, + "com.amazonaws.batch#TaskContainerOverrides": { + "type": "structure", + "members": { + "command": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "The command to send to the container that overrides the default command from the Docker\n image or the job definition.
\nThis parameter can't contain an empty string.
\nThe 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 convention is\n reserved for variables that Batch sets.
A pointer to the container that you want to override. The container's name provides a unique\n identifier for the container being used.
" + } + }, + "resourceRequirements": { + "target": "com.amazonaws.batch#ResourceRequirements", + "traits": { + "smithy.api#documentation": "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 overrides that should be sent to a container.
\nFor information about using Batch overrides when you connect event sources to targets, see\n BatchContainerOverrides.
" + } + }, + "com.amazonaws.batch#TaskContainerProperties": { + "type": "structure", + "members": { + "command": { + "target": "com.amazonaws.batch#StringList", + "traits": { + "smithy.api#documentation": "The command that's passed to the container. This parameter maps to Cmd in the\n Create a\n container section of the Docker\n Remote API and the COMMAND parameter to docker run. For more information,\n see Dockerfile reference:\n CMD.
A list of containers that this container depends on.
" + } + }, + "environment": { + "target": "com.amazonaws.batch#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "The environment variables to pass to a container. This parameter maps to Env inthe Create a container\n section of the Docker Remote API\n and the --env parameter 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 convention is\n reserved for variables that Batch sets.
If the essential parameter of a container is marked as true, and that container\n fails or stops for any reason, all other containers that are part of the task are stopped. If the\n essential parameter of a container is marked as false, its failure doesn't affect\n the rest of the containers in a task. If this parameter is omitted, a container is assumed to be\n essential.
All tasks must have at least one essential container. If you have an application that's\n composed of multiple containers, group containers that are used for a common purpose into\n components, and separate the different components into multiple task definitions. For more\n information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "image": { + "target": "com.amazonaws.batch#String", + "traits": { + "smithy.api#clientOptional": {}, + "smithy.api#documentation": "The image used to start a container. This string is passed directly to the Docker daemon. By\n default, images in the Docker Hub registry are available. Other repositories are specified with\n either repository-url/image:tag or repository-url/image@digest. Up to\n 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward\n slashes, and number signs are allowed. This parameter maps to Image in the Create a\n container section of the Docker\n Remote API and the IMAGE parameter of the \n docker\n run\n .
Linux-specific modifications that are applied to the container, such as Linux kernel\n capabilities. For more information, see KernelCapabilities.
" + } + }, + "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\n container section of the Docker\n Remote API and the --log-driver option to docker\n run.
By default, containers use the same logging driver that the Docker daemon uses. However the\n container can use a different logging driver than the Docker daemon by specifying a log driver\n with this parameter in the container definition. To use a different logging driver for a\n container, the log system must be configured properly on the container instance (or on a\n different log server for remote logging options). For more information about the options for\n different supported log drivers, see Configure logging drivers \n in the Docker documentation.
\nAmazon ECS currently supports a subset of the logging drivers available to the Docker daemon\n (shown in the LogConfiguration data type). Additional log drivers may be available\n 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\n 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 --format\n '{{.Server.APIVersion}}'\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 mount points for data volumes in your container.
\nThis parameter maps to Volumes in the Create a\n container section of the Docker\n Remote API and the --volume option to docker\n run.
Windows containers can mount whole directories on the same drive as\n $env:ProgramData. Windows containers can't mount directories on a different drive,\n and mount point can't be across drives.
The name of a container. The name can be used as a unique identifier to target your dependsOn and Overrides objects.
When this parameter is true, the container is given elevated privileges on the\n host container instance (similar to the root user). This parameter maps to\n Privileged in the Create a\n container section of the Docker\n Remote API and the --privileged option to docker\n run.
This parameter is not supported for Windows containers or tasks run on Fargate.
\nWhen this parameter is true, the container is given read-only access to its root file\n system. This parameter maps to ReadonlyRootfs in the Create a\n container section of the Docker\n Remote API and the --read-only option to docker\n run.
This parameter is not supported for Windows containers.
\nThe private repository authentication credentials to use.
" + } + }, + "resourceRequirements": { + "target": "com.amazonaws.batch#ResourceRequirements", + "traits": { + "smithy.api#documentation": "The type and amount of a resource to assign to a container. The only supported resource is a\n GPU.
" + } + }, + "secrets": { + "target": "com.amazonaws.batch#SecretList", + "traits": { + "smithy.api#documentation": "The secrets to pass to the container. For more information, see Specifying Sensitive\n Data in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "ulimits": { + "target": "com.amazonaws.batch#Ulimits", + "traits": { + "smithy.api#documentation": "A list of ulimits to set in the container. If a ulimit value is\n specified in a task definition, it overrides the default values set by Docker. This parameter\n maps to Ulimits in the Create a\n container section of the Docker\n Remote API and the --ulimit option to docker\n run.
Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating\n system with the exception of the nofile resource limit parameter which Fargate overrides. The\n nofile resource limit sets a restriction on the number of open files that a\n container can use. The default nofile soft limit is 1024 and the\n default hard limit is 65535.
This parameter requires version 1.18 of the Docker Remote API or greater on your container\n 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 --format\n '{{.Server.APIVersion}}'\n
This parameter is not supported for Windows containers.
\nThe user to use inside the container. This parameter maps to User in the Create a container\n section of the Docker Remote API and the --user option to docker run.
\nWhen running tasks using the host network mode, don't run containers using the\n root user (UID 0). We recommend using a non-root user for better security.
You can specify the user using the following formats. If specifying a UID or\n GID, you must specify it as a positive integer.
\n user\n
\n user:group\n
\n uid\n
\n uid:gid\n
\n user:gi\n
\n uid:group\n
This parameter is not supported for Windows containers.
\nContainer properties are used for Amazon ECS-based job definitions. These properties to describe\n the container that's launched as part of a job.
" + } + }, + "com.amazonaws.batch#TaskPropertiesOverride": { + "type": "structure", + "members": { + "containers": { + "target": "com.amazonaws.batch#ListTaskContainerOverrides", + "traits": { + "smithy.api#documentation": "The overrides for the container definition of a job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An object that contains overrides for the task definition of a job.
" + } + }, "com.amazonaws.batch#TerminateJob": { "type": "operation", "input": { @@ -6724,7 +7350,7 @@ } ], "traits": { - "smithy.api#documentation": "Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are\n terminated, which causes them to transition to FAILED. Jobs that have not progressed to the\n STARTING state are cancelled.
Terminates a job in a job queue. Jobs that are in the STARTING or\n RUNNING state are terminated, which causes them to transition to\n FAILED. Jobs that have not progressed to the STARTING state are\n cancelled.
A message to attach to the job that explains the reason for canceling it. This message is returned by future\n DescribeJobs operations on the job. This message is also recorded in the Batch activity\n logs.
", + "smithy.api#documentation": "A message to attach to the job that explains the reason for canceling it. This message is\n returned by future DescribeJobs operations on the job. This message is also\n recorded in the Batch activity logs.
", "smithy.api#required": {} } } @@ -6826,7 +7452,7 @@ "target": "com.amazonaws.batch#String", "traits": { "smithy.api#clientOptional": {}, - "smithy.api#documentation": "The type of the ulimit. Valid values are: core | cpu | \n data | fsize | locks | memlock | msgqueue | \n nice | nofile | nproc | rss | rtprio | \n rttime | sigpending | stack.
The type of the ulimit. Valid values are: core |\n cpu | data | fsize | locks |\n memlock | msgqueue | nice | nofile |\n nproc | rss | rtprio | rttime |\n sigpending | stack.
The ulimit settings to pass to the container. For more information, see \n Ulimit.
This object isn't applicable to jobs that are running on Fargate resources.
\nThe ulimit settings to pass to the container. For more information, see Ulimit.
This object isn't applicable to jobs that are running on Fargate resources.
\nThe 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.
" + "smithy.api#documentation": "The maximum number of vCPUs expected to be used for an unmanaged compute environment.\n Don't specify this parameter for a managed compute environment. This parameter is only used\n for fair share scheduling to reserve vCPU capacity for new share identifiers. If this\n parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.
" } }, "computeResources": { "target": "com.amazonaws.batch#ComputeResourceUpdate", "traits": { - "smithy.api#documentation": "Details of the compute resources managed by the compute environment. Required for a managed compute environment.\n For more information, see Compute\n Environments in the Batch User Guide.
" + "smithy.api#documentation": "Details of the compute resources managed by the compute environment. Required for a\n managed compute environment. For more information, see Compute Environments in the\n Batch User Guide.
" } }, "serviceRole": { "target": "com.amazonaws.batch#String", "traits": { - "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf.\n For more information, see Batch service IAM\n role in the Batch User Guide.
\nIf the compute environment has a service-linked role, it can't be changed to use a regular IAM role.\n Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To\n update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see\n Updating compute\n environments in the Batch User Guide.
\nIf your specified role has a path other than /, then you must either specify the full role ARN\n (recommended) or prefix the role name with the path.
Depending on how you created your Batch service role, its ARN might contain the service-role\n path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the\n service-role path prefix. Because of this, we recommend that you specify the full ARN of your service\n role when you create compute environments.
The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services\n services on your behalf. For more information, see Batch service IAM role in the\n Batch User Guide.
\nIf the compute environment has a service-linked role, it can't be changed to use a\n regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't\n be changed to use a service-linked role. To update the parameters for the compute\n environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information,\n see Updating\n compute environments in the Batch User Guide.
\nIf your specified role has a path other than /, then you must either specify\n the full role ARN (recommended) or prefix the role name with the path.
Depending on how you created your Batch service role, its ARN might contain the\n service-role path prefix. When you only specify the name of the service role,\n Batch assumes that your ARN doesn't use the service-role path prefix. Because\n of this, we recommend that you specify the full ARN of your service role when you create\n compute environments.
Specifies the updated 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 updated infrastructure update policy for the compute environment. For more\n information about infrastructure updates, see Updating compute environments in\n the Batch User Guide.
" } } }, @@ -7077,25 +7703,25 @@ "state": { "target": "com.amazonaws.batch#JQState", "traits": { - "smithy.api#documentation": "Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept\n jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the\n queue can finish.
Describes the queue's ability to accept new jobs. If the job queue state is\n ENABLED, it can accept jobs. If the job queue state is DISABLED,\n new jobs can't be added to the queue, but jobs already in the queue can finish.
Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can\n be replaced but not removed. 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.
Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share\n scheduling policy can be replaced but not removed. 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 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\n value for the priority parameter) are evaluated first when associated with the\n same compute environment. Priority is determined in descending order. For example, a job queue\n with a priority value of 10 is given scheduling preference over a job queue with\n a priority value of 1. 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.
Details the set of compute environments mapped to a job queue and their order relative to each other. This is\n one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute\n environments must be in the VALID state before you can associate them with a job queue. All of\n the compute environments must be either EC2 (EC2 or SPOT) or Fargate\n (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\n support mixing compute environment architecture types in a single job queue.
\nDetails the set of compute environments mapped to a job queue and their order relative to\n each other. This is one of the parameters used by the job scheduler to determine which compute\n environment runs a given job. Compute environments must be in the VALID state\n before you can associate them with a job queue. All of the compute environments must be either\n EC2 (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\n single job queue.
\n