Module Awso_batch_lwtSource

An object that represents a container instance host device. This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

The container path, mount options, and size of the tmpfs mount. This object isn't applicable to jobs that are running on Fargate resources.

An object that represents the secret to expose to your container. Secrets can be exposed to a container in the following ways: To inject sensitive data into your containers as environment variables, use the secrets container definition parameter. To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter. For more information, see Specifying sensitive data in the Batch User Guide.

A key-value pair object.

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 --volume option to docker run.

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

A list of containers that this task depends on.

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 authorization configuration details for the Amazon EFS file system.

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom log routing in the Amazon Elastic Container Service Developer Guide.

Linux-specific modifications that are applied to the container, such as details for device mappings.

Log configuration options to send to a custom log driver for the container.

The repository credentials for private registry authentication.

This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the Batch User Guide.

Determine whether your data volume persists on the host container instance and where it's stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

This is used when you're using an S3Files file system for job storage.

An environment variable.

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.

An object that represents the elastic network interface for a multi-node parallel job node.

Container properties are used for Amazon ECS-based job definitions. These properties to describe the container that's launched as part of a job.

A data volume that's used in a job's container properties.

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 security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir volume is first created when a pod is assigned to a node. It exists as long as that pod is running on that node. The emptyDir volume is initially empty. All containers in the pod can read and write the files in the emptyDir volume. However, the emptyDir volume can be mounted at the same or different paths in each container. When a pod is removed from a node for any reason, the data in the emptyDir is deleted permanently. For more information, see emptyDir in the Kubernetes documentation.

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.

A persistentVolumeClaim volume is used to mount a PersistentVolume into a Pod. PersistentVolumeClaims are a way for users to "claim" durable storage without knowing the details of the particular cloud environment. See the information about PersistentVolumes in the Kubernetes documentation.

Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

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.

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

An object that represents the compute environment architecture for Batch jobs on Fargate.

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.

Specifies an Amazon EKS volume for a job definition.

References a Kubernetes secret resource. This name of the secret must start and end with an alphanumeric character, is required to be lowercase, can include periods (.) and hyphens (-), and can't contain more than 253 characters.

The overrides that should be sent to a container. For information about using Batch overrides when you connect event sources to targets, see BatchContainerOverrides.

An object that represents the details of a container that's part of a job attempt.

Information about a consumable resource required to run a job.

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.

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.

Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.

The details for the container in this task attempt.

The platform configuration for jobs that are running on Fargate resources. Jobs that run on Amazon EC2 resources must not specify this parameter.

The properties for the pod.

An object that contains overrides for the task definition of a job.

The capacity usage for a fairshare scheduling job queue.

The capacity usage for a quota share, including units of compute capacity and quantity of resources being used.

An object that represents the details of a task.

An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.

The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS.

Contains a list of consumable resources required by a job.

Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.

An object that contains the properties for the Amazon ECS resources of a job.

An object that contains the properties for the Kubernetes resources of a job.

An object that represents a launch template to use in place of the default launch template. You must specify either the launch template ID or launch template name in the request, but not both. If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used. You can define up to ten (10) overrides for each compute environment. This object isn't applicable to jobs that are running on Fargate resources. To unset all override templates for a compute environment, you can pass an empty array to the UpdateComputeEnvironment.overrides parameter, or not include the overrides parameter when submitting the UpdateComputeEnvironment API operation.

An object that contains overrides for the Kubernetes pod properties of a job.

Specifies the weights for the share identifiers for the fair-share policy. Share identifiers that aren't included have a default weight of 1.0.

An object that represents the details of a container that's part of a job attempt.

The details of a task definition that describes the container and volume definitions of an Amazon ECS task.

This is an object that represents the properties of the node range for a multi-node parallel job.

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.

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2023 (Amazon ECS-optimized Amazon Linux 2023) for EC2 (ECS) compute environments and EKS_AL2023 (Amazon EKS-optimized Amazon Linux 2023 AMI) for EKS compute environments. This object isn't applicable to jobs that are running on Fargate resources.

The overrides that should be sent to a container. For information about using Batch overrides when you connect event sources to targets, see BatchContainerOverrides.

An object that contains overrides for the Amazon ECS task definition of a job.

An object that contains overrides for the Kubernetes resources of a job.

The Batch unique identifier.

The capacity usage for a service job, including the unit of measure and quantity of resources being used.

Defines the capacity limit for a quota share, or the type and maximum quantity of a particular resource that can be allocated to jobs in the quota share without borrowing.

The capacity usage for a job, including the unit of measure and quantity of resources being used.

An object that represents summary details for the first RUNNABLE job in a quota share.

The capacity utilization for a specific share in a fairshare scheduling job queue, including the share identifier and its current usage.

The capacity utilization for a specific quota share, including the quota share name and its current usage.

Defines the type and maximum quantity of resources that can be allocated to service jobs in a service environment.

An object that represents a job attempt.

An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.

The details for the pod.

An object that represents an Batch job dependency.

The order that compute environments are tried in for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); 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 job queue.

Specifies an action that Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

Specifies the order of a service environment for a job queue. This determines the priority order when multiple service environments are associated with the same job queue.

An object that represents a scaling policy for a compute environment.

An object that represents a launch template that's associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both. If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used. This object isn't applicable to jobs that are running on Fargate resources.

Specifies conditions for when to exit or retry a service job based on the exit status or status reason.

The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.

Information about the latest attempt of a service job. A Service job can transition from SCHEDULED back to RUNNABLE state when they encounter capacity constraints.

Specifies the preemption behavior for jobs in a quota share.

Specifies whether a quota share reserves, lends, or both lends and borrows idle compute capacity.

An object that represents the array properties of a job.

An object that represents summary details of a container within a job.

An object that represents the properties of a node that's associated with a multi-node parallel job.

An object that represents summary details for the first 100 RUNNABLE jobs in a job queue.

The configured capacity usage for a job queue snapshot, including the unit of measure and quantity of resources being used.

Detailed information about a preempted attempt of a service job.

The fair-share scheduling policy details.

The quota share scheduling policy details for a job queue.

An object that represents the array properties of a job.

An object that represents the details of a container that's part of a job.

An object that contains the details for the Amazon ECS resources of a job.

An object that contains the details for the Kubernetes resources of a job.

An object that represents a job timeout configuration.

An object that represents the details of a multi-node parallel job node.

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 retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.

An object that represents an Batch compute resource. For more information, see Compute environments in the Batch User Guide.

Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before the compute environment can be created.

Specifies the infrastructure update policy for the Amazon EC2 compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

Summary information about a service job.

A filter name and value pair that's used to return a more specific list of results from a ListJobs or ListJobsByConsumableResource API operation.

An object that contains the details of a scheduling policy that's returned in a ListSchedulingPolicy action.

Detailed information about a quota share, including its configuration, state, and capacity limits.

An object that represents summary details of a job.

Current information about a consumable resource required by a job.

Current information about a consumable resource.

The fairshare utilization for a job queue, including the number of active shares and top capacity utilization.

An object that represents the capacity utilization details of all quota shares associated with a single job queue.

Detailed information about an attempt to run a service job.

The capacity usage for a service job, including the unit of measure and quantity of resources being consumed.

Detailed information about a service environment, including its configuration, state, and capacity limits.

An object that represents a scheduling policy.

An object that represents an Batch job.

An object that represents the details for an Batch job queue.

An object that represents an Batch job definition.

An object that represents an Batch compute environment.

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

These errors are usually caused by a server issue.

An object that represents the attributes of a compute environment that can be updated. For more information, see Updating compute environments in the Batch User Guide.

Specifies the service job behavior when preempted.

The retry strategy for service jobs. This defines how many times to retry a failed service job and under what conditions. For more information, see Service job retry strategies in the Batch User Guide.

The timeout configuration for service jobs.

An object that represents an Batch array job.

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.

Contains a list of the first 100 RUNNABLE jobs associated to a single job queue.

An object that represents the details of the first RUNNABLE job in each named quota share associated with a single job queue.

The job queue utilization at a specific point in time, including total capacity usage, and quota share or fairshare utilization breakdown depending on the job queue scheduling policy.

Summarizes the preemptions of the service job. This field appears on a service job when it has been preempted.

Updates the priority of a specified service job in an Batch job queue.

Updates the priority of a specified service job in an Batch job queue.

Updates a service environment. You can update the state of a service environment from ENABLED to DISABLED to prevent new service jobs from being placed in the service environment.

Updates a service environment. You can update the state of a service environment from ENABLED to DISABLED to prevent new service jobs from being placed in the service environment.

Updates a scheduling policy.

Contains the parameters for UpdateSchedulingPolicy.

Updates a quota share.

Updates a quota share.

Updates a job queue.

Contains the parameters for UpdateJobQueue.

Updates a consumable resource.

Updates a consumable resource.

Updates an Batch compute environment.

Contains the parameters for UpdateComputeEnvironment.

Deletes specified tags from an Batch resource.

Contains the parameters for UntagResource.

Terminates a service job in a job queue.

Terminates a service job in a job queue.

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.

Contains the parameters for TerminateJob.

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.

Contains the parameters for TagResource.

Submits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.

Submits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.

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 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.

Contains the parameters for SubmitJob.

Registers an Batch job definition.

Contains the parameters for RegisterJobDefinition.

Lists the tags for an Batch resource. 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.

Contains the parameters for ListTagsForResource.

Returns a list of service jobs for a specified job queue.

Returns a list of service jobs for a specified job queue.

Returns a list of Batch scheduling policies.

Contains the parameters for ListSchedulingPolicies.

Returns a list of Batch quota shares associated with a job queue.

Returns a list of Batch quota shares associated with a job queue.

Returns a list of Batch jobs. You must specify only one of the following items: A job queue ID to return a list of jobs in that job queue A multi-node parallel job ID to return a list of nodes for that job An array job ID to return a list of the children for that job

Contains the parameters for ListJobs.

Returns a list of Batch jobs that require a specific consumable resource.

Returns a list of Batch jobs that require a specific consumable resource.

Returns a list of Batch consumable resources.

Returns a list of Batch consumable resources.

Provides a snapshot of job queue state, including ordering of RUNNABLE jobs, as well as capacity utilization for already dispatched jobs. The first 100 RUNNABLE jobs in the job queue are listed in order of dispatch. For job queues with an attached quota-share policy, the first RUNNABLE job in each quota share is also listed. Capacity utilization for the job queue is provided, as well as break downs by share for job queues with attached fair-share or quota-share scheduling policies.

Provides a snapshot of job queue state, including ordering of RUNNABLE jobs, as well as capacity utilization for already dispatched jobs. The first 100 RUNNABLE jobs in the job queue are listed in order of dispatch. For job queues with an attached quota-share policy, the first RUNNABLE job in each quota share is also listed. Capacity utilization for the job queue is provided, as well as break downs by share for job queues with attached fair-share or quota-share scheduling policies.

The details of a service job.

The details of a service job.

Describes one or more of your service environments.

Describes one or more of your service environments.

Describes one or more of your scheduling policies.

Contains the parameters for DescribeSchedulingPolicies.

Returns a description of the specified quota share.

Returns a description of the specified quota share.

Describes a list of Batch jobs.

Contains the parameters for DescribeJobs.

Describes one or more of your job queues.

Contains the parameters for DescribeJobQueues.

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

Contains the parameters for DescribeJobDefinitions.

Returns a description of the specified consumable resource.

Returns a description of the specified consumable resource.

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.

Contains the parameters for DescribeComputeEnvironments.

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.

Deletes a Service environment. Before you can delete a service environment, you must first set its state to DISABLED with the UpdateServiceEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.

Deletes a Service environment. Before you can delete a service environment, you must first set its state to DISABLED with the UpdateServiceEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.

Deletes the specified scheduling policy. You can't delete a scheduling policy that's used in any job queues.

Contains the parameters for DeleteSchedulingPolicy.

Deletes the specified quota share. You must first disable submissions for the share by updating the state to DISABLED using the UpdateQuotaShare operation. All jobs in the share are eventually terminated when you delete a quota share.

Deletes the specified quota share. You must first disable submissions for the share by updating the state to DISABLED using the UpdateQuotaShare operation. All jobs in the share are eventually terminated when you delete a quota share.

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. It's not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

Contains the parameters for DeleteJobQueue.

Deletes the specified consumable resource.

Deletes the specified consumable resource.

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.

Contains the parameters for DeleteComputeEnvironment.

Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.

Creates a service environment for running service jobs. Service environments define capacity limits for specific service types such as SageMaker Training jobs.

Creates an Batch scheduling policy.

Contains the parameters for CreateSchedulingPolicy.

Creates an Batch quota share. Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

Creates an Batch quota share. Each quota share operates as a virtual queue with a configured compute capacity, resource sharing strategy, and borrow limits.

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.

Contains the parameters for CreateJobQueue.

Creates an Batch consumable resource.

Creates an Batch consumable resource.

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. 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. Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For more information on how to update a compute environment's AMI, see Updating compute environments in the Batch User Guide.

Contains the parameters for CreateComputeEnvironment.

Cancels a job in an Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE state are cancelled and the job status is updated to FAILED. A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING status. When you try to cancel an array parent job in PENDING, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed. Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

Contains the parameters for CancelJob.