| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Batch.Types
Contents
- Service Configuration
- Errors
- ArrayJobDependency
- CEState
- CEStatus
- CEType
- CRType
- JQState
- JQStatus
- JobDefinitionType
- JobStatus
- ArrayProperties
- ArrayPropertiesDetail
- ArrayPropertiesSummary
- AttemptContainerDetail
- AttemptDetail
- ComputeEnvironmentDetail
- ComputeEnvironmentOrder
- ComputeResource
- ComputeResourceUpdate
- ContainerDetail
- ContainerOverrides
- ContainerProperties
- ContainerSummary
- Host
- JobDefinition
- JobDependency
- JobDetail
- JobQueueDetail
- JobSummary
- JobTimeout
- KeyValuePair
- MountPoint
- RetryStrategy
- Ulimit
- Volume
Description
- batch :: Service
- _ServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ClientException :: AsError a => Getting (First ServiceError) a ServiceError
- data ArrayJobDependency
- = NToN
- | Sequential
- data CEState
- data CEStatus
- data CEType
- data CRType
- data JQState
- data JQStatus
- data JobDefinitionType = Container
- data JobStatus
- data ArrayProperties
- arrayProperties :: ArrayProperties
- apSize :: Lens' ArrayProperties (Maybe Int)
- data ArrayPropertiesDetail
- arrayPropertiesDetail :: ArrayPropertiesDetail
- apdSize :: Lens' ArrayPropertiesDetail (Maybe Int)
- apdStatusSummary :: Lens' ArrayPropertiesDetail (HashMap Text Int)
- apdIndex :: Lens' ArrayPropertiesDetail (Maybe Int)
- data ArrayPropertiesSummary
- arrayPropertiesSummary :: ArrayPropertiesSummary
- apsSize :: Lens' ArrayPropertiesSummary (Maybe Int)
- apsIndex :: Lens' ArrayPropertiesSummary (Maybe Int)
- data AttemptContainerDetail
- attemptContainerDetail :: AttemptContainerDetail
- acdTaskARN :: Lens' AttemptContainerDetail (Maybe Text)
- acdContainerInstanceARN :: Lens' AttemptContainerDetail (Maybe Text)
- acdReason :: Lens' AttemptContainerDetail (Maybe Text)
- acdLogStreamName :: Lens' AttemptContainerDetail (Maybe Text)
- acdExitCode :: Lens' AttemptContainerDetail (Maybe Int)
- data AttemptDetail
- attemptDetail :: AttemptDetail
- adStoppedAt :: Lens' AttemptDetail (Maybe Integer)
- adStartedAt :: Lens' AttemptDetail (Maybe Integer)
- adContainer :: Lens' AttemptDetail (Maybe AttemptContainerDetail)
- adStatusReason :: Lens' AttemptDetail (Maybe Text)
- data ComputeEnvironmentDetail
- computeEnvironmentDetail :: Text -> Text -> Text -> ComputeEnvironmentDetail
- cedStatus :: Lens' ComputeEnvironmentDetail (Maybe CEStatus)
- cedState :: Lens' ComputeEnvironmentDetail (Maybe CEState)
- cedComputeResources :: Lens' ComputeEnvironmentDetail (Maybe ComputeResource)
- cedStatusReason :: Lens' ComputeEnvironmentDetail (Maybe Text)
- cedType :: Lens' ComputeEnvironmentDetail (Maybe CEType)
- cedServiceRole :: Lens' ComputeEnvironmentDetail (Maybe Text)
- cedComputeEnvironmentName :: Lens' ComputeEnvironmentDetail Text
- cedComputeEnvironmentARN :: Lens' ComputeEnvironmentDetail Text
- cedEcsClusterARN :: Lens' ComputeEnvironmentDetail Text
- data ComputeEnvironmentOrder
- computeEnvironmentOrder :: Int -> Text -> ComputeEnvironmentOrder
- ceoOrder :: Lens' ComputeEnvironmentOrder Int
- ceoComputeEnvironment :: Lens' ComputeEnvironmentOrder Text
- data ComputeResource
- computeResource :: CRType -> Int -> Int -> Text -> ComputeResource
- crEc2KeyPair :: Lens' ComputeResource (Maybe Text)
- crBidPercentage :: Lens' ComputeResource (Maybe Int)
- crSpotIAMFleetRole :: Lens' ComputeResource (Maybe Text)
- crImageId :: Lens' ComputeResource (Maybe Text)
- crDesiredvCPUs :: Lens' ComputeResource (Maybe Int)
- crTags :: Lens' ComputeResource (HashMap Text Text)
- crType :: Lens' ComputeResource CRType
- crMinvCPUs :: Lens' ComputeResource Int
- crMaxvCPUs :: Lens' ComputeResource Int
- crInstanceTypes :: Lens' ComputeResource [Text]
- crSubnets :: Lens' ComputeResource [Text]
- crSecurityGroupIds :: Lens' ComputeResource [Text]
- crInstanceRole :: Lens' ComputeResource Text
- data ComputeResourceUpdate
- computeResourceUpdate :: ComputeResourceUpdate
- cruMinvCPUs :: Lens' ComputeResourceUpdate (Maybe Int)
- cruMaxvCPUs :: Lens' ComputeResourceUpdate (Maybe Int)
- cruDesiredvCPUs :: Lens' ComputeResourceUpdate (Maybe Int)
- data ContainerDetail
- containerDetail :: ContainerDetail
- cdImage :: Lens' ContainerDetail (Maybe Text)
- cdCommand :: Lens' ContainerDetail [Text]
- cdEnvironment :: Lens' ContainerDetail [KeyValuePair]
- cdTaskARN :: Lens' ContainerDetail (Maybe Text)
- cdUlimits :: Lens' ContainerDetail [Ulimit]
- cdContainerInstanceARN :: Lens' ContainerDetail (Maybe Text)
- cdPrivileged :: Lens' ContainerDetail (Maybe Bool)
- cdJobRoleARN :: Lens' ContainerDetail (Maybe Text)
- cdMemory :: Lens' ContainerDetail (Maybe Int)
- cdUser :: Lens' ContainerDetail (Maybe Text)
- cdReason :: Lens' ContainerDetail (Maybe Text)
- cdLogStreamName :: Lens' ContainerDetail (Maybe Text)
- cdMountPoints :: Lens' ContainerDetail [MountPoint]
- cdExitCode :: Lens' ContainerDetail (Maybe Int)
- cdVcpus :: Lens' ContainerDetail (Maybe Int)
- cdReadonlyRootFilesystem :: Lens' ContainerDetail (Maybe Bool)
- cdVolumes :: Lens' ContainerDetail [Volume]
- data ContainerOverrides
- containerOverrides :: ContainerOverrides
- coCommand :: Lens' ContainerOverrides [Text]
- coEnvironment :: Lens' ContainerOverrides [KeyValuePair]
- coMemory :: Lens' ContainerOverrides (Maybe Int)
- coVcpus :: Lens' ContainerOverrides (Maybe Int)
- data ContainerProperties
- containerProperties :: Text -> Int -> Int -> ContainerProperties
- cpCommand :: Lens' ContainerProperties [Text]
- cpEnvironment :: Lens' ContainerProperties [KeyValuePair]
- cpUlimits :: Lens' ContainerProperties [Ulimit]
- cpPrivileged :: Lens' ContainerProperties (Maybe Bool)
- cpJobRoleARN :: Lens' ContainerProperties (Maybe Text)
- cpUser :: Lens' ContainerProperties (Maybe Text)
- cpMountPoints :: Lens' ContainerProperties [MountPoint]
- cpReadonlyRootFilesystem :: Lens' ContainerProperties (Maybe Bool)
- cpVolumes :: Lens' ContainerProperties [Volume]
- cpImage :: Lens' ContainerProperties Text
- cpVcpus :: Lens' ContainerProperties Int
- cpMemory :: Lens' ContainerProperties Int
- data ContainerSummary
- containerSummary :: ContainerSummary
- csReason :: Lens' ContainerSummary (Maybe Text)
- csExitCode :: Lens' ContainerSummary (Maybe Int)
- data Host
- host :: Host
- hSourcePath :: Lens' Host (Maybe Text)
- data JobDefinition
- jobDefinition :: Text -> Text -> Int -> Text -> JobDefinition
- jddStatus :: Lens' JobDefinition (Maybe Text)
- jddRetryStrategy :: Lens' JobDefinition (Maybe RetryStrategy)
- jddParameters :: Lens' JobDefinition (HashMap Text Text)
- jddTimeout :: Lens' JobDefinition (Maybe JobTimeout)
- jddContainerProperties :: Lens' JobDefinition (Maybe ContainerProperties)
- jddJobDefinitionName :: Lens' JobDefinition Text
- jddJobDefinitionARN :: Lens' JobDefinition Text
- jddRevision :: Lens' JobDefinition Int
- jddType :: Lens' JobDefinition Text
- data JobDependency
- jobDependency :: JobDependency
- jJobId :: Lens' JobDependency (Maybe Text)
- jType :: Lens' JobDependency (Maybe ArrayJobDependency)
- data JobDetail
- jobDetail :: Text -> Text -> Text -> JobStatus -> Integer -> Text -> JobDetail
- jdStoppedAt :: Lens' JobDetail (Maybe Integer)
- jdCreatedAt :: Lens' JobDetail (Maybe Integer)
- jdRetryStrategy :: Lens' JobDetail (Maybe RetryStrategy)
- jdAttempts :: Lens' JobDetail [AttemptDetail]
- jdDependsOn :: Lens' JobDetail [JobDependency]
- jdContainer :: Lens' JobDetail (Maybe ContainerDetail)
- jdParameters :: Lens' JobDetail (HashMap Text Text)
- jdStatusReason :: Lens' JobDetail (Maybe Text)
- jdArrayProperties :: Lens' JobDetail (Maybe ArrayPropertiesDetail)
- jdTimeout :: Lens' JobDetail (Maybe JobTimeout)
- jdJobName :: Lens' JobDetail Text
- jdJobId :: Lens' JobDetail Text
- jdJobQueue :: Lens' JobDetail Text
- jdStatus :: Lens' JobDetail JobStatus
- jdStartedAt :: Lens' JobDetail Integer
- jdJobDefinition :: Lens' JobDetail Text
- data JobQueueDetail
- jobQueueDetail :: Text -> Text -> JQState -> Int -> JobQueueDetail
- jqdStatus :: Lens' JobQueueDetail (Maybe JQStatus)
- jqdStatusReason :: Lens' JobQueueDetail (Maybe Text)
- jqdJobQueueName :: Lens' JobQueueDetail Text
- jqdJobQueueARN :: Lens' JobQueueDetail Text
- jqdState :: Lens' JobQueueDetail JQState
- jqdPriority :: Lens' JobQueueDetail Int
- jqdComputeEnvironmentOrder :: Lens' JobQueueDetail [ComputeEnvironmentOrder]
- data JobSummary
- jobSummary :: Text -> Text -> JobSummary
- jsStoppedAt :: Lens' JobSummary (Maybe Integer)
- jsStatus :: Lens' JobSummary (Maybe JobStatus)
- jsCreatedAt :: Lens' JobSummary (Maybe Integer)
- jsStartedAt :: Lens' JobSummary (Maybe Integer)
- jsContainer :: Lens' JobSummary (Maybe ContainerSummary)
- jsStatusReason :: Lens' JobSummary (Maybe Text)
- jsArrayProperties :: Lens' JobSummary (Maybe ArrayPropertiesSummary)
- jsJobId :: Lens' JobSummary Text
- jsJobName :: Lens' JobSummary Text
- data JobTimeout
- jobTimeout :: JobTimeout
- jtAttemptDurationSeconds :: Lens' JobTimeout (Maybe Int)
- data KeyValuePair
- keyValuePair :: KeyValuePair
- kvpValue :: Lens' KeyValuePair (Maybe Text)
- kvpName :: Lens' KeyValuePair (Maybe Text)
- data MountPoint
- mountPoint :: MountPoint
- mpContainerPath :: Lens' MountPoint (Maybe Text)
- mpSourceVolume :: Lens' MountPoint (Maybe Text)
- mpReadOnly :: Lens' MountPoint (Maybe Bool)
- data RetryStrategy
- retryStrategy :: RetryStrategy
- rsAttempts :: Lens' RetryStrategy (Maybe Int)
- data Ulimit
- ulimit :: Int -> Text -> Int -> Ulimit
- uHardLimit :: Lens' Ulimit Int
- uName :: Lens' Ulimit Text
- uSoftLimit :: Lens' Ulimit Int
- data Volume
- volume :: Volume
- vName :: Lens' Volume (Maybe Text)
- vHost :: Lens' Volume (Maybe Host)
Service Configuration
Errors
_ServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
These errors are usually caused by a server issue.
_ClientException :: AsError a => Getting (First ServiceError) a ServiceError Source #
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid.
ArrayJobDependency
data ArrayJobDependency Source #
Constructors
| NToN | |
| Sequential |
Instances
CEState
Instances
CEStatus
Constructors
| CESCreating | |
| CESDeleted | |
| CESDeleting | |
| CESInvalid | |
| CESUpdating | |
| CESValid |
Instances
CEType
Instances
CRType
Instances
JQState
Constructors
| JQSDisabled | |
| JQSEnabled |
Instances
JQStatus
Instances
JobDefinitionType
data JobDefinitionType Source #
Constructors
| Container |
Instances
JobStatus
Instances
ArrayProperties
data ArrayProperties Source #
An object representing an AWS Batch array job.
See: arrayProperties smart constructor.
arrayProperties :: ArrayProperties Source #
Creates a value of ArrayProperties with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apSize- The size of the array job.
ArrayPropertiesDetail
data ArrayPropertiesDetail Source #
An object representing the array properties of a job.
See: arrayPropertiesDetail smart constructor.
Instances
arrayPropertiesDetail :: ArrayPropertiesDetail Source #
Creates a value of ArrayPropertiesDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apdSize- The size of the array job. This parameter is returned for parent array jobs.apdStatusSummary- A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.apdIndex- The job index within the array that is associated with this job. This parameter is returned for array job children.
apdSize :: Lens' ArrayPropertiesDetail (Maybe Int) Source #
The size of the array job. This parameter is returned for parent array jobs.
apdStatusSummary :: Lens' ArrayPropertiesDetail (HashMap Text Int) Source #
A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.
apdIndex :: Lens' ArrayPropertiesDetail (Maybe Int) Source #
The job index within the array that is associated with this job. This parameter is returned for array job children.
ArrayPropertiesSummary
data ArrayPropertiesSummary Source #
An object representing the array properties of a job.
See: arrayPropertiesSummary smart constructor.
Instances
arrayPropertiesSummary :: ArrayPropertiesSummary Source #
Creates a value of ArrayPropertiesSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apsSize :: Lens' ArrayPropertiesSummary (Maybe Int) Source #
The size of the array job. This parameter is returned for parent array jobs.
apsIndex :: Lens' ArrayPropertiesSummary (Maybe Int) Source #
The job index within the array that is associated with this job. This parameter is returned for children of array jobs.
AttemptContainerDetail
data AttemptContainerDetail Source #
An object representing the details of a container that is part of a job attempt.
See: attemptContainerDetail smart constructor.
Instances
attemptContainerDetail :: AttemptContainerDetail Source #
Creates a value of AttemptContainerDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
acdTaskARN- The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt. Each container attempt receives a task ARN when they reach theSTARTINGstatus.acdContainerInstanceARN- The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.acdReason- A short (255 max characters) human-readable string to provide additional details about a running or stopped container.acdLogStreamName- The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs isawsbatch/job. Each container attempt receives a log stream name when they reach theRUNNINGstatus.acdExitCode- The exit code for the job attempt. A non-zero exit code is considered a failure.
acdTaskARN :: Lens' AttemptContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.
acdContainerInstanceARN :: Lens' AttemptContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.
acdReason :: Lens' AttemptContainerDetail (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
acdLogStreamName :: Lens' AttemptContainerDetail (Maybe Text) Source #
The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is awsbatch/job . Each container attempt receives a log stream name when they reach the RUNNING status.
acdExitCode :: Lens' AttemptContainerDetail (Maybe Int) Source #
The exit code for the job attempt. A non-zero exit code is considered a failure.
AttemptDetail
data AttemptDetail Source #
An object representing a job attempt.
See: attemptDetail smart constructor.
attemptDetail :: AttemptDetail Source #
Creates a value of AttemptDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
adStoppedAt- The Unix time stamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned from theRUNNINGstate to a terminal state, such asSUCCEEDEDorFAILED).adStartedAt- The Unix time stamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned from theSTARTINGstate to theRUNNINGstate).adContainer- Details about the container in this job attempt.adStatusReason- A short, human-readable string to provide additional details about the current status of the job attempt.
adStoppedAt :: Lens' AttemptDetail (Maybe Integer) Source #
The Unix time stamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED ).
adStartedAt :: Lens' AttemptDetail (Maybe Integer) Source #
The Unix time stamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).
adContainer :: Lens' AttemptDetail (Maybe AttemptContainerDetail) Source #
Details about the container in this job attempt.
adStatusReason :: Lens' AttemptDetail (Maybe Text) Source #
A short, human-readable string to provide additional details about the current status of the job attempt.
ComputeEnvironmentDetail
data ComputeEnvironmentDetail Source #
An object representing an AWS Batch compute environment.
See: computeEnvironmentDetail smart constructor.
Instances
computeEnvironmentDetail Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ComputeEnvironmentDetail |
Creates a value of ComputeEnvironmentDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cedStatus- The current status of the compute environment (for example,CREATINGorVALID).cedState- The state of the compute environment. The valid values areENABLEDorDISABLED. AnENABLEDstate indicates that you can register instances with the compute environment and that the associated instances can accept jobs.cedComputeResources- The compute resources defined for the compute environment.cedStatusReason- A short, human-readable string to provide additional details about the current status of the compute environment.cedType- The type of the compute environment.cedServiceRole- The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.cedComputeEnvironmentName- The name of the compute environment.cedComputeEnvironmentARN- The Amazon Resource Name (ARN) of the compute environment.cedEcsClusterARN- The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
cedStatus :: Lens' ComputeEnvironmentDetail (Maybe CEStatus) Source #
The current status of the compute environment (for example, CREATING or VALID ).
cedState :: Lens' ComputeEnvironmentDetail (Maybe CEState) Source #
The state of the compute environment. The valid values are ENABLED or DISABLED . An ENABLED state indicates that you can register instances with the compute environment and that the associated instances can accept jobs.
cedComputeResources :: Lens' ComputeEnvironmentDetail (Maybe ComputeResource) Source #
The compute resources defined for the compute environment.
cedStatusReason :: Lens' ComputeEnvironmentDetail (Maybe Text) Source #
A short, human-readable string to provide additional details about the current status of the compute environment.
cedType :: Lens' ComputeEnvironmentDetail (Maybe CEType) Source #
The type of the compute environment.
cedServiceRole :: Lens' ComputeEnvironmentDetail (Maybe Text) Source #
The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.
cedComputeEnvironmentName :: Lens' ComputeEnvironmentDetail Text Source #
The name of the compute environment.
cedComputeEnvironmentARN :: Lens' ComputeEnvironmentDetail Text Source #
The Amazon Resource Name (ARN) of the compute environment.
cedEcsClusterARN :: Lens' ComputeEnvironmentDetail Text Source #
The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.
ComputeEnvironmentOrder
data ComputeEnvironmentOrder Source #
The order in which compute environments are tried 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.
See: computeEnvironmentOrder smart constructor.
Instances
computeEnvironmentOrder Source #
Arguments
| :: Int | |
| -> Text | |
| -> ComputeEnvironmentOrder |
Creates a value of ComputeEnvironmentOrder with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ceoOrder- The order of the compute environment.ceoComputeEnvironment- The Amazon Resource Name (ARN) of the compute environment.
ceoComputeEnvironment :: Lens' ComputeEnvironmentOrder Text Source #
The Amazon Resource Name (ARN) of the compute environment.
ComputeResource
data ComputeResource Source #
An object representing an AWS Batch compute resource.
See: computeResource smart constructor.
Instances
Arguments
| :: CRType | |
| -> Int | |
| -> Int | |
| -> Text | |
| -> ComputeResource |
Creates a value of ComputeResource with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
crEc2KeyPair- The EC2 key pair that is used for instances launched in the compute environment.crBidPercentage- The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.crSpotIAMFleetRole- The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to aSPOTcompute environment.crImageId- The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.crDesiredvCPUs- The desired number of EC2 vCPUS in the compute environment.crTags- Key-value pair tags to be applied to resources that are launched in the compute environment.crType- The type of compute environment.crMinvCPUs- The minimum number of EC2 vCPUs that an environment should maintain.crMaxvCPUs- The maximum number of EC2 vCPUs that an environment can reach.crInstanceTypes- The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example,c4orp3), or you can specify specific sizes within a family (such asc4.8xlarge). You can also chooseoptimalto pick instance types (from the latest C, M, and R instance families) on the fly that match the demand of your job queues.crSubnets- The VPC subnets into which the compute resources are launched.crSecurityGroupIds- The EC2 security group that is associated with instances launched in the compute environment.crInstanceRole- The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example,ecsInstanceRoleorarn:aws:iam::aws_account_id:instance-profile/ecsInstanceRole. For more information, see Amazon ECS Instance Role in the AWS Batch User Guide .
crEc2KeyPair :: Lens' ComputeResource (Maybe Text) Source #
The EC2 key pair that is used for instances launched in the compute environment.
crBidPercentage :: Lens' ComputeResource (Maybe Int) Source #
The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.
crSpotIAMFleetRole :: Lens' ComputeResource (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment.
crImageId :: Lens' ComputeResource (Maybe Text) Source #
The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.
crDesiredvCPUs :: Lens' ComputeResource (Maybe Int) Source #
The desired number of EC2 vCPUS in the compute environment.
crTags :: Lens' ComputeResource (HashMap Text Text) Source #
Key-value pair tags to be applied to resources that are launched in the compute environment.
crMinvCPUs :: Lens' ComputeResource Int Source #
The minimum number of EC2 vCPUs that an environment should maintain.
crMaxvCPUs :: Lens' ComputeResource Int Source #
The maximum number of EC2 vCPUs that an environment can reach.
crInstanceTypes :: Lens' ComputeResource [Text] Source #
The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, c4 or p3 ), or you can specify specific sizes within a family (such as c4.8xlarge ). You can also choose optimal to pick instance types (from the latest C, M, and R instance families) on the fly that match the demand of your job queues.
crSubnets :: Lens' ComputeResource [Text] Source #
The VPC subnets into which the compute resources are launched.
crSecurityGroupIds :: Lens' ComputeResource [Text] Source #
The EC2 security group that is associated with instances launched in the compute environment.
crInstanceRole :: Lens' ComputeResource Text Source #
The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::aws_account_id:instance-profile/ecsInstanceRole . For more information, see Amazon ECS Instance Role in the AWS Batch User Guide .
ComputeResourceUpdate
data ComputeResourceUpdate Source #
An object representing the attributes of a compute environment that can be updated.
See: computeResourceUpdate smart constructor.
Instances
computeResourceUpdate :: ComputeResourceUpdate Source #
Creates a value of ComputeResourceUpdate with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cruMinvCPUs- The minimum number of EC2 vCPUs that an environment should maintain.cruMaxvCPUs- The maximum number of EC2 vCPUs that an environment can reach.cruDesiredvCPUs- The desired number of EC2 vCPUS in the compute environment.
cruMinvCPUs :: Lens' ComputeResourceUpdate (Maybe Int) Source #
The minimum number of EC2 vCPUs that an environment should maintain.
cruMaxvCPUs :: Lens' ComputeResourceUpdate (Maybe Int) Source #
The maximum number of EC2 vCPUs that an environment can reach.
cruDesiredvCPUs :: Lens' ComputeResourceUpdate (Maybe Int) Source #
The desired number of EC2 vCPUS in the compute environment.
ContainerDetail
data ContainerDetail Source #
An object representing the details of a container that is part of a job.
See: containerDetail smart constructor.
containerDetail :: ContainerDetail Source #
Creates a value of ContainerDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdImage- The image used to start the container.cdCommand- The command that is passed to the container.cdEnvironment- The environment variables to pass to a container.cdTaskARN- The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach theSTARTINGstatus.cdUlimits- A list ofulimitvalues to set in the container.cdContainerInstanceARN- The Amazon Resource Name (ARN) of the container instance on which the container is running.cdPrivileged- When this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser).cdJobRoleARN- The Amazon Resource Name (ARN) associated with the job upon execution.cdMemory- The number of MiB of memory reserved for the job.cdUser- The user name to use inside the container.cdReason- A short (255 max characters) human-readable string to provide additional details about a running or stopped container.cdLogStreamName- The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs isawsbatch/job. Each container attempt receives a log stream name when they reach theRUNNINGstatus.cdMountPoints- The mount points for data volumes in your container.cdExitCode- The exit code to return upon completion.cdVcpus- The number of VCPUs allocated for the job.cdReadonlyRootFilesystem- When this parameter is true, the container is given read-only access to its root file system.cdVolumes- A list of volumes associated with the job.
cdEnvironment :: Lens' ContainerDetail [KeyValuePair] Source #
The environment variables to pass to a container.
cdTaskARN :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.
cdUlimits :: Lens' ContainerDetail [Ulimit] Source #
A list of ulimit values to set in the container.
cdContainerInstanceARN :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the container instance on which the container is running.
cdPrivileged :: Lens' ContainerDetail (Maybe Bool) Source #
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user).
cdJobRoleARN :: Lens' ContainerDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) associated with the job upon execution.
cdMemory :: Lens' ContainerDetail (Maybe Int) Source #
The number of MiB of memory reserved for the job.
cdReason :: Lens' ContainerDetail (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
cdLogStreamName :: Lens' ContainerDetail (Maybe Text) Source #
The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is awsbatch/job . Each container attempt receives a log stream name when they reach the RUNNING status.
cdMountPoints :: Lens' ContainerDetail [MountPoint] Source #
The mount points for data volumes in your container.
cdExitCode :: Lens' ContainerDetail (Maybe Int) Source #
The exit code to return upon completion.
cdReadonlyRootFilesystem :: Lens' ContainerDetail (Maybe Bool) Source #
When this parameter is true, the container is given read-only access to its root file system.
ContainerOverrides
data ContainerOverrides Source #
The overrides that should be sent to a container.
See: containerOverrides smart constructor.
Instances
containerOverrides :: ContainerOverrides Source #
Creates a value of ContainerOverrides with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
coCommand- The command to send to the container that overrides the default command from the Docker image or the job definition.coEnvironment- 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.coMemory- The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.coVcpus- The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
coCommand :: Lens' ContainerOverrides [Text] Source #
The command to send to the container that overrides the default command from the Docker image or the job definition.
coEnvironment :: Lens' ContainerOverrides [KeyValuePair] Source #
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.
coMemory :: Lens' ContainerOverrides (Maybe Int) Source #
The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.
coVcpus :: Lens' ContainerOverrides (Maybe Int) Source #
The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.
ContainerProperties
data ContainerProperties Source #
Container properties are used in job definitions to describe the container that is launched as part of a job.
See: containerProperties smart constructor.
Instances
Creates a value of ContainerProperties with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cpCommand- The command that is passed to the container. This parameter maps toCmdin the Create a container section of the Docker Remote API and theCOMMANDparameter to docker run . For more information, see https://docs.docker.com/engine/reference/builder/#cmd .cpEnvironment- The environment variables to pass to a container. This parameter maps toEnvin the Create a container section of the Docker Remote API and the--envoption to docker run . Important: We do not recommend using plaintext environment variables for sensitive information, such as credential data.cpUlimits- A list ofulimitsto set in the container. This parameter maps toUlimitsin the Create a container section of the Docker Remote API and the--ulimitoption to docker run .cpPrivileged- When this parameter is true, the container is given elevated privileges on the host container instance (similar to therootuser). This parameter maps toPrivilegedin the Create a container section of the Docker Remote API and the--privilegedoption to docker run .cpJobRoleARN- The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.cpUser- The user name to use inside the container. This parameter maps toUserin the Create a container section of the Docker Remote API and the--useroption to docker run .cpMountPoints- The mount points for data volumes in your container. This parameter maps toVolumesin the Create a container section of the Docker Remote API and the--volumeoption to docker run .cpReadonlyRootFilesystem- When this parameter is true, the container is given read-only access to its root file system. This parameter maps toReadonlyRootfsin the Create a container section of the Docker Remote API and the--read-onlyoption todocker run.cpVolumes- A list of data volumes used in a job.cpImage- The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified withrepository-url /image :tag. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps toImagein the Create a container section of the Docker Remote API and theIMAGEparameter of docker run . * Images in Amazon ECR repositories use the full registry and repository URI (for example,012345678910.dkr.ecr.region-name.amazonaws.com/repository-name). * Images in official repositories on Docker Hub use a single name (for example,ubuntuormongo). * Images in other repositories on Docker Hub are qualified with an organization name (for example,amazon/amazon-ecs-agent). * Images in other online repositories are qualified further by a domain name (for example,quay.ioassemblylineubuntu).cpVcpus- The number of vCPUs reserved for the container. This parameter maps toCpuSharesin the Create a container section of the Docker Remote API and the--cpu-sharesoption to docker run . Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.cpMemory- The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps toMemoryin the Create a container section of the Docker Remote API and the--memoryoption to docker run . You must specify at least 4 MiB of memory for a job.
cpCommand :: Lens' ContainerProperties [Text] Source #
The command that is 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 .
cpEnvironment :: Lens' ContainerProperties [KeyValuePair] Source #
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 . Important: We do not recommend using plaintext environment variables for sensitive information, such as credential data.
cpUlimits :: Lens' ContainerProperties [Ulimit] Source #
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run .
cpPrivileged :: Lens' ContainerProperties (Maybe Bool) Source #
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 .
cpJobRoleARN :: Lens' ContainerProperties (Maybe Text) Source #
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
cpUser :: Lens' ContainerProperties (Maybe Text) Source #
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 .
cpMountPoints :: Lens' ContainerProperties [MountPoint] Source #
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 .
cpReadonlyRootFilesystem :: Lens' ContainerProperties (Maybe Bool) Source #
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 .
cpImage :: Lens' ContainerProperties Text Source #
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url /image :tag . 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 docker run . * Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.region-name.amazonaws.com/repository-name ). * Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo ). * Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent ). * Images in other online repositories are qualified further by a domain name (for example, quay.ioassemblylineubuntu ).
cpVcpus :: Lens' ContainerProperties Int Source #
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. You must specify at least one vCPU.
cpMemory :: Lens' ContainerProperties Int Source #
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run . You must specify at least 4 MiB of memory for a job.
ContainerSummary
data ContainerSummary Source #
An object representing summary details of a container within a job.
See: containerSummary smart constructor.
Instances
containerSummary :: ContainerSummary Source #
Creates a value of ContainerSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csReason- A short (255 max characters) human-readable string to provide additional details about a running or stopped container.csExitCode- The exit code to return upon completion.
csReason :: Lens' ContainerSummary (Maybe Text) Source #
A short (255 max characters) human-readable string to provide additional details about a running or stopped container.
csExitCode :: Lens' ContainerSummary (Maybe Int) Source #
The exit code to return upon completion.
Host
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.
See: host smart constructor.
Creates a value of Host with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hSourcePath- The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If thehostparameter contains asourcePathfile location, then the data volume persists at the specified location on the host container instance until you delete it manually. If thesourcePathvalue does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
hSourcePath :: Lens' Host (Maybe Text) Source #
The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the host parameter contains a sourcePath file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the sourcePath value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.
JobDefinition
data JobDefinition Source #
An object representing an AWS Batch job definition.
See: jobDefinition smart constructor.
Arguments
| :: Text | |
| -> Text | |
| -> Int | |
| -> Text | |
| -> JobDefinition |
Creates a value of JobDefinition with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jddStatus- The status of the job definition.jddRetryStrategy- The retry strategy to use for failed jobs that are submitted with this job definition.jddParameters- Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in aSubmitJobrequest override any corresponding parameter defaults from the job definition.jddTimeout- The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.jddContainerProperties- An object with various properties specific to container-based jobs.jddJobDefinitionName- The name of the job definition.jddJobDefinitionARN- The Amazon Resource Name (ARN) for the job definition.jddRevision- The revision of the job definition.jddType- The type of job definition.
jddRetryStrategy :: Lens' JobDefinition (Maybe RetryStrategy) Source #
The retry strategy to use for failed jobs that are submitted with this job definition.
jddParameters :: Lens' JobDefinition (HashMap Text Text) Source #
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.
jddTimeout :: Lens' JobDefinition (Maybe JobTimeout) Source #
The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.
jddContainerProperties :: Lens' JobDefinition (Maybe ContainerProperties) Source #
An object with various properties specific to container-based jobs.
jddJobDefinitionName :: Lens' JobDefinition Text Source #
The name of the job definition.
jddJobDefinitionARN :: Lens' JobDefinition Text Source #
The Amazon Resource Name (ARN) for the job definition.
jddRevision :: Lens' JobDefinition Int Source #
The revision of the job definition.
JobDependency
data JobDependency Source #
An object representing an AWS Batch job dependency.
See: jobDependency smart constructor.
Instances
jobDependency :: JobDependency Source #
Creates a value of JobDependency with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jJobId :: Lens' JobDependency (Maybe Text) Source #
The job ID of the AWS Batch job associated with this dependency.
jType :: Lens' JobDependency (Maybe ArrayJobDependency) Source #
The type of the job dependency.
JobDetail
An object representing an AWS Batch job.
See: jobDetail smart constructor.
Creates a value of JobDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jdStoppedAt- The Unix time stamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from theRUNNINGstate to a terminal state, such asSUCCEEDEDorFAILED).jdCreatedAt- The Unix time stamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered theSUBMITTEDstate (at the timeSubmitJobwas called). For array child jobs, this is when the child job was spawned by its parent and entered thePENDINGstate.jdRetryStrategy- The retry strategy to use for this job if an attempt fails.jdAttempts- A list of job attempts associated with this job.jdDependsOn- A list of job names or IDs on which this job depends.jdContainer- An object representing the details of the container that is associated with the job.jdParameters- Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.jdStatusReason- A short, human-readable string to provide additional details about the current status of the job.jdArrayProperties- The array properties of the job, if it is an array job.jdTimeout- The timeout configuration for the job.jdJobName- The name of the job.jdJobId- The ID for the job.jdJobQueue- The Amazon Resource Name (ARN) of the job queue with which the job is associated.jdStatus- The current status for the job.jdStartedAt- The Unix time stamp (in seconds and milliseconds) for when the job was started (when the job transitioned from theSTARTINGstate to theRUNNINGstate).jdJobDefinition- The job definition that is used by this job.
jdStoppedAt :: Lens' JobDetail (Maybe Integer) Source #
The Unix time stamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED ).
jdCreatedAt :: Lens' JobDetail (Maybe Integer) Source #
The Unix time stamp (in seconds and 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.
jdRetryStrategy :: Lens' JobDetail (Maybe RetryStrategy) Source #
The retry strategy to use for this job if an attempt fails.
jdAttempts :: Lens' JobDetail [AttemptDetail] Source #
A list of job attempts associated with this job.
jdDependsOn :: Lens' JobDetail [JobDependency] Source #
A list of job names or IDs on which this job depends.
jdContainer :: Lens' JobDetail (Maybe ContainerDetail) Source #
An object representing the details of the container that is associated with the job.
jdParameters :: Lens' JobDetail (HashMap Text Text) Source #
Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.
jdStatusReason :: Lens' JobDetail (Maybe Text) Source #
A short, human-readable string to provide additional details about the current status of the job.
jdArrayProperties :: Lens' JobDetail (Maybe ArrayPropertiesDetail) Source #
The array properties of the job, if it is an array job.
jdJobQueue :: Lens' JobDetail Text Source #
The Amazon Resource Name (ARN) of the job queue with which the job is associated.
jdStartedAt :: Lens' JobDetail Integer Source #
The Unix time stamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
JobQueueDetail
data JobQueueDetail Source #
An object representing the details of an AWS Batch job queue.
See: jobQueueDetail smart constructor.
Arguments
| :: Text | |
| -> Text | |
| -> JQState | |
| -> Int | |
| -> JobQueueDetail |
Creates a value of JobQueueDetail with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jqdStatus- The status of the job queue (for example,CREATINGorVALID).jqdStatusReason- A short, human-readable string to provide additional details about the current status of the job queue.jqdJobQueueName- The name of the job queue.jqdJobQueueARN- The Amazon Resource Name (ARN) of the job queue.jqdState- Describes the ability of the queue to accept new jobs.jqdPriority- The priority of the job queue.jqdComputeEnvironmentOrder- The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
jqdStatus :: Lens' JobQueueDetail (Maybe JQStatus) Source #
The status of the job queue (for example, CREATING or VALID ).
jqdStatusReason :: Lens' JobQueueDetail (Maybe Text) Source #
A short, human-readable string to provide additional details about the current status of the job queue.
jqdJobQueueName :: Lens' JobQueueDetail Text Source #
The name of the job queue.
jqdJobQueueARN :: Lens' JobQueueDetail Text Source #
The Amazon Resource Name (ARN) of the job queue.
jqdState :: Lens' JobQueueDetail JQState Source #
Describes the ability of the queue to accept new jobs.
jqdPriority :: Lens' JobQueueDetail Int Source #
The priority of the job queue.
jqdComputeEnvironmentOrder :: Lens' JobQueueDetail [ComputeEnvironmentOrder] Source #
The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.
JobSummary
data JobSummary Source #
An object representing summary details of a job.
See: jobSummary smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> JobSummary |
Creates a value of JobSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jsStoppedAt- The Unix time stamp for when the job was stopped (when the job transitioned from theRUNNINGstate to a terminal state, such asSUCCEEDEDorFAILED).jsStatus- The current status for the job.jsCreatedAt- The Unix time stamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered theSUBMITTEDstate (at the timeSubmitJobwas called). For array child jobs, this is when the child job was spawned by its parent and entered thePENDINGstate.jsStartedAt- The Unix time stamp for when the job was started (when the job transitioned from theSTARTINGstate to theRUNNINGstate).jsContainer- An object representing the details of the container that is associated with the job.jsStatusReason- A short, human-readable string to provide additional details about the current status of the job.jsArrayProperties- The array properties of the job, if it is an array job.jsJobId- The ID of the job.jsJobName- The name of the job.
jsStoppedAt :: Lens' JobSummary (Maybe Integer) Source #
The Unix time stamp for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED ).
jsCreatedAt :: Lens' JobSummary (Maybe Integer) Source #
The Unix time stamp 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.
jsStartedAt :: Lens' JobSummary (Maybe Integer) Source #
The Unix time stamp for when the job was started (when the job transitioned from the STARTING state to the RUNNING state).
jsContainer :: Lens' JobSummary (Maybe ContainerSummary) Source #
An object representing the details of the container that is associated with the job.
jsStatusReason :: Lens' JobSummary (Maybe Text) Source #
A short, human-readable string to provide additional details about the current status of the job.
jsArrayProperties :: Lens' JobSummary (Maybe ArrayPropertiesSummary) Source #
The array properties of the job, if it is an array job.
JobTimeout
data JobTimeout Source #
An object representing a job timeout configuration.
See: jobTimeout smart constructor.
jobTimeout :: JobTimeout Source #
Creates a value of JobTimeout with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jtAttemptDurationSeconds- The time duration in seconds (measured from the job attempt'sstartedAttimestamp) after which AWS Batch terminates your jobs if they have not finished.
jtAttemptDurationSeconds :: Lens' JobTimeout (Maybe Int) Source #
The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished.
KeyValuePair
data KeyValuePair Source #
A key-value pair object.
See: keyValuePair smart constructor.
keyValuePair :: KeyValuePair Source #
Creates a value of KeyValuePair with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
kvpValue :: Lens' KeyValuePair (Maybe Text) Source #
The value of the key-value pair. For environment variables, this is the value of the environment variable.
kvpName :: Lens' KeyValuePair (Maybe Text) Source #
The name of the key-value pair. For environment variables, this is the name of the environment variable.
MountPoint
data MountPoint Source #
Details on a Docker volume mount point that is used in a job's container properties.
See: mountPoint smart constructor.
mountPoint :: MountPoint Source #
Creates a value of MountPoint with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mpContainerPath- The path on the container at which to mount the host volume.mpSourceVolume- The name of the volume to mount.mpReadOnly- If this value istrue, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value isfalse.
mpContainerPath :: Lens' MountPoint (Maybe Text) Source #
The path on the container at which to mount the host volume.
mpSourceVolume :: Lens' MountPoint (Maybe Text) Source #
The name of the volume to mount.
mpReadOnly :: Lens' MountPoint (Maybe Bool) Source #
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 .
RetryStrategy
data RetryStrategy Source #
The retry strategy associated with a job.
See: retryStrategy smart constructor.
Instances
retryStrategy :: RetryStrategy Source #
Creates a value of RetryStrategy with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsAttempts- The number of times to move a job to theRUNNABLEstatus. You may specify between 1 and 10 attempts. If the value ofattemptsis greater than one, the job is retried if it fails until it has moved toRUNNABLEthat many times.
rsAttempts :: Lens' RetryStrategy (Maybe Int) Source #
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried if it fails until it has moved to RUNNABLE that many times.
Ulimit
The ulimit settings to pass to the container.
See: ulimit smart constructor.
Creates a value of Ulimit with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uHardLimit- The hard limit for theulimittype.uName- Thetypeof theulimit.uSoftLimit- The soft limit for theulimittype.
Volume
A data volume used in a job's container properties.
See: volume smart constructor.
Creates a value of Volume with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vName- The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in thesourceVolumeparameter of container definitionmountPoints.vHost- The contents of thehostparameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.
vName :: Lens' Volume (Maybe Text) Source #
The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints .
vHost :: Lens' Volume (Maybe Host) Source #
The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.