Module types

Data structures used by operation inputs/outputs.

Modules

• builders
  Builders
• error
  Error types that AWS Batch can respond with.

Structs

• ArrayProperties

  An object that represents an Batch array job.

• ArrayPropertiesDetail

  An object that represents the array properties of a job.

• ArrayPropertiesSummary

  An object that represents the array properties of a job.

• AttemptContainerDetail

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

• AttemptDetail

  An object that represents a job attempt.

• AttemptEcsTaskDetails

  An object that represents the details of a task.

• AttemptTaskContainerDetails

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

• ComputeEnvironmentDetail

  An object that represents an Batch compute environment.

• ComputeEnvironmentOrder

  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.

• ComputeResource

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

• ComputeResourceUpdate

  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.

• ContainerDetail

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

• ContainerOverrides

  The overrides that should be sent to a container.

  For information about using Batch overrides when you connect event sources to targets, see BatchContainerOverrides.

• ContainerProperties

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

• ContainerSummary

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

• Device

  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.

• Ec2Configuration

  Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 (Amazon Linux 2).

  This object isn't applicable to jobs that are running on Fargate resources.

• EcsProperties

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

• EcsPropertiesDetail

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

• EcsPropertiesOverride

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

• EcsTaskDetails

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

• EcsTaskProperties

  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.

• EfsAuthorizationConfig

  The authorization configuration details for the Amazon EFS file system.

• EfsVolumeConfiguration

  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.

• EksAttemptContainerDetail

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

• EksAttemptDetail

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

• EksConfiguration

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

• EksContainer

  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.

• EksContainerDetail

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

• EksContainerEnvironmentVariable

  An environment variable.

• EksContainerOverride

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

• EksContainerResourceRequirements

  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.

• EksContainerSecurityContext

  The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

• EksContainerVolumeMount

  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.

• EksEmptyDir

  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.

• EksHostPath

  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.

• EksMetadata

  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.

• EksPersistentVolumeClaim

  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.

• EksPodProperties

  The properties for the pod.

• EksPodPropertiesDetail

  The details for the pod.

• EksPodPropertiesOverride

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

• EksProperties

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

• EksPropertiesDetail

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

• EksPropertiesOverride

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

• EksSecret

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

• EksVolume

  Specifies an Amazon EKS volume for a job definition.

• EphemeralStorage

  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.

• EvaluateOnExit

  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.

• FairsharePolicy

  The fair share policy for a scheduling policy.

• FargatePlatformConfiguration

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

• FrontOfQueueDetail

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

• FrontOfQueueJobSummary

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

• Host

  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.

• ImagePullSecret

  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.

• JobDefinition

  An object that represents an Batch job definition.

• JobDependency

  An object that represents an Batch job dependency.

• JobDetail

  An object that represents an Batch job.

• JobQueueDetail

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

• JobStateTimeLimitAction

  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.

• JobSummary

  An object that represents summary details of a job.

• JobTimeout

  An object that represents a job timeout configuration.

• KeyValuePair

  A key-value pair object.

• KeyValuesPair

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

• LaunchTemplateSpecification

  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.

• LaunchTemplateSpecificationOverride

  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.

• LinuxParameters

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

• LogConfiguration

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

• MountPoint

  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.

• NetworkConfiguration

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

• NetworkInterface

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

• NodeDetails

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

• NodeOverrides

  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.

• NodeProperties

  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.

• NodePropertiesSummary

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

• NodePropertyOverride

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

• NodeRangeProperty

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

• RepositoryCredentials

  The repository credentials for private registry authentication.

• ResourceRequirement

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

• RetryStrategy

  The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.

• RuntimePlatform

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

• SchedulingPolicyDetail

  An object that represents a scheduling policy.

• SchedulingPolicyListingDetail

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

• Secret

  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.

• ShareAttributes

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

• TaskContainerDependency

  A list of containers that this task depends on.

• TaskContainerDetails

  The details for the container in this task attempt.

• TaskContainerOverrides

  The overrides that should be sent to a container.

  For information about using Batch overrides when you connect event sources to targets, see BatchContainerOverrides.

• TaskContainerProperties

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

• TaskPropertiesOverride

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

• Tmpfs

  The container path, mount options, and size of the tmpfs mount.

  This object isn't applicable to jobs that are running on Fargate resources.

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

• UpdatePolicy

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

• Volume

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

Enums

• ArrayJobDependency
  When writing a match expression against ArrayJobDependency, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• AssignPublicIp
  When writing a match expression against AssignPublicIp, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CeState
  When writing a match expression against CeState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CeStatus
  When writing a match expression against CeStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CeType
  When writing a match expression against CeType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CrAllocationStrategy
  When writing a match expression against CrAllocationStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CrType
  When writing a match expression against CrType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• CrUpdateAllocationStrategy
  When writing a match expression against CrUpdateAllocationStrategy, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• DeviceCgroupPermission
  When writing a match expression against DeviceCgroupPermission, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EfsAuthorizationConfigIam
  When writing a match expression against EfsAuthorizationConfigIam, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• EfsTransitEncryption
  When writing a match expression against EfsTransitEncryption, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• JobDefinitionType
  When writing a match expression against JobDefinitionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• JobStateTimeLimitActionsAction
  When writing a match expression against JobStateTimeLimitActionsAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• JobStateTimeLimitActionsState
  When writing a match expression against JobStateTimeLimitActionsState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• JobStatus
  When writing a match expression against JobStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• JqState
  When writing a match expression against JqState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• JqStatus
  When writing a match expression against JqStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• LogDriver
  When writing a match expression against LogDriver, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• OrchestrationType
  When writing a match expression against OrchestrationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• PlatformCapability
  When writing a match expression against PlatformCapability, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• ResourceType
  When writing a match expression against ResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
• RetryAction
  When writing a match expression against RetryAction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.