# Packages
Package batchiface provides an interface to enable mocking the AWS Batch service client for testing your code.
# Functions
ArrayJobDependency_Values returns all elements of the ArrayJobDependency enum.
AssignPublicIp_Values returns all elements of the AssignPublicIp enum.
CEState_Values returns all elements of the CEState enum.
CEStatus_Values returns all elements of the CEStatus enum.
CEType_Values returns all elements of the CEType enum.
CRAllocationStrategy_Values returns all elements of the CRAllocationStrategy enum.
CRType_Values returns all elements of the CRType enum.
CRUpdateAllocationStrategy_Values returns all elements of the CRUpdateAllocationStrategy enum.
DeviceCgroupPermission_Values returns all elements of the DeviceCgroupPermission enum.
EFSAuthorizationConfigIAM_Values returns all elements of the EFSAuthorizationConfigIAM enum.
EFSTransitEncryption_Values returns all elements of the EFSTransitEncryption enum.
JobDefinitionType_Values returns all elements of the JobDefinitionType enum.
JobStateTimeLimitActionsAction_Values returns all elements of the JobStateTimeLimitActionsAction enum.
JobStateTimeLimitActionsState_Values returns all elements of the JobStateTimeLimitActionsState enum.
JobStatus_Values returns all elements of the JobStatus enum.
JQState_Values returns all elements of the JQState enum.
JQStatus_Values returns all elements of the JQStatus enum.
LogDriver_Values returns all elements of the LogDriver enum.
New creates a new instance of the Batch client with a session.
OrchestrationType_Values returns all elements of the OrchestrationType enum.
PlatformCapability_Values returns all elements of the PlatformCapability enum.
ResourceType_Values returns all elements of the ResourceType enum.
RetryAction_Values returns all elements of the RetryAction enum.
# Constants
ArrayJobDependencyNToN is a ArrayJobDependency enum value.
ArrayJobDependencySequential is a ArrayJobDependency enum value.
AssignPublicIpDisabled is a AssignPublicIp enum value.
AssignPublicIpEnabled is a AssignPublicIp enum value.
CEStateDisabled is a CEState enum value.
CEStateEnabled is a CEState enum value.
CEStatusCreating is a CEStatus enum value.
CEStatusDeleted is a CEStatus enum value.
CEStatusDeleting is a CEStatus enum value.
CEStatusInvalid is a CEStatus enum value.
CEStatusUpdating is a CEStatus enum value.
CEStatusValid is a CEStatus enum value.
CETypeManaged is a CEType enum value.
CETypeUnmanaged is a CEType enum value.
CRAllocationStrategyBestFit is a CRAllocationStrategy enum value.
CRAllocationStrategyBestFitProgressive is a CRAllocationStrategy enum value.
CRAllocationStrategySpotCapacityOptimized is a CRAllocationStrategy enum value.
CRAllocationStrategySpotPriceCapacityOptimized is a CRAllocationStrategy enum value.
CRTypeEc2 is a CRType enum value.
CRTypeFargate is a CRType enum value.
CRTypeFargateSpot is a CRType enum value.
CRTypeSpot is a CRType enum value.
CRUpdateAllocationStrategyBestFitProgressive is a CRUpdateAllocationStrategy enum value.
CRUpdateAllocationStrategySpotCapacityOptimized is a CRUpdateAllocationStrategy enum value.
CRUpdateAllocationStrategySpotPriceCapacityOptimized is a CRUpdateAllocationStrategy enum value.
DeviceCgroupPermissionMknod is a DeviceCgroupPermission enum value.
DeviceCgroupPermissionRead is a DeviceCgroupPermission enum value.
DeviceCgroupPermissionWrite is a DeviceCgroupPermission enum value.
EFSAuthorizationConfigIAMDisabled is a EFSAuthorizationConfigIAM enum value.
EFSAuthorizationConfigIAMEnabled is a EFSAuthorizationConfigIAM enum value.
EFSTransitEncryptionDisabled is a EFSTransitEncryption enum value.
EFSTransitEncryptionEnabled is a EFSTransitEncryption enum value.
ID to lookup a service endpoint with.
ErrCodeClientException for service response error code "ClientException".
ErrCodeServerException for service response error code "ServerException".
JobDefinitionTypeContainer is a JobDefinitionType enum value.
JobDefinitionTypeMultinode is a JobDefinitionType enum value.
JobStateTimeLimitActionsActionCancel is a JobStateTimeLimitActionsAction enum value.
JobStateTimeLimitActionsStateRunnable is a JobStateTimeLimitActionsState enum value.
JobStatusFailed is a JobStatus enum value.
JobStatusPending is a JobStatus enum value.
JobStatusRunnable is a JobStatus enum value.
JobStatusRunning is a JobStatus enum value.
JobStatusStarting is a JobStatus enum value.
JobStatusSubmitted is a JobStatus enum value.
JobStatusSucceeded is a JobStatus enum value.
JQStateDisabled is a JQState enum value.
JQStateEnabled is a JQState enum value.
JQStatusCreating is a JQStatus enum value.
JQStatusDeleted is a JQStatus enum value.
JQStatusDeleting is a JQStatus enum value.
JQStatusInvalid is a JQStatus enum value.
JQStatusUpdating is a JQStatus enum value.
JQStatusValid is a JQStatus enum value.
LogDriverAwslogs is a LogDriver enum value.
LogDriverFluentd is a LogDriver enum value.
LogDriverGelf is a LogDriver enum value.
LogDriverJournald is a LogDriver enum value.
LogDriverJsonFile is a LogDriver enum value.
LogDriverSplunk is a LogDriver enum value.
LogDriverSyslog is a LogDriver enum value.
OrchestrationTypeEcs is a OrchestrationType enum value.
OrchestrationTypeEks is a OrchestrationType enum value.
PlatformCapabilityEc2 is a PlatformCapability enum value.
PlatformCapabilityFargate is a PlatformCapability enum value.
ResourceTypeGpu is a ResourceType enum value.
ResourceTypeMemory is a ResourceType enum value.
ResourceTypeVcpu is a ResourceType enum value.
RetryActionExit is a RetryAction enum value.
RetryActionRetry is a RetryAction enum value.
ServiceID is a unique identifier of a specific service.
Name of service.
# Structs
An object that represents an Batch array job.
An object that represents the array properties of a job.
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 attempt.
An object that represents a job attempt.
An object that represents the details of a task.
An object that represents the details of a container that's part of a job attempt.
Batch provides the API operation methods for making requests to AWS Batch.
Contains the parameters for CancelJob.
These errors are usually caused by a client action.
An object that represents an Batch compute environment.
The order that compute environments are tried in for job placement within a queue.
An object that represents an Batch compute resource.
An object that represents the attributes of a compute environment that can be updated.
An object that represents the details of a container that's part of a job.
The overrides that should be sent to a container.
Container properties are used for Amazon ECS based job definitions.
An object that represents summary details of a container within a job.
Contains the parameters for CreateComputeEnvironment.
Contains the parameters for CreateJobQueue.
Contains the parameters for CreateSchedulingPolicy.
Contains the parameters for DeleteComputeEnvironment.
Contains the parameters for DeleteJobQueue.
Contains the parameters for DeleteSchedulingPolicy.
Contains the parameters for DescribeComputeEnvironments.
Contains the parameters for DescribeJobDefinitions.
Contains the parameters for DescribeJobQueues.
Contains the parameters for DescribeJobs.
Contains the parameters for DescribeSchedulingPolicies.
An object that represents a container instance host device.
Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment.
An object that contains the properties for the Amazon ECS resources of a job.
An object that contains the details for the Amazon ECS resources of a job.
An object that contains overrides for the Amazon ECS task definition of a job.
The details of a task definition that describes the container and volume definitions of an Amazon ECS task.
The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.
The authorization configuration details for the Amazon EFS file system.
This is used when you're using an Amazon Elastic File System file system for job storage.
An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.
An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.
Configuration for the Amazon EKS cluster that supports the Batch compute environment.
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.
The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS.
An environment variable.
Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob (https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html) API operation.
The type and amount of resources to assign to a container.
The security context for a job.
The volume mounts for a container for an Amazon EKS job.
Specifies the configuration of a Kubernetes emptyDir volume.
Specifies the configuration of a Kubernetes hostPath volume.
Describes and uniquely identifies Kubernetes resources.
The properties for the pod.
The details for the pod.
An object that contains overrides for the Kubernetes pod properties of a job.
An object that contains the properties for the Kubernetes resources of a job.
An object that contains the details for the Kubernetes resources of a job.
An object that contains overrides for the Kubernetes resources of a job.
Specifies the configuration of a Kubernetes secret volume.
Specifies an Amazon EKS volume for a job definition.
The amount of ephemeral storage to allocate for the task.
Specifies an array of up to 5 conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met.
The fair share policy for a scheduling policy.
The platform configuration for jobs that are running on Fargate resources.
Contains a list of the first 100 RUNNABLE jobs associated to a single job queue.
An object that represents summary details for the first 100 RUNNABLE jobs in a job queue.
Determine whether your data volume persists on the host container instance and where it's stored.
References a Kubernetes secret resource.
An object that represents an Batch job definition.
An object that represents an Batch job dependency.
An object that represents an Batch job.
An object that represents the details for an Batch 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.
An object that represents summary details of a job.
An object that represents a job timeout configuration.
A key-value pair object.
A filter name and value pair that's used to return a more specific list of results from a ListJobs API operation.
An object that represents a launch template that's associated with a compute resource.
Linux-specific modifications that are applied to the container, such as details for device mappings.
Contains the parameters for ListJobs.
Contains the parameters for ListSchedulingPolicies.
Contains the parameters for ListTagsForResource.
Log configuration options to send to a custom log driver for the container.
Details for a Docker volume mount point that's used in a job's container properties.
The network configuration for jobs that are running on Fargate resources.
An object that represents the elastic network interface for a multi-node parallel job node.
An object that represents the details of a multi-node parallel job node.
An object that represents any node overrides to a job definition that's used in a SubmitJob (https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html) API operation.
An object that represents the node properties of a multi-node parallel job.
An object that represents the properties of a node that's associated with a multi-node parallel job.
The object that represents any node overrides to a job definition that's used in a SubmitJob (https://docs.aws.amazon.com/batch/latest/APIReference/API_SubmitJob.html) API operation.
This is an object that represents the properties of the node range for a multi-node parallel job.
Contains the parameters for RegisterJobDefinition.
The repository credentials for private registry authentication.
The type and amount of a resource to assign to a container.
The retry strategy that's associated with a job.
An object that represents the compute environment architecture for Batch jobs on Fargate.
An object that represents a scheduling policy.
An object that contains the details of a scheduling policy that's returned in a ListSchedulingPolicy action.
An object that represents the secret to expose to your container.
These errors are usually caused by a server issue.
Specifies the weights for the fair share identifiers for the fair share policy.
Contains the parameters for SubmitJob.
Contains the parameters for TagResource.
A list of containers that this task depends on.
The details for the container in this task attempt.
The overrides that should be sent to a container.
Container properties are used for Amazon ECS-based job definitions.
An object that contains overrides for the task definition of a job.
Contains the parameters for TerminateJob.
The container path, mount options, and size of the tmpfs mount.
The ulimit settings to pass to the container.
Contains the parameters for UntagResource.
Contains the parameters for UpdateComputeEnvironment.
Contains the parameters for UpdateJobQueue.
Specifies the infrastructure update policy for the compute environment.
Contains the parameters for UpdateSchedulingPolicy.
A data volume that's used in a job's container properties.