-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | Amazon Batch SDK.
--
-- The types from this library are intended to be used with
-- amazonka, which provides mechanisms for specifying AuthN/AuthZ
-- information, sending requests, and receiving responses.
--
-- Lenses are used for constructing and manipulating types, due to the
-- depth of nesting of AWS types and transparency regarding
-- de/serialisation into more palatable Haskell values. The provided
-- lenses should be compatible with any of the major lens libraries such
-- as lens or lens-family-core.
--
-- See Network.AWS.Batch or the AWS documentation to get
-- started.
@package amazonka-batch
@version 1.5.0
module Network.AWS.Batch.Types
-- | API version 2016-08-10 of the Amazon Batch SDK configuration.
batch :: Service
-- | These errors are usually caused by a server issue.
_ServerException :: AsError a => Getting (First ServiceError) a ServiceError
-- | 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 permission to
-- use the action or resource, or specifying an identifier that is not
-- valid.
_ClientException :: AsError a => Getting (First ServiceError) a ServiceError
data CEState
Disabled :: CEState
Enabled :: CEState
data CEStatus
CESCreating :: CEStatus
CESDeleted :: CEStatus
CESDeleting :: CEStatus
CESInvalid :: CEStatus
CESUpdating :: CEStatus
CESValid :: CEStatus
data CEType
Managed :: CEType
Unmanaged :: CEType
data CRType
EC2 :: CRType
Spot :: CRType
data JQState
JQSDisabled :: JQState
JQSEnabled :: JQState
data JQStatus
Creating :: JQStatus
Deleted :: JQStatus
Deleting :: JQStatus
Invalid :: JQStatus
Updating :: JQStatus
Valid :: JQStatus
data JobDefinitionType
Container :: JobDefinitionType
data JobStatus
Failed :: JobStatus
Pending :: JobStatus
Runnable :: JobStatus
Running :: JobStatus
Starting :: JobStatus
Submitted :: JobStatus
Succeeded :: JobStatus
-- | An object representing the details of a container that is part of a
-- job attempt.
--
-- See: attemptContainerDetail smart constructor.
data AttemptContainerDetail
-- | 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 the STARTING
-- status.
-- - 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
-- is awsbatch/job . Each container attempt receives a
-- log stream name when they reach the RUNNING status.
-- - acdExitCode - The exit code for the job attempt. A non-zero
-- exit code is considered a failure.
--
attemptContainerDetail :: AttemptContainerDetail
-- | 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.
acdTaskARN :: Lens' AttemptContainerDetail (Maybe Text)
-- | The Amazon Resource Name (ARN) of the Amazon ECS container instance
-- that hosts the job attempt.
acdContainerInstanceARN :: Lens' AttemptContainerDetail (Maybe Text)
-- | A short (255 max characters) human-readable string to provide
-- additional details about a running or stopped container.
acdReason :: Lens' AttemptContainerDetail (Maybe Text)
-- | 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.
acdLogStreamName :: Lens' AttemptContainerDetail (Maybe Text)
-- | The exit code for the job attempt. A non-zero exit code is considered
-- a failure.
acdExitCode :: Lens' AttemptContainerDetail (Maybe Int)
-- | An object representing a job attempt.
--
-- See: attemptDetail smart constructor.
data AttemptDetail
-- | 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 timestamp for when the attempt was
-- stopped (when the task transitioned from the RUNNING state to
-- the STOPPED state).
-- - adStartedAt - The Unix timestamp for when the attempt was
-- started (when the task transitioned from the PENDING state to
-- the RUNNING state).
-- - 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.
--
attemptDetail :: AttemptDetail
-- | The Unix timestamp for when the attempt was stopped (when the task
-- transitioned from the RUNNING state to the STOPPED
-- state).
adStoppedAt :: Lens' AttemptDetail (Maybe Integer)
-- | The Unix timestamp for when the attempt was started (when the task
-- transitioned from the PENDING state to the RUNNING
-- state).
adStartedAt :: Lens' AttemptDetail (Maybe Integer)
-- | Details about the container in this job attempt.
adContainer :: Lens' AttemptDetail (Maybe AttemptContainerDetail)
-- | A short, human-readable string to provide additional details about the
-- current status of the job attempt.
adStatusReason :: Lens' AttemptDetail (Maybe Text)
-- | An object representing an AWS Batch compute environment.
--
-- See: computeEnvironmentDetail smart constructor.
data 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, CREATING or VALID ).
-- - cedState - 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 - 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.
--
computeEnvironmentDetail :: Text -> Text -> Text -> ComputeEnvironmentDetail
-- | The current status of the compute environment (for example,
-- CREATING or VALID ).
cedStatus :: Lens' ComputeEnvironmentDetail (Maybe CEStatus)
-- | 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.
cedState :: Lens' ComputeEnvironmentDetail (Maybe CEState)
-- | The compute resources defined for the compute environment.
cedComputeResources :: Lens' ComputeEnvironmentDetail (Maybe ComputeResource)
-- | A short, human-readable string to provide additional details about the
-- current status of the compute environment.
cedStatusReason :: Lens' ComputeEnvironmentDetail (Maybe Text)
-- | The type of the compute environment.
cedType :: Lens' ComputeEnvironmentDetail (Maybe CEType)
-- | The service role associated with the compute environment that allows
-- AWS Batch to make calls to AWS API operations on your behalf.
cedServiceRole :: Lens' ComputeEnvironmentDetail (Maybe Text)
-- | The name of the compute environment.
cedComputeEnvironmentName :: Lens' ComputeEnvironmentDetail Text
-- | The Amazon Resource Name (ARN) of the compute environment.
cedComputeEnvironmentARN :: Lens' ComputeEnvironmentDetail Text
-- | The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster
-- used by the compute environment.
cedEcsClusterARN :: Lens' ComputeEnvironmentDetail Text
-- | 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.
data 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:
--
--
computeEnvironmentOrder :: Int -> Text -> ComputeEnvironmentOrder
-- | The order of the compute environment.
ceoOrder :: Lens' ComputeEnvironmentOrder Int
-- | The Amazon Resource Name (ARN) of the compute environment.
ceoComputeEnvironment :: Lens' ComputeEnvironmentOrder Text
-- | An object representing an AWS Batch compute resource.
--
-- See: computeResource smart constructor.
data 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 a SPOT compute
-- 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, 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 - 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, 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 .
--
computeResource :: CRType -> Int -> Int -> Text -> ComputeResource
-- | The EC2 key pair that is used for instances launched in the compute
-- environment.
crEc2KeyPair :: Lens' ComputeResource (Maybe Text)
-- | 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.
crBidPercentage :: Lens' ComputeResource (Maybe Int)
-- | The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role
-- applied to a SPOT compute environment.
crSpotIAMFleetRole :: Lens' ComputeResource (Maybe Text)
-- | The Amazon Machine Image (AMI) ID used for instances launched in the
-- compute environment.
crImageId :: Lens' ComputeResource (Maybe Text)
-- | The desired number of EC2 vCPUS in the compute environment.
crDesiredvCPUs :: Lens' ComputeResource (Maybe Int)
-- | Key-value pair tags to be applied to resources that are launched in
-- the compute environment.
crTags :: Lens' ComputeResource (HashMap Text Text)
-- | The type of compute environment.
crType :: Lens' ComputeResource CRType
-- | The minimum number of EC2 vCPUs that an environment should maintain.
crMinvCPUs :: Lens' ComputeResource Int
-- | The maximum number of EC2 vCPUs that an environment can reach.
crMaxvCPUs :: Lens' ComputeResource Int
-- | 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.
crInstanceTypes :: Lens' ComputeResource [Text]
-- | The VPC subnets into which the compute resources are launched.
crSubnets :: Lens' ComputeResource [Text]
-- | The EC2 security group that is associated with instances launched in
-- the compute environment.
crSecurityGroupIds :: Lens' ComputeResource [Text]
-- | 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 .
crInstanceRole :: Lens' ComputeResource Text
-- | An object representing the attributes of a compute environment that
-- can be updated.
--
-- See: computeResourceUpdate smart constructor.
data ComputeResourceUpdate
-- | 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.
--
computeResourceUpdate :: ComputeResourceUpdate
-- | The minimum number of EC2 vCPUs that an environment should maintain.
cruMinvCPUs :: Lens' ComputeResourceUpdate (Maybe Int)
-- | The maximum number of EC2 vCPUs that an environment can reach.
cruMaxvCPUs :: Lens' ComputeResourceUpdate (Maybe Int)
-- | The desired number of EC2 vCPUS in the compute environment.
cruDesiredvCPUs :: Lens' ComputeResourceUpdate (Maybe Int)
-- | An object representing the details of a container that is part of a
-- job.
--
-- See: containerDetail smart constructor.
data ContainerDetail
-- | 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 the STARTING
-- status.
-- - cdUlimits - A list of ulimit values 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 the root user).
-- - 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
-- is awsbatch/job . Each container attempt receives a
-- log stream name when they reach the RUNNING status.
-- - 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.
--
containerDetail :: ContainerDetail
-- | The image used to start the container.
cdImage :: Lens' ContainerDetail (Maybe Text)
-- | The command that is passed to the container.
cdCommand :: Lens' ContainerDetail [Text]
-- | The environment variables to pass to a container.
cdEnvironment :: Lens' ContainerDetail [KeyValuePair]
-- | 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.
cdTaskARN :: Lens' ContainerDetail (Maybe Text)
-- | A list of ulimit values to set in the container.
cdUlimits :: Lens' ContainerDetail [Ulimit]
-- | The Amazon Resource Name (ARN) of the container instance on which the
-- container is running.
cdContainerInstanceARN :: Lens' ContainerDetail (Maybe Text)
-- | When this parameter is true, the container is given elevated
-- privileges on the host container instance (similar to the
-- root user).
cdPrivileged :: Lens' ContainerDetail (Maybe Bool)
-- | The Amazon Resource Name (ARN) associated with the job upon execution.
cdJobRoleARN :: Lens' ContainerDetail (Maybe Text)
-- | The number of MiB of memory reserved for the job.
cdMemory :: Lens' ContainerDetail (Maybe Int)
-- | The user name to use inside the container.
cdUser :: Lens' ContainerDetail (Maybe Text)
-- | A short (255 max characters) human-readable string to provide
-- additional details about a running or stopped container.
cdReason :: Lens' ContainerDetail (Maybe Text)
-- | 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.
cdLogStreamName :: Lens' ContainerDetail (Maybe Text)
-- | The mount points for data volumes in your container.
cdMountPoints :: Lens' ContainerDetail [MountPoint]
-- | The exit code to return upon completion.
cdExitCode :: Lens' ContainerDetail (Maybe Int)
-- | The number of VCPUs allocated for the job.
cdVcpus :: Lens' ContainerDetail (Maybe Int)
-- | When this parameter is true, the container is given read-only access
-- to its root file system.
cdReadonlyRootFilesystem :: Lens' ContainerDetail (Maybe Bool)
-- | A list of volumes associated with the job.
cdVolumes :: Lens' ContainerDetail [Volume]
-- | The overrides that should be sent to a container.
--
-- See: containerOverrides smart constructor.
data ContainerOverrides
-- | 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.
--
containerOverrides :: ContainerOverrides
-- | The command to send to the container that overrides the default
-- command from the Docker image or the job definition.
coCommand :: Lens' ContainerOverrides [Text]
-- | 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.
coEnvironment :: Lens' ContainerOverrides [KeyValuePair]
-- | The number of MiB of memory reserved for the job. This value overrides
-- the value set in the job definition.
coMemory :: Lens' ContainerOverrides (Maybe Int)
-- | The number of vCPUs to reserve for the container. This value overrides
-- the value set in the job definition.
coVcpus :: Lens' ContainerOverrides (Maybe Int)
-- | Container properties are used in job definitions to describe the
-- container that is launched as part of a job.
--
-- See: containerProperties smart constructor.
data ContainerProperties
-- | 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 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 - 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 plain text environment variables for sensitive
-- information, such as credential data.
-- - cpUlimits - 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 - 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 - 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 to User in the Create a container
-- section of the Docker Remote API and the --user option
-- to docker run .
-- - cpMountPoints - 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 - 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 .
-- - 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
-- 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 - 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 1 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 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.
--
containerProperties :: Text -> Int -> Int -> ContainerProperties
-- | 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 .
cpCommand :: Lens' ContainerProperties [Text]
-- | 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 plain text
-- environment variables for sensitive information, such as credential
-- data.
cpEnvironment :: Lens' ContainerProperties [KeyValuePair]
-- | 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 .
cpUlimits :: Lens' ContainerProperties [Ulimit]
-- | 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 .
cpPrivileged :: Lens' ContainerProperties (Maybe Bool)
-- | The Amazon Resource Name (ARN) of the IAM role that the container can
-- assume for AWS permissions.
cpJobRoleARN :: Lens' ContainerProperties (Maybe Text)
-- | 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 .
cpUser :: Lens' ContainerProperties (Maybe Text)
-- | 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 .
cpMountPoints :: Lens' ContainerProperties [MountPoint]
-- | 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 .
cpReadonlyRootFilesystem :: Lens' ContainerProperties (Maybe Bool)
-- | A list of data volumes used in a job.
cpVolumes :: Lens' ContainerProperties [Volume]
-- | 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 ).
cpImage :: Lens' ContainerProperties Text
-- | 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 1 vCPU.
cpVcpus :: Lens' ContainerProperties Int
-- | 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.
cpMemory :: Lens' ContainerProperties Int
-- | 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.
data Host
-- | 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 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.
--
host :: Host
-- | 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.
hSourcePath :: Lens' Host (Maybe Text)
-- | An object representing an AWS Batch job definition.
--
-- See: jobDefinition smart constructor.
data 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:
--
--
-- - jStatus - The status of the job definition.
-- - jRetryStrategy - The retry strategy to use for failed jobs
-- that are submitted with this job definition.
-- - jParameters - 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.
-- - jContainerProperties - An object with various properties
-- specific to container-based jobs.
-- - jJobDefinitionName - The name of the job definition.
-- - jJobDefinitionARN - The Amazon Resource Name (ARN) for the
-- job definition.
-- - jRevision - The revision of the job definition.
-- - jType - The type of job definition.
--
jobDefinition :: Text -> Text -> Int -> Text -> JobDefinition
-- | The status of the job definition.
jStatus :: Lens' JobDefinition (Maybe Text)
-- | The retry strategy to use for failed jobs that are submitted with this
-- job definition.
jRetryStrategy :: Lens' JobDefinition (Maybe RetryStrategy)
-- | 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.
jParameters :: Lens' JobDefinition (HashMap Text Text)
-- | An object with various properties specific to container-based jobs.
jContainerProperties :: Lens' JobDefinition (Maybe ContainerProperties)
-- | The name of the job definition.
jJobDefinitionName :: Lens' JobDefinition Text
-- | The Amazon Resource Name (ARN) for the job definition.
jJobDefinitionARN :: Lens' JobDefinition Text
-- | The revision of the job definition.
jRevision :: Lens' JobDefinition Int
-- | The type of job definition.
jType :: Lens' JobDefinition Text
-- | An object representing an AWS Batch job dependency.
--
-- See: jobDependency smart constructor.
data JobDependency
-- | 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 - The job ID of the AWS Batch job associated with
-- this dependency.
--
jobDependency :: JobDependency
-- | The job ID of the AWS Batch job associated with this dependency.
jJobId :: Lens' JobDependency (Maybe Text)
-- | An object representing an AWS Batch job.
--
-- See: jobDetail smart constructor.
data JobDetail
-- | 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 timestamp for when the job was
-- stopped (when the task transitioned from the RUNNING state to
-- the STOPPED state).
-- - jdCreatedAt - The Unix timestamp for when the job was
-- created (when the task entered the PENDING state).
-- - 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.
-- - 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 timestamp for when the job was
-- started (when the task transitioned from the PENDING state to
-- the RUNNING state).
-- - jdJobDefinition - The job definition that is used by this
-- job.
--
jobDetail :: Text -> Text -> Text -> JobStatus -> Integer -> Text -> JobDetail
-- | The Unix timestamp for when the job was stopped (when the task
-- transitioned from the RUNNING state to the STOPPED
-- state).
jdStoppedAt :: Lens' JobDetail (Maybe Integer)
-- | The Unix timestamp for when the job was created (when the task entered
-- the PENDING state).
jdCreatedAt :: Lens' JobDetail (Maybe Integer)
-- | The retry strategy to use for this job if an attempt fails.
jdRetryStrategy :: Lens' JobDetail (Maybe RetryStrategy)
-- | A list of job attempts associated with this job.
jdAttempts :: Lens' JobDetail [AttemptDetail]
-- | A list of job names or IDs on which this job depends.
jdDependsOn :: Lens' JobDetail [JobDependency]
-- | An object representing the details of the container that is associated
-- with the job.
jdContainer :: Lens' JobDetail (Maybe ContainerDetail)
-- | Additional parameters passed to the job that replace parameter
-- substitution placeholders or override any corresponding parameter
-- defaults from the job definition.
jdParameters :: Lens' JobDetail (HashMap Text Text)
-- | A short, human-readable string to provide additional details about the
-- current status of the job.
jdStatusReason :: Lens' JobDetail (Maybe Text)
-- | The name of the job.
jdJobName :: Lens' JobDetail Text
-- | The ID for the job.
jdJobId :: Lens' JobDetail Text
-- | The Amazon Resource Name (ARN) of the job queue with which the job is
-- associated.
jdJobQueue :: Lens' JobDetail Text
-- | The current status for the job.
jdStatus :: Lens' JobDetail JobStatus
-- | The Unix timestamp for when the job was started (when the task
-- transitioned from the PENDING state to the RUNNING
-- state).
jdStartedAt :: Lens' JobDetail Integer
-- | The job definition that is used by this job.
jdJobDefinition :: Lens' JobDetail Text
-- | An object representing the details of an AWS Batch job queue.
--
-- See: jobQueueDetail smart constructor.
data 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,
-- CREATING or VALID ).
-- - 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.
--
jobQueueDetail :: Text -> Text -> JQState -> Int -> JobQueueDetail
-- | The status of the job queue (for example, CREATING or
-- VALID ).
jqdStatus :: Lens' JobQueueDetail (Maybe JQStatus)
-- | A short, human-readable string to provide additional details about the
-- current status of the job queue.
jqdStatusReason :: Lens' JobQueueDetail (Maybe Text)
-- | The name of the job queue.
jqdJobQueueName :: Lens' JobQueueDetail Text
-- | The Amazon Resource Name (ARN) of the job queue.
jqdJobQueueARN :: Lens' JobQueueDetail Text
-- | Describes the ability of the queue to accept new jobs.
jqdState :: Lens' JobQueueDetail JQState
-- | The priority of the job queue.
jqdPriority :: Lens' JobQueueDetail Int
-- | 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.
jqdComputeEnvironmentOrder :: Lens' JobQueueDetail [ComputeEnvironmentOrder]
-- | An object representing summary details of a job.
--
-- See: jobSummary smart constructor.
data 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:
--
--
jobSummary :: Text -> Text -> JobSummary
-- | The ID of the job.
jsJobId :: Lens' JobSummary Text
-- | The name of the job.
jsJobName :: Lens' JobSummary Text
-- | A key-value pair object.
--
-- See: keyValuePair smart constructor.
data KeyValuePair
-- | 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 - The value of the key value pair. For environment
-- variables, this is the value of the environment variable.
-- - kvpName - The name of the key value pair. For environment
-- variables, this is the name of the environment variable.
--
keyValuePair :: KeyValuePair
-- | The value of the key value pair. For environment variables, this is
-- the value of the environment variable.
kvpValue :: Lens' KeyValuePair (Maybe Text)
-- | The name of the key value pair. For environment variables, this is the
-- name of the environment variable.
kvpName :: Lens' KeyValuePair (Maybe Text)
-- | Details on a Docker volume mount point that is used in a job's
-- container properties.
--
-- See: mountPoint smart constructor.
data MountPoint
-- | 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 is true , the container
-- has read-only access to the volume; otherwise, the container can write
-- to the volume. The default value is false .
--
mountPoint :: MountPoint
-- | The path on the container at which to mount the host volume.
mpContainerPath :: Lens' MountPoint (Maybe Text)
-- | The name of the volume to mount.
mpSourceVolume :: Lens' MountPoint (Maybe Text)
-- | 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 .
mpReadOnly :: Lens' MountPoint (Maybe Bool)
-- | The retry strategy associated with a job.
--
-- See: retryStrategy smart constructor.
data RetryStrategy
-- | 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 the
-- RUNNABLE status. You may specify between 1 and 10 attempts.
-- If attempts is greater than one, the job is retried if it
-- fails until it has moved to RUNNABLE that many times.
--
retryStrategy :: RetryStrategy
-- | The number of times to move a job to the RUNNABLE status. You
-- may specify between 1 and 10 attempts. If attempts is greater
-- than one, the job is retried if it fails until it has moved to
-- RUNNABLE that many times.
rsAttempts :: Lens' RetryStrategy (Maybe Int)
-- | The ulimit settings to pass to the container.
--
-- See: ulimit smart constructor.
data Ulimit
-- | 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 the ulimit
-- type.
-- - uName - The type of the ulimit .
-- - uSoftLimit - The soft limit for the ulimit
-- type.
--
ulimit :: Int -> Text -> Int -> Ulimit
-- | The hard limit for the ulimit type.
uHardLimit :: Lens' Ulimit Int
-- | The type of the ulimit .
uName :: Lens' Ulimit Text
-- | The soft limit for the ulimit type.
uSoftLimit :: Lens' Ulimit Int
-- | A data volume used in a job's container properties.
--
-- See: volume smart constructor.
data Volume
-- | 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 the sourceVolume
-- parameter of container definition mountPoints .
-- - vHost - 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.
--
volume :: Volume
-- | 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 .
vName :: Lens' Volume (Maybe Text)
-- | 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.
vHost :: Lens' Volume (Maybe Host)
-- | Updates an AWS Batch compute environment.
module Network.AWS.Batch.UpdateComputeEnvironment
-- | Creates a value of UpdateComputeEnvironment with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - uceState - The state of the compute environment. Compute
-- environments in the ENABLED state can accept jobs from a
-- queue and scale in or out automatically based on the workload demand
-- of its associated queues.
-- - uceComputeResources - Details of the compute resources
-- managed by the compute environment. Required for a managed compute
-- environment.
-- - uceServiceRole - The full Amazon Resource Name (ARN) of the
-- IAM role that allows AWS Batch to make calls to other AWS services on
-- your behalf. If your specified role has a path other than / ,
-- then you must either specify the full role ARN (this is recommended)
-- or prefix the role name with the path.
-- - uceComputeEnvironment - The name or full Amazon Resource
-- Name (ARN) of the compute environment to update.
--
updateComputeEnvironment :: Text -> UpdateComputeEnvironment
-- | See: updateComputeEnvironment smart constructor.
data UpdateComputeEnvironment
-- | The state of the compute environment. Compute environments in the
-- ENABLED state can accept jobs from a queue and scale in or
-- out automatically based on the workload demand of its associated
-- queues.
uceState :: Lens' UpdateComputeEnvironment (Maybe CEState)
-- | Details of the compute resources managed by the compute environment.
-- Required for a managed compute environment.
uceComputeResources :: Lens' UpdateComputeEnvironment (Maybe ComputeResourceUpdate)
-- | The full Amazon Resource Name (ARN) of the IAM role that allows AWS
-- Batch to make calls to other AWS services on your behalf. If your
-- specified role has a path other than / , then you must either
-- specify the full role ARN (this is recommended) or prefix the role
-- name with the path.
uceServiceRole :: Lens' UpdateComputeEnvironment (Maybe Text)
-- | The name or full Amazon Resource Name (ARN) of the compute environment
-- to update.
uceComputeEnvironment :: Lens' UpdateComputeEnvironment Text
-- | Creates a value of UpdateComputeEnvironmentResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateComputeEnvironmentResponse :: Int -> UpdateComputeEnvironmentResponse
-- | See: updateComputeEnvironmentResponse smart constructor.
data UpdateComputeEnvironmentResponse
-- | The name of compute environment.
ucersComputeEnvironmentName :: Lens' UpdateComputeEnvironmentResponse (Maybe Text)
-- | The Amazon Resource Name (ARN) of the compute environment.
ucersComputeEnvironmentARN :: Lens' UpdateComputeEnvironmentResponse (Maybe Text)
-- |
-- - - | The response status code.
--
ucersResponseStatus :: Lens' UpdateComputeEnvironmentResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironmentResponse
instance Data.Data.Data Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironmentResponse
instance GHC.Show.Show Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironmentResponse
instance GHC.Read.Read Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironmentResponse
instance GHC.Classes.Eq Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironmentResponse
instance GHC.Generics.Generic Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance Data.Data.Data Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance GHC.Show.Show Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance GHC.Read.Read Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance GHC.Classes.Eq Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance Data.Hashable.Class.Hashable Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance Control.DeepSeq.NFData Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironment
instance Control.DeepSeq.NFData Network.AWS.Batch.UpdateComputeEnvironment.UpdateComputeEnvironmentResponse
-- | Updates a job queue.
module Network.AWS.Batch.UpdateJobQueue
-- | Creates a value of UpdateJobQueue with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - ujqState - Describes the queue's ability to accept new
-- jobs.
-- - ujqPriority - The priority of the job queue. Job queues
-- with a higher priority (or a higher integer value for the
-- priority parameter) are evaluated first when associated with
-- same compute environment. Priority is determined in descending order,
-- for example, a job queue with a priority value of 10 is given
-- scheduling preference over a job queue with a priority value of
-- 1 .
-- - ujqComputeEnvironmentOrder - Details the set of compute
-- environments mapped to a job queue and their order relative to each
-- other. This is one of the parameters used by the job scheduler to
-- determine which compute environment should execute a given job.
-- - ujqJobQueue - The name or the Amazon Resource Name (ARN) of
-- the job queue.
--
updateJobQueue :: Text -> UpdateJobQueue
-- | See: updateJobQueue smart constructor.
data UpdateJobQueue
-- | Describes the queue's ability to accept new jobs.
ujqState :: Lens' UpdateJobQueue (Maybe JQState)
-- | The priority of the job queue. Job queues with a higher priority (or a
-- higher integer value for the priority parameter) are
-- evaluated first when associated with same compute environment.
-- Priority is determined in descending order, for example, a job queue
-- with a priority value of 10 is given scheduling preference
-- over a job queue with a priority value of 1 .
ujqPriority :: Lens' UpdateJobQueue (Maybe Int)
-- | Details the set of compute environments mapped to a job queue and
-- their order relative to each other. This is one of the parameters used
-- by the job scheduler to determine which compute environment should
-- execute a given job.
ujqComputeEnvironmentOrder :: Lens' UpdateJobQueue [ComputeEnvironmentOrder]
-- | The name or the Amazon Resource Name (ARN) of the job queue.
ujqJobQueue :: Lens' UpdateJobQueue Text
-- | Creates a value of UpdateJobQueueResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
updateJobQueueResponse :: Int -> UpdateJobQueueResponse
-- | See: updateJobQueueResponse smart constructor.
data UpdateJobQueueResponse
-- | The Amazon Resource Name (ARN) of the job queue.
ujqrsJobQueueARN :: Lens' UpdateJobQueueResponse (Maybe Text)
-- | The name of the job queue.
ujqrsJobQueueName :: Lens' UpdateJobQueueResponse (Maybe Text)
-- |
-- - - | The response status code.
--
ujqrsResponseStatus :: Lens' UpdateJobQueueResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.UpdateJobQueue.UpdateJobQueueResponse
instance Data.Data.Data Network.AWS.Batch.UpdateJobQueue.UpdateJobQueueResponse
instance GHC.Show.Show Network.AWS.Batch.UpdateJobQueue.UpdateJobQueueResponse
instance GHC.Read.Read Network.AWS.Batch.UpdateJobQueue.UpdateJobQueueResponse
instance GHC.Classes.Eq Network.AWS.Batch.UpdateJobQueue.UpdateJobQueueResponse
instance GHC.Generics.Generic Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance Data.Data.Data Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance GHC.Show.Show Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance GHC.Read.Read Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance GHC.Classes.Eq Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance Data.Hashable.Class.Hashable Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance Control.DeepSeq.NFData Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.UpdateJobQueue.UpdateJobQueue
instance Control.DeepSeq.NFData Network.AWS.Batch.UpdateJobQueue.UpdateJobQueueResponse
module Network.AWS.Batch.Waiters
-- | Terminates a job in a job queue. Jobs that are in the
-- STARTING or RUNNING state are terminated, which
-- causes them to transition to FAILED . Jobs that have not
-- progressed to the STARTING state are cancelled.
module Network.AWS.Batch.TerminateJob
-- | Creates a value of TerminateJob with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - tjJobId - The AWS Batch job ID of the job to
-- terminate.
-- - tjReason - A message to attach to the job that explains the
-- reason for cancelling it. This message is returned by future
-- DescribeJobs operations on the job. This message is also
-- recorded in the AWS Batch activity logs.
--
terminateJob :: Text -> Text -> TerminateJob
-- | See: terminateJob smart constructor.
data TerminateJob
-- | The AWS Batch job ID of the job to terminate.
tjJobId :: Lens' TerminateJob Text
-- | A message to attach to the job that explains the reason for cancelling
-- it. This message is returned by future DescribeJobs
-- operations on the job. This message is also recorded in the AWS Batch
-- activity logs.
tjReason :: Lens' TerminateJob Text
-- | Creates a value of TerminateJobResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
terminateJobResponse :: Int -> TerminateJobResponse
-- | See: terminateJobResponse smart constructor.
data TerminateJobResponse
-- |
-- - - | The response status code.
--
tjrsResponseStatus :: Lens' TerminateJobResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.TerminateJob.TerminateJobResponse
instance Data.Data.Data Network.AWS.Batch.TerminateJob.TerminateJobResponse
instance GHC.Show.Show Network.AWS.Batch.TerminateJob.TerminateJobResponse
instance GHC.Read.Read Network.AWS.Batch.TerminateJob.TerminateJobResponse
instance GHC.Classes.Eq Network.AWS.Batch.TerminateJob.TerminateJobResponse
instance GHC.Generics.Generic Network.AWS.Batch.TerminateJob.TerminateJob
instance Data.Data.Data Network.AWS.Batch.TerminateJob.TerminateJob
instance GHC.Show.Show Network.AWS.Batch.TerminateJob.TerminateJob
instance GHC.Read.Read Network.AWS.Batch.TerminateJob.TerminateJob
instance GHC.Classes.Eq Network.AWS.Batch.TerminateJob.TerminateJob
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.TerminateJob.TerminateJob
instance Data.Hashable.Class.Hashable Network.AWS.Batch.TerminateJob.TerminateJob
instance Control.DeepSeq.NFData Network.AWS.Batch.TerminateJob.TerminateJob
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.TerminateJob.TerminateJob
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.TerminateJob.TerminateJob
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.TerminateJob.TerminateJob
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.TerminateJob.TerminateJob
instance Control.DeepSeq.NFData Network.AWS.Batch.TerminateJob.TerminateJobResponse
-- | Submits an AWS Batch job from a job definition. Parameters specified
-- during SubmitJob override parameters defined in the job
-- definition.
module Network.AWS.Batch.SubmitJob
-- | Creates a value of SubmitJob with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - sjContainerOverrides - A list of container overrides in
-- JSON format that specify the name of a container in the specified job
-- definition and the overrides it should receive. You can override the
-- default command for a container (that is specified in the job
-- definition or the Docker image) with a command override. You
-- can also override existing environment variables (that are specified
-- in the job definition or Docker image) on a container or add new
-- environment variables to it with an environment
-- override.
-- - sjRetryStrategy - The retry strategy to use for failed jobs
-- from this SubmitJob operation. When a retry strategy is
-- specified here, it overrides the retry strategy defined in the job
-- definition.
-- - sjDependsOn - A list of job IDs on which this job depends.
-- A job can depend upon a maximum of 20 jobs.
-- - sjParameters - Additional parameters passed to the job that
-- replace parameter substitution placeholders that are set in the job
-- definition. Parameters are specified as a key and value pair mapping.
-- Parameters in a SubmitJob request override any corresponding
-- parameter defaults from the job definition.
-- - sjJobName - The name of the job. The first character must
-- be alphanumeric, and up to 128 letters (uppercase and lowercase),
-- numbers, hyphens, and underscores are allowed.
-- - sjJobQueue - The job queue into which the job will be
-- submitted. You can specify either the name or the Amazon Resource Name
-- (ARN) of the queue.
-- - sjJobDefinition - The job definition used by this job. This
-- value can be either a name:revision or the Amazon Resource
-- Name (ARN) for the job definition.
--
submitJob :: Text -> Text -> Text -> SubmitJob
-- | See: submitJob smart constructor.
data SubmitJob
-- | A list of container overrides in JSON format that specify the name of
-- a container in the specified job definition and the overrides it
-- should receive. You can override the default command for a container
-- (that is specified in the job definition or the Docker image) with a
-- command override. You can also override existing environment
-- variables (that are specified in the job definition or Docker image)
-- on a container or add new environment variables to it with an
-- environment override.
sjContainerOverrides :: Lens' SubmitJob (Maybe ContainerOverrides)
-- | The retry strategy to use for failed jobs from this SubmitJob
-- operation. When a retry strategy is specified here, it overrides the
-- retry strategy defined in the job definition.
sjRetryStrategy :: Lens' SubmitJob (Maybe RetryStrategy)
-- | A list of job IDs on which this job depends. A job can depend upon a
-- maximum of 20 jobs.
sjDependsOn :: Lens' SubmitJob [JobDependency]
-- | Additional parameters passed to the job that replace parameter
-- substitution placeholders that are set in the job definition.
-- Parameters are specified as a key and value pair mapping. Parameters
-- in a SubmitJob request override any corresponding parameter
-- defaults from the job definition.
sjParameters :: Lens' SubmitJob (HashMap Text Text)
-- | The name of the job. The first character must be alphanumeric, and up
-- to 128 letters (uppercase and lowercase), numbers, hyphens, and
-- underscores are allowed.
sjJobName :: Lens' SubmitJob Text
-- | The job queue into which the job will be submitted. You can specify
-- either the name or the Amazon Resource Name (ARN) of the queue.
sjJobQueue :: Lens' SubmitJob Text
-- | The job definition used by this job. This value can be either a
-- name:revision or the Amazon Resource Name (ARN) for the job
-- definition.
sjJobDefinition :: Lens' SubmitJob Text
-- | Creates a value of SubmitJobResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
submitJobResponse :: Int -> Text -> Text -> SubmitJobResponse
-- | See: submitJobResponse smart constructor.
data SubmitJobResponse
-- |
-- - - | The response status code.
--
sjrsResponseStatus :: Lens' SubmitJobResponse Int
-- | The name of the job.
sjrsJobName :: Lens' SubmitJobResponse Text
-- | The unique identifier for the job.
sjrsJobId :: Lens' SubmitJobResponse Text
instance GHC.Generics.Generic Network.AWS.Batch.SubmitJob.SubmitJobResponse
instance Data.Data.Data Network.AWS.Batch.SubmitJob.SubmitJobResponse
instance GHC.Show.Show Network.AWS.Batch.SubmitJob.SubmitJobResponse
instance GHC.Read.Read Network.AWS.Batch.SubmitJob.SubmitJobResponse
instance GHC.Classes.Eq Network.AWS.Batch.SubmitJob.SubmitJobResponse
instance GHC.Generics.Generic Network.AWS.Batch.SubmitJob.SubmitJob
instance Data.Data.Data Network.AWS.Batch.SubmitJob.SubmitJob
instance GHC.Show.Show Network.AWS.Batch.SubmitJob.SubmitJob
instance GHC.Read.Read Network.AWS.Batch.SubmitJob.SubmitJob
instance GHC.Classes.Eq Network.AWS.Batch.SubmitJob.SubmitJob
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.SubmitJob.SubmitJob
instance Data.Hashable.Class.Hashable Network.AWS.Batch.SubmitJob.SubmitJob
instance Control.DeepSeq.NFData Network.AWS.Batch.SubmitJob.SubmitJob
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.SubmitJob.SubmitJob
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.SubmitJob.SubmitJob
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.SubmitJob.SubmitJob
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.SubmitJob.SubmitJob
instance Control.DeepSeq.NFData Network.AWS.Batch.SubmitJob.SubmitJobResponse
-- | Registers an AWS Batch job definition.
module Network.AWS.Batch.RegisterJobDefinition
-- | Creates a value of RegisterJobDefinition with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - rjdRetryStrategy - The retry strategy to use for failed
-- jobs that are submitted with this job definition. Any retry strategy
-- that is specified during a SubmitJob operation overrides the
-- retry strategy defined here.
-- - rjdParameters - Default parameter substitution placeholders
-- to set in the job definition. Parameters are specified as a key-value
-- pair mapping. Parameters in a SubmitJob request override any
-- corresponding parameter defaults from the job definition.
-- - rjdContainerProperties - An object with various properties
-- specific for container-based jobs. This parameter is required if the
-- type parameter is container .
-- - rjdJobDefinitionName - The name of the job definition to
-- register. Up to 128 letters (uppercase and lowercase), numbers,
-- hyphens, and underscores are allowed.
-- - rjdType - The type of job definition.
--
registerJobDefinition :: Text -> JobDefinitionType -> RegisterJobDefinition
-- | See: registerJobDefinition smart constructor.
data RegisterJobDefinition
-- | The retry strategy to use for failed jobs that are submitted with this
-- job definition. Any retry strategy that is specified during a
-- SubmitJob operation overrides the retry strategy defined
-- here.
rjdRetryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy)
-- | Default parameter substitution placeholders to set in the job
-- definition. Parameters are specified as a key-value pair mapping.
-- Parameters in a SubmitJob request override any corresponding
-- parameter defaults from the job definition.
rjdParameters :: Lens' RegisterJobDefinition (HashMap Text Text)
-- | An object with various properties specific for container-based jobs.
-- This parameter is required if the type parameter is
-- container .
rjdContainerProperties :: Lens' RegisterJobDefinition (Maybe ContainerProperties)
-- | The name of the job definition to register. Up to 128 letters
-- (uppercase and lowercase), numbers, hyphens, and underscores are
-- allowed.
rjdJobDefinitionName :: Lens' RegisterJobDefinition Text
-- | The type of job definition.
rjdType :: Lens' RegisterJobDefinition JobDefinitionType
-- | Creates a value of RegisterJobDefinitionResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
registerJobDefinitionResponse :: Int -> Text -> Text -> Int -> RegisterJobDefinitionResponse
-- | See: registerJobDefinitionResponse smart constructor.
data RegisterJobDefinitionResponse
-- |
-- - - | The response status code.
--
rjdrsResponseStatus :: Lens' RegisterJobDefinitionResponse Int
-- | The name of the job definition.
rjdrsJobDefinitionName :: Lens' RegisterJobDefinitionResponse Text
-- | The Amazon Resource Name (ARN) of the job definition.
rjdrsJobDefinitionARN :: Lens' RegisterJobDefinitionResponse Text
-- | The revision of the job definition.
rjdrsRevision :: Lens' RegisterJobDefinitionResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinitionResponse
instance Data.Data.Data Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinitionResponse
instance GHC.Show.Show Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinitionResponse
instance GHC.Read.Read Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinitionResponse
instance GHC.Classes.Eq Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinitionResponse
instance GHC.Generics.Generic Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance Data.Data.Data Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance GHC.Show.Show Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance GHC.Read.Read Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance GHC.Classes.Eq Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance Data.Hashable.Class.Hashable Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance Control.DeepSeq.NFData Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinition
instance Control.DeepSeq.NFData Network.AWS.Batch.RegisterJobDefinition.RegisterJobDefinitionResponse
-- | Returns a list of task jobs for a specified job queue. You can filter
-- the results by job status with the jobStatus parameter. If
-- you do not specify a status, only RUNNING jobs are returned.
module Network.AWS.Batch.ListJobs
-- | Creates a value of ListJobs with the minimum fields required to
-- make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - ljNextToken - The nextToken value returned from a
-- previous paginated ListJobs request where maxResults
-- was used and the results exceeded the value of that parameter.
-- Pagination continues from the end of the previous results that
-- returned the nextToken value. This value is null
-- when there are no more results to return.
-- - ljJobStatus - The job status with which to filter jobs in
-- the specified queue. If you do not specify a status, only
-- RUNNING jobs are returned.
-- - ljMaxResults - The maximum number of results returned by
-- ListJobs in paginated output. When this parameter is used,
-- ListJobs only returns maxResults results in a single
-- page along with a nextToken response element. The remaining
-- results of the initial request can be seen by sending another
-- ListJobs request with the returned nextToken value.
-- This value can be between 1 and 100. If this parameter is not used,
-- then ListJobs returns up to 100 results and a
-- nextToken value if applicable.
-- - ljJobQueue - The name or full Amazon Resource Name (ARN) of
-- the job queue with which to list jobs.
--
listJobs :: Text -> ListJobs
-- | See: listJobs smart constructor.
data ListJobs
-- | The nextToken value returned from a previous paginated
-- ListJobs request where maxResults was used and the
-- results exceeded the value of that parameter. Pagination continues
-- from the end of the previous results that returned the
-- nextToken value. This value is null when there are
-- no more results to return.
ljNextToken :: Lens' ListJobs (Maybe Text)
-- | The job status with which to filter jobs in the specified queue. If
-- you do not specify a status, only RUNNING jobs are returned.
ljJobStatus :: Lens' ListJobs (Maybe JobStatus)
-- | The maximum number of results returned by ListJobs in
-- paginated output. When this parameter is used, ListJobs only
-- returns maxResults results in a single page along with a
-- nextToken response element. The remaining results of the
-- initial request can be seen by sending another ListJobs
-- request with the returned nextToken value. This value can be
-- between 1 and 100. If this parameter is not used, then
-- ListJobs returns up to 100 results and a nextToken
-- value if applicable.
ljMaxResults :: Lens' ListJobs (Maybe Int)
-- | The name or full Amazon Resource Name (ARN) of the job queue with
-- which to list jobs.
ljJobQueue :: Lens' ListJobs Text
-- | Creates a value of ListJobsResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - ljrsNextToken - The nextToken value to include in
-- a future ListJobs request. When the results of a
-- ListJobs request exceed maxResults , this value can
-- be used to retrieve the next page of results. This value is
-- null when there are no more results to return.
-- - ljrsResponseStatus - -- | The response status code.
-- - ljrsJobSummaryList - A list of job summaries that match the
-- request.
--
listJobsResponse :: Int -> ListJobsResponse
-- | See: listJobsResponse smart constructor.
data ListJobsResponse
-- | The nextToken value to include in a future ListJobs
-- request. When the results of a ListJobs request exceed
-- maxResults , this value can be used to retrieve the next page
-- of results. This value is null when there are no more results
-- to return.
ljrsNextToken :: Lens' ListJobsResponse (Maybe Text)
-- |
-- - - | The response status code.
--
ljrsResponseStatus :: Lens' ListJobsResponse Int
-- | A list of job summaries that match the request.
ljrsJobSummaryList :: Lens' ListJobsResponse [JobSummary]
instance GHC.Generics.Generic Network.AWS.Batch.ListJobs.ListJobsResponse
instance Data.Data.Data Network.AWS.Batch.ListJobs.ListJobsResponse
instance GHC.Show.Show Network.AWS.Batch.ListJobs.ListJobsResponse
instance GHC.Read.Read Network.AWS.Batch.ListJobs.ListJobsResponse
instance GHC.Classes.Eq Network.AWS.Batch.ListJobs.ListJobsResponse
instance GHC.Generics.Generic Network.AWS.Batch.ListJobs.ListJobs
instance Data.Data.Data Network.AWS.Batch.ListJobs.ListJobs
instance GHC.Show.Show Network.AWS.Batch.ListJobs.ListJobs
instance GHC.Read.Read Network.AWS.Batch.ListJobs.ListJobs
instance GHC.Classes.Eq Network.AWS.Batch.ListJobs.ListJobs
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.ListJobs.ListJobs
instance Data.Hashable.Class.Hashable Network.AWS.Batch.ListJobs.ListJobs
instance Control.DeepSeq.NFData Network.AWS.Batch.ListJobs.ListJobs
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.ListJobs.ListJobs
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.ListJobs.ListJobs
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.ListJobs.ListJobs
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.ListJobs.ListJobs
instance Control.DeepSeq.NFData Network.AWS.Batch.ListJobs.ListJobsResponse
-- | Describes a list of AWS Batch jobs.
module Network.AWS.Batch.DescribeJobs
-- | Creates a value of DescribeJobs with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - djJobs - A space-separated list of up to 100 job IDs.
--
describeJobs :: DescribeJobs
-- | See: describeJobs smart constructor.
data DescribeJobs
-- | A space-separated list of up to 100 job IDs.
djJobs :: Lens' DescribeJobs [Text]
-- | Creates a value of DescribeJobsResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
describeJobsResponse :: Int -> DescribeJobsResponse
-- | See: describeJobsResponse smart constructor.
data DescribeJobsResponse
-- | The list of jobs.
djrsJobs :: Lens' DescribeJobsResponse [JobDetail]
-- |
-- - - | The response status code.
--
djrsResponseStatus :: Lens' DescribeJobsResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.DescribeJobs.DescribeJobsResponse
instance Data.Data.Data Network.AWS.Batch.DescribeJobs.DescribeJobsResponse
instance GHC.Show.Show Network.AWS.Batch.DescribeJobs.DescribeJobsResponse
instance GHC.Read.Read Network.AWS.Batch.DescribeJobs.DescribeJobsResponse
instance GHC.Classes.Eq Network.AWS.Batch.DescribeJobs.DescribeJobsResponse
instance GHC.Generics.Generic Network.AWS.Batch.DescribeJobs.DescribeJobs
instance Data.Data.Data Network.AWS.Batch.DescribeJobs.DescribeJobs
instance GHC.Show.Show Network.AWS.Batch.DescribeJobs.DescribeJobs
instance GHC.Read.Read Network.AWS.Batch.DescribeJobs.DescribeJobs
instance GHC.Classes.Eq Network.AWS.Batch.DescribeJobs.DescribeJobs
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.DescribeJobs.DescribeJobs
instance Data.Hashable.Class.Hashable Network.AWS.Batch.DescribeJobs.DescribeJobs
instance Control.DeepSeq.NFData Network.AWS.Batch.DescribeJobs.DescribeJobs
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.DescribeJobs.DescribeJobs
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.DescribeJobs.DescribeJobs
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.DescribeJobs.DescribeJobs
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.DescribeJobs.DescribeJobs
instance Control.DeepSeq.NFData Network.AWS.Batch.DescribeJobs.DescribeJobsResponse
-- | Describes one or more of your job queues.
module Network.AWS.Batch.DescribeJobQueues
-- | Creates a value of DescribeJobQueues with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - djqNextToken - The nextToken value returned from a
-- previous paginated DescribeJobQueues request where
-- maxResults was used and the results exceeded the value of
-- that parameter. Pagination continues from the end of the previous
-- results that returned the nextToken value. This value is
-- null when there are no more results to return.
-- - djqJobQueues - A list of up to 100 queue names or full
-- queue Amazon Resource Name (ARN) entries.
-- - djqMaxResults - The maximum number of results returned by
-- DescribeJobQueues in paginated output. When this parameter is
-- used, DescribeJobQueues only returns maxResults
-- results in a single page along with a nextToken response
-- element. The remaining results of the initial request can be seen by
-- sending another DescribeJobQueues request with the returned
-- nextToken value. This value can be between 1 and 100. If this
-- parameter is not used, then DescribeJobQueues returns up to
-- 100 results and a nextToken value if applicable.
--
describeJobQueues :: DescribeJobQueues
-- | See: describeJobQueues smart constructor.
data DescribeJobQueues
-- | The nextToken value returned from a previous paginated
-- DescribeJobQueues request where maxResults was used
-- and the results exceeded the value of that parameter. Pagination
-- continues from the end of the previous results that returned the
-- nextToken value. This value is null when there are
-- no more results to return.
djqNextToken :: Lens' DescribeJobQueues (Maybe Text)
-- | A list of up to 100 queue names or full queue Amazon Resource Name
-- (ARN) entries.
djqJobQueues :: Lens' DescribeJobQueues [Text]
-- | The maximum number of results returned by DescribeJobQueues
-- in paginated output. When this parameter is used,
-- DescribeJobQueues only returns maxResults results in
-- a single page along with a nextToken response element. The
-- remaining results of the initial request can be seen by sending
-- another DescribeJobQueues request with the returned
-- nextToken value. This value can be between 1 and 100. If this
-- parameter is not used, then DescribeJobQueues returns up to
-- 100 results and a nextToken value if applicable.
djqMaxResults :: Lens' DescribeJobQueues (Maybe Int)
-- | Creates a value of DescribeJobQueuesResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - djqsrsNextToken - The nextToken value to include
-- in a future DescribeJobQueues request. When the results of a
-- DescribeJobQueues request exceed maxResults , this
-- value can be used to retrieve the next page of results. This value is
-- null when there are no more results to return.
-- - djqsrsJobQueues - The list of job queues.
-- - djqsrsResponseStatus - -- | The response status code.
--
describeJobQueuesResponse :: Int -> DescribeJobQueuesResponse
-- | See: describeJobQueuesResponse smart constructor.
data DescribeJobQueuesResponse
-- | The nextToken value to include in a future
-- DescribeJobQueues request. When the results of a
-- DescribeJobQueues request exceed maxResults , this
-- value can be used to retrieve the next page of results. This value is
-- null when there are no more results to return.
djqsrsNextToken :: Lens' DescribeJobQueuesResponse (Maybe Text)
-- | The list of job queues.
djqsrsJobQueues :: Lens' DescribeJobQueuesResponse [JobQueueDetail]
-- |
-- - - | The response status code.
--
djqsrsResponseStatus :: Lens' DescribeJobQueuesResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.DescribeJobQueues.DescribeJobQueuesResponse
instance Data.Data.Data Network.AWS.Batch.DescribeJobQueues.DescribeJobQueuesResponse
instance GHC.Show.Show Network.AWS.Batch.DescribeJobQueues.DescribeJobQueuesResponse
instance GHC.Read.Read Network.AWS.Batch.DescribeJobQueues.DescribeJobQueuesResponse
instance GHC.Classes.Eq Network.AWS.Batch.DescribeJobQueues.DescribeJobQueuesResponse
instance GHC.Generics.Generic Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance Data.Data.Data Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance GHC.Show.Show Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance GHC.Read.Read Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance GHC.Classes.Eq Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance Data.Hashable.Class.Hashable Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance Control.DeepSeq.NFData Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.DescribeJobQueues.DescribeJobQueues
instance Control.DeepSeq.NFData Network.AWS.Batch.DescribeJobQueues.DescribeJobQueuesResponse
-- | Describes a list of job definitions. You can specify a status
-- (such as ACTIVE ) to only return job definitions that match
-- that status.
module Network.AWS.Batch.DescribeJobDefinitions
-- | Creates a value of DescribeJobDefinitions with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - djdStatus - The status with which to filter job
-- definitions.
-- - djdJobDefinitionName - The name of the job definition to
-- describe.
-- - djdJobDefinitions - A space-separated list of up to 100 job
-- definition names or full Amazon Resource Name (ARN) entries.
-- - djdNextToken - The nextToken value returned from a
-- previous paginated DescribeJobDefinitions request where
-- maxResults was used and the results exceeded the value of
-- that parameter. Pagination continues from the end of the previous
-- results that returned the nextToken value. This value is
-- null when there are no more results to return.
-- - djdMaxResults - The maximum number of results returned by
-- DescribeJobDefinitions in paginated output. When this
-- parameter is used, DescribeJobDefinitions only returns
-- maxResults results in a single page along with a
-- nextToken response element. The remaining results of the
-- initial request can be seen by sending another
-- DescribeJobDefinitions request with the returned
-- nextToken value. This value can be between 1 and 100. If this
-- parameter is not used, then DescribeJobDefinitions returns up
-- to 100 results and a nextToken value if applicable.
--
describeJobDefinitions :: DescribeJobDefinitions
-- | See: describeJobDefinitions smart constructor.
data DescribeJobDefinitions
-- | The status with which to filter job definitions.
djdStatus :: Lens' DescribeJobDefinitions (Maybe Text)
-- | The name of the job definition to describe.
djdJobDefinitionName :: Lens' DescribeJobDefinitions (Maybe Text)
-- | A space-separated list of up to 100 job definition names or full
-- Amazon Resource Name (ARN) entries.
djdJobDefinitions :: Lens' DescribeJobDefinitions [Text]
-- | The nextToken value returned from a previous paginated
-- DescribeJobDefinitions request where maxResults was
-- used and the results exceeded the value of that parameter. Pagination
-- continues from the end of the previous results that returned the
-- nextToken value. This value is null when there are
-- no more results to return.
djdNextToken :: Lens' DescribeJobDefinitions (Maybe Text)
-- | The maximum number of results returned by
-- DescribeJobDefinitions in paginated output. When this
-- parameter is used, DescribeJobDefinitions only returns
-- maxResults results in a single page along with a
-- nextToken response element. The remaining results of the
-- initial request can be seen by sending another
-- DescribeJobDefinitions request with the returned
-- nextToken value. This value can be between 1 and 100. If this
-- parameter is not used, then DescribeJobDefinitions returns up
-- to 100 results and a nextToken value if applicable.
djdMaxResults :: Lens' DescribeJobDefinitions (Maybe Int)
-- | Creates a value of DescribeJobDefinitionsResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - djdrsJobDefinitions - The list of job definitions.
-- - djdrsNextToken - The nextToken value to include in
-- a future DescribeJobDefinitions request. When the results of
-- a DescribeJobDefinitions request exceed maxResults ,
-- this value can be used to retrieve the next page of results. This
-- value is null when there are no more results to return.
-- - djdrsResponseStatus - -- | The response status code.
--
describeJobDefinitionsResponse :: Int -> DescribeJobDefinitionsResponse
-- | See: describeJobDefinitionsResponse smart constructor.
data DescribeJobDefinitionsResponse
-- | The list of job definitions.
djdrsJobDefinitions :: Lens' DescribeJobDefinitionsResponse [JobDefinition]
-- | The nextToken value to include in a future
-- DescribeJobDefinitions request. When the results of a
-- DescribeJobDefinitions request exceed maxResults ,
-- this value can be used to retrieve the next page of results. This
-- value is null when there are no more results to return.
djdrsNextToken :: Lens' DescribeJobDefinitionsResponse (Maybe Text)
-- |
-- - - | The response status code.
--
djdrsResponseStatus :: Lens' DescribeJobDefinitionsResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitionsResponse
instance Data.Data.Data Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitionsResponse
instance GHC.Show.Show Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitionsResponse
instance GHC.Read.Read Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitionsResponse
instance GHC.Classes.Eq Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitionsResponse
instance GHC.Generics.Generic Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance Data.Data.Data Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance GHC.Show.Show Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance GHC.Read.Read Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance GHC.Classes.Eq Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance Data.Hashable.Class.Hashable Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance Control.DeepSeq.NFData Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitions
instance Control.DeepSeq.NFData Network.AWS.Batch.DescribeJobDefinitions.DescribeJobDefinitionsResponse
-- | Describes one or more of your compute environments.
--
-- If you are using an unmanaged compute environment, you can use the
-- DescribeComputeEnvironment operation to determine the
-- ecsClusterArn that you should launch your Amazon ECS
-- container instances into.
module Network.AWS.Batch.DescribeComputeEnvironments
-- | Creates a value of DescribeComputeEnvironments with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dceComputeEnvironments - A list of up to 100 compute
-- environment names or full Amazon Resource Name (ARN) entries.
-- - dceNextToken - The nextToken value returned from a
-- previous paginated DescribeComputeEnvironments request where
-- maxResults was used and the results exceeded the value of
-- that parameter. Pagination continues from the end of the previous
-- results that returned the nextToken value. This value is
-- null when there are no more results to return.
-- - dceMaxResults - The maximum number of cluster results
-- returned by DescribeComputeEnvironments in paginated output.
-- When this parameter is used, DescribeComputeEnvironments only
-- returns maxResults results in a single page along with a
-- nextToken response element. The remaining results of the
-- initial request can be seen by sending another
-- DescribeComputeEnvironments request with the returned
-- nextToken value. This value can be between 1 and 100. If this
-- parameter is not used, then DescribeComputeEnvironments
-- returns up to 100 results and a nextToken value if
-- applicable.
--
describeComputeEnvironments :: DescribeComputeEnvironments
-- | See: describeComputeEnvironments smart constructor.
data DescribeComputeEnvironments
-- | A list of up to 100 compute environment names or full Amazon Resource
-- Name (ARN) entries.
dceComputeEnvironments :: Lens' DescribeComputeEnvironments [Text]
-- | The nextToken value returned from a previous paginated
-- DescribeComputeEnvironments request where maxResults
-- was used and the results exceeded the value of that parameter.
-- Pagination continues from the end of the previous results that
-- returned the nextToken value. This value is null
-- when there are no more results to return.
dceNextToken :: Lens' DescribeComputeEnvironments (Maybe Text)
-- | The maximum number of cluster results returned by
-- DescribeComputeEnvironments in paginated output. When this
-- parameter is used, DescribeComputeEnvironments only returns
-- maxResults results in a single page along with a
-- nextToken response element. The remaining results of the
-- initial request can be seen by sending another
-- DescribeComputeEnvironments request with the returned
-- nextToken value. This value can be between 1 and 100. If this
-- parameter is not used, then DescribeComputeEnvironments
-- returns up to 100 results and a nextToken value if
-- applicable.
dceMaxResults :: Lens' DescribeComputeEnvironments (Maybe Int)
-- | Creates a value of DescribeComputeEnvironmentsResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - drsComputeEnvironments - The list of compute
-- environments.
-- - drsNextToken - The nextToken value to include in a
-- future DescribeComputeEnvironments request. When the results
-- of a DescribeJobDefinitions request exceed
-- maxResults , this value can be used to retrieve the next page
-- of results. This value is null when there are no more results
-- to return.
-- - drsResponseStatus - -- | The response status code.
--
describeComputeEnvironmentsResponse :: Int -> DescribeComputeEnvironmentsResponse
-- | See: describeComputeEnvironmentsResponse smart
-- constructor.
data DescribeComputeEnvironmentsResponse
-- | The list of compute environments.
drsComputeEnvironments :: Lens' DescribeComputeEnvironmentsResponse [ComputeEnvironmentDetail]
-- | The nextToken value to include in a future
-- DescribeComputeEnvironments request. When the results of a
-- DescribeJobDefinitions request exceed maxResults ,
-- this value can be used to retrieve the next page of results. This
-- value is null when there are no more results to return.
drsNextToken :: Lens' DescribeComputeEnvironmentsResponse (Maybe Text)
-- |
-- - - | The response status code.
--
drsResponseStatus :: Lens' DescribeComputeEnvironmentsResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironmentsResponse
instance Data.Data.Data Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironmentsResponse
instance GHC.Show.Show Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironmentsResponse
instance GHC.Read.Read Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironmentsResponse
instance GHC.Classes.Eq Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironmentsResponse
instance GHC.Generics.Generic Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance Data.Data.Data Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance GHC.Show.Show Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance GHC.Read.Read Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance GHC.Classes.Eq Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance Data.Hashable.Class.Hashable Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance Control.DeepSeq.NFData Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironments
instance Control.DeepSeq.NFData Network.AWS.Batch.DescribeComputeEnvironments.DescribeComputeEnvironmentsResponse
-- | Deregisters an AWS Batch job definition.
module Network.AWS.Batch.DeregisterJobDefinition
-- | Creates a value of DeregisterJobDefinition with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - djdJobDefinition - The name and revision
-- (name:revision ) or full Amazon Resource Name (ARN) of the
-- job definition to deregister.
--
deregisterJobDefinition :: Text -> DeregisterJobDefinition
-- | See: deregisterJobDefinition smart constructor.
data DeregisterJobDefinition
-- | The name and revision (name:revision ) or full Amazon
-- Resource Name (ARN) of the job definition to deregister.
djdJobDefinition :: Lens' DeregisterJobDefinition Text
-- | Creates a value of DeregisterJobDefinitionResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deregisterJobDefinitionResponse :: Int -> DeregisterJobDefinitionResponse
-- | See: deregisterJobDefinitionResponse smart constructor.
data DeregisterJobDefinitionResponse
-- |
-- - - | The response status code.
--
derrsResponseStatus :: Lens' DeregisterJobDefinitionResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinitionResponse
instance Data.Data.Data Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinitionResponse
instance GHC.Show.Show Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinitionResponse
instance GHC.Read.Read Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinitionResponse
instance GHC.Classes.Eq Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinitionResponse
instance GHC.Generics.Generic Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance Data.Data.Data Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance GHC.Show.Show Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance GHC.Read.Read Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance GHC.Classes.Eq Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance Data.Hashable.Class.Hashable Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance Control.DeepSeq.NFData Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinition
instance Control.DeepSeq.NFData Network.AWS.Batch.DeregisterJobDefinition.DeregisterJobDefinitionResponse
-- | Deletes the specified job queue. You must first disable submissions
-- for a queue with the UpdateJobQueue operation. All jobs in
-- the queue are terminated when you delete a job queue.
--
-- It is not necessary to disassociate compute environments from a queue
-- before submitting a DeleteJobQueue request.
module Network.AWS.Batch.DeleteJobQueue
-- | Creates a value of DeleteJobQueue with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - djqJobQueue - The short name or full Amazon Resource Name
-- (ARN) of the queue to delete.
--
deleteJobQueue :: Text -> DeleteJobQueue
-- | See: deleteJobQueue smart constructor.
data DeleteJobQueue
-- | The short name or full Amazon Resource Name (ARN) of the queue to
-- delete.
djqJobQueue :: Lens' DeleteJobQueue Text
-- | Creates a value of DeleteJobQueueResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteJobQueueResponse :: Int -> DeleteJobQueueResponse
-- | See: deleteJobQueueResponse smart constructor.
data DeleteJobQueueResponse
-- |
-- - - | The response status code.
--
djqrsResponseStatus :: Lens' DeleteJobQueueResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.DeleteJobQueue.DeleteJobQueueResponse
instance Data.Data.Data Network.AWS.Batch.DeleteJobQueue.DeleteJobQueueResponse
instance GHC.Show.Show Network.AWS.Batch.DeleteJobQueue.DeleteJobQueueResponse
instance GHC.Read.Read Network.AWS.Batch.DeleteJobQueue.DeleteJobQueueResponse
instance GHC.Classes.Eq Network.AWS.Batch.DeleteJobQueue.DeleteJobQueueResponse
instance GHC.Generics.Generic Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance Data.Data.Data Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance GHC.Show.Show Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance GHC.Read.Read Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance GHC.Classes.Eq Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance Data.Hashable.Class.Hashable Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance Control.DeepSeq.NFData Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.DeleteJobQueue.DeleteJobQueue
instance Control.DeepSeq.NFData Network.AWS.Batch.DeleteJobQueue.DeleteJobQueueResponse
-- | Deletes an AWS Batch compute environment.
--
-- Before you can delete a compute environment, you must set its state to
-- DISABLED with the UpdateComputeEnvironment API
-- operation and disassociate it from any job queues with the
-- UpdateJobQueue API operation.
module Network.AWS.Batch.DeleteComputeEnvironment
-- | Creates a value of DeleteComputeEnvironment with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - dceComputeEnvironment - The name or Amazon Resource Name
-- (ARN) of the compute environment to delete.
--
deleteComputeEnvironment :: Text -> DeleteComputeEnvironment
-- | See: deleteComputeEnvironment smart constructor.
data DeleteComputeEnvironment
-- | The name or Amazon Resource Name (ARN) of the compute environment to
-- delete.
dceComputeEnvironment :: Lens' DeleteComputeEnvironment Text
-- | Creates a value of DeleteComputeEnvironmentResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
deleteComputeEnvironmentResponse :: Int -> DeleteComputeEnvironmentResponse
-- | See: deleteComputeEnvironmentResponse smart constructor.
data DeleteComputeEnvironmentResponse
-- |
-- - - | The response status code.
--
dcersResponseStatus :: Lens' DeleteComputeEnvironmentResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironmentResponse
instance Data.Data.Data Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironmentResponse
instance GHC.Show.Show Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironmentResponse
instance GHC.Read.Read Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironmentResponse
instance GHC.Classes.Eq Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironmentResponse
instance GHC.Generics.Generic Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance Data.Data.Data Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance GHC.Show.Show Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance GHC.Read.Read Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance GHC.Classes.Eq Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance Data.Hashable.Class.Hashable Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance Control.DeepSeq.NFData Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironment
instance Control.DeepSeq.NFData Network.AWS.Batch.DeleteComputeEnvironment.DeleteComputeEnvironmentResponse
-- | Creates an AWS Batch job queue. When you create a job queue, you
-- associate one or more compute environments to the queue and assign an
-- order of preference for the compute environments.
--
-- You also set a priority to the job queue that determines the order in
-- which the AWS Batch scheduler places jobs onto its associated compute
-- environments. For example, if a compute environment is associated with
-- more than one job queue, the job queue with a higher priority is given
-- preference for scheduling jobs to that compute environment.
module Network.AWS.Batch.CreateJobQueue
-- | Creates a value of CreateJobQueue with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - cjqState - The state of the job queue. If the job queue
-- state is ENABLED , it is able to accept jobs.
-- - cjqJobQueueName - The name of the job queue.
-- - cjqPriority - The priority of the job queue. Job queues
-- with a higher priority (or a higher integer value for the
-- priority parameter) are evaluated first when associated with
-- same compute environment. Priority is determined in descending order,
-- for example, a job queue with a priority value of 10 is given
-- scheduling preference over a job queue with a priority value of
-- 1 .
-- - cjqComputeEnvironmentOrder - The set of compute
-- environments mapped to a job queue and their order relative to each
-- other. The job scheduler uses this parameter to determine which
-- compute environment should execute a given job. Compute environments
-- must be in the VALID state before you can associate them with
-- a job queue. You can associate up to 3 compute environments with a job
-- queue.
--
createJobQueue :: Text -> Int -> CreateJobQueue
-- | See: createJobQueue smart constructor.
data CreateJobQueue
-- | The state of the job queue. If the job queue state is ENABLED
-- , it is able to accept jobs.
cjqState :: Lens' CreateJobQueue (Maybe JQState)
-- | The name of the job queue.
cjqJobQueueName :: Lens' CreateJobQueue Text
-- | The priority of the job queue. Job queues with a higher priority (or a
-- higher integer value for the priority parameter) are
-- evaluated first when associated with same compute environment.
-- Priority is determined in descending order, for example, a job queue
-- with a priority value of 10 is given scheduling preference
-- over a job queue with a priority value of 1 .
cjqPriority :: Lens' CreateJobQueue Int
-- | The set of compute environments mapped to a job queue and their order
-- relative to each other. The job scheduler uses this parameter to
-- determine which compute environment should execute a given job.
-- Compute environments must be in the VALID state before you
-- can associate them with a job queue. You can associate up to 3 compute
-- environments with a job queue.
cjqComputeEnvironmentOrder :: Lens' CreateJobQueue [ComputeEnvironmentOrder]
-- | Creates a value of CreateJobQueueResponse with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createJobQueueResponse :: Int -> Text -> Text -> CreateJobQueueResponse
-- | See: createJobQueueResponse smart constructor.
data CreateJobQueueResponse
-- |
-- - - | The response status code.
--
cjqrsResponseStatus :: Lens' CreateJobQueueResponse Int
-- | The name of the job queue.
cjqrsJobQueueName :: Lens' CreateJobQueueResponse Text
-- | The Amazon Resource Name (ARN) of the job queue.
cjqrsJobQueueARN :: Lens' CreateJobQueueResponse Text
instance GHC.Generics.Generic Network.AWS.Batch.CreateJobQueue.CreateJobQueueResponse
instance Data.Data.Data Network.AWS.Batch.CreateJobQueue.CreateJobQueueResponse
instance GHC.Show.Show Network.AWS.Batch.CreateJobQueue.CreateJobQueueResponse
instance GHC.Read.Read Network.AWS.Batch.CreateJobQueue.CreateJobQueueResponse
instance GHC.Classes.Eq Network.AWS.Batch.CreateJobQueue.CreateJobQueueResponse
instance GHC.Generics.Generic Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance Data.Data.Data Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance GHC.Show.Show Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance GHC.Read.Read Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance GHC.Classes.Eq Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance Data.Hashable.Class.Hashable Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance Control.DeepSeq.NFData Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.CreateJobQueue.CreateJobQueue
instance Control.DeepSeq.NFData Network.AWS.Batch.CreateJobQueue.CreateJobQueueResponse
-- | Creates an AWS Batch compute environment. You can create
-- MANAGED or UNMANAGED compute environments.
--
-- In a managed compute environment, AWS Batch manages the compute
-- resources within the environment, based on the compute resources that
-- you specify. Instances launched into a managed compute environment use
-- a recent, approved version of the Amazon ECS-optimized AMI. You can
-- choose to use Amazon EC2 On-Demand instances in your managed compute
-- environment, or you can use Amazon EC2 Spot instances that only launch
-- when the Spot bid price is below a specified percentage of the
-- On-Demand price.
--
-- In an unmanaged compute environment, you can manage your own compute
-- resources. This provides more compute resource configuration options,
-- such as using a custom AMI, but you must ensure that your AMI meets
-- the Amazon ECS container instance AMI specification. For more
-- information, see Container Instance AMIs in the Amazon EC2
-- Container Service Developer Guide . After you have created your
-- unmanaged compute environment, you can use the
-- DescribeComputeEnvironments operation to find the Amazon ECS
-- cluster that is associated with it and then manually launch your
-- container instances into that Amazon ECS cluster. For more
-- information, see Launching an Amazon ECS Container Instance in
-- the Amazon EC2 Container Service Developer Guide .
module Network.AWS.Batch.CreateComputeEnvironment
-- | Creates a value of CreateComputeEnvironment with the minimum
-- fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - cceState - The state of the compute environment. If the
-- state is ENABLED , then the compute environment accepts jobs
-- from a queue and can scale out automatically based on queues.
-- - cceComputeResources - Details of the compute resources
-- managed by the compute environment. This parameter is required for
-- managed compute environments.
-- - cceComputeEnvironmentName - The name for your compute
-- environment. Up to 128 letters (uppercase and lowercase), numbers,
-- hyphens, and underscores are allowed.
-- - cceType - The type of the compute environment.
-- - cceServiceRole - The full Amazon Resource Name (ARN) of the
-- IAM role that allows AWS Batch to make calls to other AWS services on
-- your behalf. If your specified role has a path other than / ,
-- then you must either specify the full role ARN (this is recommended)
-- or prefix the role name with the path.
--
createComputeEnvironment :: Text -> CEType -> Text -> CreateComputeEnvironment
-- | See: createComputeEnvironment smart constructor.
data CreateComputeEnvironment
-- | The state of the compute environment. If the state is ENABLED
-- , then the compute environment accepts jobs from a queue and can scale
-- out automatically based on queues.
cceState :: Lens' CreateComputeEnvironment (Maybe CEState)
-- | Details of the compute resources managed by the compute environment.
-- This parameter is required for managed compute environments.
cceComputeResources :: Lens' CreateComputeEnvironment (Maybe ComputeResource)
-- | The name for your compute environment. Up to 128 letters (uppercase
-- and lowercase), numbers, hyphens, and underscores are allowed.
cceComputeEnvironmentName :: Lens' CreateComputeEnvironment Text
-- | The type of the compute environment.
cceType :: Lens' CreateComputeEnvironment CEType
-- | The full Amazon Resource Name (ARN) of the IAM role that allows AWS
-- Batch to make calls to other AWS services on your behalf. If your
-- specified role has a path other than / , then you must either
-- specify the full role ARN (this is recommended) or prefix the role
-- name with the path.
cceServiceRole :: Lens' CreateComputeEnvironment Text
-- | Creates a value of CreateComputeEnvironmentResponse with the
-- minimum fields required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
createComputeEnvironmentResponse :: Int -> CreateComputeEnvironmentResponse
-- | See: createComputeEnvironmentResponse smart constructor.
data CreateComputeEnvironmentResponse
-- | The name of the compute environment.
ccersComputeEnvironmentName :: Lens' CreateComputeEnvironmentResponse (Maybe Text)
-- | The Amazon Resource Name (ARN) of the compute environment.
ccersComputeEnvironmentARN :: Lens' CreateComputeEnvironmentResponse (Maybe Text)
-- |
-- - - | The response status code.
--
ccersResponseStatus :: Lens' CreateComputeEnvironmentResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironmentResponse
instance Data.Data.Data Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironmentResponse
instance GHC.Show.Show Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironmentResponse
instance GHC.Read.Read Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironmentResponse
instance GHC.Classes.Eq Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironmentResponse
instance GHC.Generics.Generic Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance Data.Data.Data Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance GHC.Show.Show Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance GHC.Read.Read Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance GHC.Classes.Eq Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance Data.Hashable.Class.Hashable Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance Control.DeepSeq.NFData Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironment
instance Control.DeepSeq.NFData Network.AWS.Batch.CreateComputeEnvironment.CreateComputeEnvironmentResponse
-- | Cancels a job in an AWS Batch job queue. Jobs that are in the
-- SUBMITTED , PENDING , or RUNNABLE state are
-- cancelled. Jobs that have progressed to STARTING or
-- RUNNING are not cancelled (but the API operation still
-- succeeds, even if no job is cancelled); these jobs must be terminated
-- with the TerminateJob operation.
module Network.AWS.Batch.CancelJob
-- | Creates a value of CancelJob with the minimum fields required
-- to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
-- - cjJobId - The AWS Batch job ID of the job to cancel.
-- - cjReason - A message to attach to the job that explains the
-- reason for cancelling it. This message is returned by future
-- DescribeJobs operations on the job. This message is also
-- recorded in the AWS Batch activity logs.
--
cancelJob :: Text -> Text -> CancelJob
-- | See: cancelJob smart constructor.
data CancelJob
-- | The AWS Batch job ID of the job to cancel.
cjJobId :: Lens' CancelJob Text
-- | A message to attach to the job that explains the reason for cancelling
-- it. This message is returned by future DescribeJobs
-- operations on the job. This message is also recorded in the AWS Batch
-- activity logs.
cjReason :: Lens' CancelJob Text
-- | Creates a value of CancelJobResponse with the minimum fields
-- required to make a request.
--
-- Use one of the following lenses to modify other fields as desired:
--
--
cancelJobResponse :: Int -> CancelJobResponse
-- | See: cancelJobResponse smart constructor.
data CancelJobResponse
-- |
-- - - | The response status code.
--
cjrsResponseStatus :: Lens' CancelJobResponse Int
instance GHC.Generics.Generic Network.AWS.Batch.CancelJob.CancelJobResponse
instance Data.Data.Data Network.AWS.Batch.CancelJob.CancelJobResponse
instance GHC.Show.Show Network.AWS.Batch.CancelJob.CancelJobResponse
instance GHC.Read.Read Network.AWS.Batch.CancelJob.CancelJobResponse
instance GHC.Classes.Eq Network.AWS.Batch.CancelJob.CancelJobResponse
instance GHC.Generics.Generic Network.AWS.Batch.CancelJob.CancelJob
instance Data.Data.Data Network.AWS.Batch.CancelJob.CancelJob
instance GHC.Show.Show Network.AWS.Batch.CancelJob.CancelJob
instance GHC.Read.Read Network.AWS.Batch.CancelJob.CancelJob
instance GHC.Classes.Eq Network.AWS.Batch.CancelJob.CancelJob
instance Network.AWS.Types.AWSRequest Network.AWS.Batch.CancelJob.CancelJob
instance Data.Hashable.Class.Hashable Network.AWS.Batch.CancelJob.CancelJob
instance Control.DeepSeq.NFData Network.AWS.Batch.CancelJob.CancelJob
instance Network.AWS.Data.Headers.ToHeaders Network.AWS.Batch.CancelJob.CancelJob
instance Data.Aeson.Types.ToJSON.ToJSON Network.AWS.Batch.CancelJob.CancelJob
instance Network.AWS.Data.Path.ToPath Network.AWS.Batch.CancelJob.CancelJob
instance Network.AWS.Data.Query.ToQuery Network.AWS.Batch.CancelJob.CancelJob
instance Control.DeepSeq.NFData Network.AWS.Batch.CancelJob.CancelJobResponse
-- | AWS Batch enables you to run batch computing workloads on the AWS
-- Cloud. Batch computing is a common way for developers, scientists, and
-- engineers to access large amounts of compute resources, and AWS Batch
-- removes the undifferentiated heavy lifting of configuring and managing
-- the required infrastructure. AWS Batch will be familiar to users of
-- traditional batch computing software. This service can efficiently
-- provision resources in response to jobs submitted in order to
-- eliminate capacity constraints, reduce compute costs, and deliver
-- results quickly.
--
-- As a fully managed service, AWS Batch enables developers, scientists,
-- and engineers to run batch computing workloads of any scale. AWS Batch
-- automatically provisions compute resources and optimizes the workload
-- distribution based on the quantity and scale of the workloads. With
-- AWS Batch, there is no need to install or manage batch computing
-- software, which allows you to focus on analyzing results and solving
-- problems. AWS Batch reduces operational complexities, saves time, and
-- reduces costs, which makes it easy for developers, scientists, and
-- engineers to run their batch jobs in the AWS Cloud.
module Network.AWS.Batch
-- | API version 2016-08-10 of the Amazon Batch SDK configuration.
batch :: Service
-- | These errors are usually caused by a server issue.
_ServerException :: AsError a => Getting (First ServiceError) a ServiceError
-- | 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 permission to
-- use the action or resource, or specifying an identifier that is not
-- valid.
_ClientException :: AsError a => Getting (First ServiceError) a ServiceError
data CEState
Disabled :: CEState
Enabled :: CEState
data CEStatus
CESCreating :: CEStatus
CESDeleted :: CEStatus
CESDeleting :: CEStatus
CESInvalid :: CEStatus
CESUpdating :: CEStatus
CESValid :: CEStatus
data CEType
Managed :: CEType
Unmanaged :: CEType
data CRType
EC2 :: CRType
Spot :: CRType
data JQState
JQSDisabled :: JQState
JQSEnabled :: JQState
data JQStatus
Creating :: JQStatus
Deleted :: JQStatus
Deleting :: JQStatus
Invalid :: JQStatus
Updating :: JQStatus
Valid :: JQStatus
data JobDefinitionType
Container :: JobDefinitionType
data JobStatus
Failed :: JobStatus
Pending :: JobStatus
Runnable :: JobStatus
Running :: JobStatus
Starting :: JobStatus
Submitted :: JobStatus
Succeeded :: JobStatus
-- | An object representing the details of a container that is part of a
-- job attempt.
--
-- See: attemptContainerDetail smart constructor.
data AttemptContainerDetail
-- | 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 the STARTING
-- status.
-- - 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
-- is awsbatch/job . Each container attempt receives a
-- log stream name when they reach the RUNNING status.
-- - acdExitCode - The exit code for the job attempt. A non-zero
-- exit code is considered a failure.
--
attemptContainerDetail :: AttemptContainerDetail
-- | 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.
acdTaskARN :: Lens' AttemptContainerDetail (Maybe Text)
-- | The Amazon Resource Name (ARN) of the Amazon ECS container instance
-- that hosts the job attempt.
acdContainerInstanceARN :: Lens' AttemptContainerDetail (Maybe Text)
-- | A short (255 max characters) human-readable string to provide
-- additional details about a running or stopped container.
acdReason :: Lens' AttemptContainerDetail (Maybe Text)
-- | 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.
acdLogStreamName :: Lens' AttemptContainerDetail (Maybe Text)
-- | The exit code for the job attempt. A non-zero exit code is considered
-- a failure.
acdExitCode :: Lens' AttemptContainerDetail (Maybe Int)
-- | An object representing a job attempt.
--
-- See: attemptDetail smart constructor.
data AttemptDetail
-- | 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 timestamp for when the attempt was
-- stopped (when the task transitioned from the RUNNING state to
-- the STOPPED state).
-- - adStartedAt - The Unix timestamp for when the attempt was
-- started (when the task transitioned from the PENDING state to
-- the RUNNING state).
-- - 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.
--
attemptDetail :: AttemptDetail
-- | The Unix timestamp for when the attempt was stopped (when the task
-- transitioned from the RUNNING state to the STOPPED
-- state).
adStoppedAt :: Lens' AttemptDetail (Maybe Integer)
-- | The Unix timestamp for when the attempt was started (when the task
-- transitioned from the PENDING state to the RUNNING
-- state).
adStartedAt :: Lens' AttemptDetail (Maybe Integer)
-- | Details about the container in this job attempt.
adContainer :: Lens' AttemptDetail (Maybe AttemptContainerDetail)
-- | A short, human-readable string to provide additional details about the
-- current status of the job attempt.
adStatusReason :: Lens' AttemptDetail (Maybe Text)
-- | An object representing an AWS Batch compute environment.
--
-- See: computeEnvironmentDetail smart constructor.
data 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, CREATING or VALID ).
-- - cedState - 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 - 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.
--
computeEnvironmentDetail :: Text -> Text -> Text -> ComputeEnvironmentDetail
-- | The current status of the compute environment (for example,
-- CREATING or VALID ).
cedStatus :: Lens' ComputeEnvironmentDetail (Maybe CEStatus)
-- | 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.
cedState :: Lens' ComputeEnvironmentDetail (Maybe CEState)
-- | The compute resources defined for the compute environment.
cedComputeResources :: Lens' ComputeEnvironmentDetail (Maybe ComputeResource)
-- | A short, human-readable string to provide additional details about the
-- current status of the compute environment.
cedStatusReason :: Lens' ComputeEnvironmentDetail (Maybe Text)
-- | The type of the compute environment.
cedType :: Lens' ComputeEnvironmentDetail (Maybe CEType)
-- | The service role associated with the compute environment that allows
-- AWS Batch to make calls to AWS API operations on your behalf.
cedServiceRole :: Lens' ComputeEnvironmentDetail (Maybe Text)
-- | The name of the compute environment.
cedComputeEnvironmentName :: Lens' ComputeEnvironmentDetail Text
-- | The Amazon Resource Name (ARN) of the compute environment.
cedComputeEnvironmentARN :: Lens' ComputeEnvironmentDetail Text
-- | The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster
-- used by the compute environment.
cedEcsClusterARN :: Lens' ComputeEnvironmentDetail Text
-- | 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.
data 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:
--
--
computeEnvironmentOrder :: Int -> Text -> ComputeEnvironmentOrder
-- | The order of the compute environment.
ceoOrder :: Lens' ComputeEnvironmentOrder Int
-- | The Amazon Resource Name (ARN) of the compute environment.
ceoComputeEnvironment :: Lens' ComputeEnvironmentOrder Text
-- | An object representing an AWS Batch compute resource.
--
-- See: computeResource smart constructor.
data 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 a SPOT compute
-- 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, 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 - 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, 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 .
--
computeResource :: CRType -> Int -> Int -> Text -> ComputeResource
-- | The EC2 key pair that is used for instances launched in the compute
-- environment.
crEc2KeyPair :: Lens' ComputeResource (Maybe Text)
-- | 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.
crBidPercentage :: Lens' ComputeResource (Maybe Int)
-- | The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role
-- applied to a SPOT compute environment.
crSpotIAMFleetRole :: Lens' ComputeResource (Maybe Text)
-- | The Amazon Machine Image (AMI) ID used for instances launched in the
-- compute environment.
crImageId :: Lens' ComputeResource (Maybe Text)
-- | The desired number of EC2 vCPUS in the compute environment.
crDesiredvCPUs :: Lens' ComputeResource (Maybe Int)
-- | Key-value pair tags to be applied to resources that are launched in
-- the compute environment.
crTags :: Lens' ComputeResource (HashMap Text Text)
-- | The type of compute environment.
crType :: Lens' ComputeResource CRType
-- | The minimum number of EC2 vCPUs that an environment should maintain.
crMinvCPUs :: Lens' ComputeResource Int
-- | The maximum number of EC2 vCPUs that an environment can reach.
crMaxvCPUs :: Lens' ComputeResource Int
-- | 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.
crInstanceTypes :: Lens' ComputeResource [Text]
-- | The VPC subnets into which the compute resources are launched.
crSubnets :: Lens' ComputeResource [Text]
-- | The EC2 security group that is associated with instances launched in
-- the compute environment.
crSecurityGroupIds :: Lens' ComputeResource [Text]
-- | 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 .
crInstanceRole :: Lens' ComputeResource Text
-- | An object representing the attributes of a compute environment that
-- can be updated.
--
-- See: computeResourceUpdate smart constructor.
data ComputeResourceUpdate
-- | 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.
--
computeResourceUpdate :: ComputeResourceUpdate
-- | The minimum number of EC2 vCPUs that an environment should maintain.
cruMinvCPUs :: Lens' ComputeResourceUpdate (Maybe Int)
-- | The maximum number of EC2 vCPUs that an environment can reach.
cruMaxvCPUs :: Lens' ComputeResourceUpdate (Maybe Int)
-- | The desired number of EC2 vCPUS in the compute environment.
cruDesiredvCPUs :: Lens' ComputeResourceUpdate (Maybe Int)
-- | An object representing the details of a container that is part of a
-- job.
--
-- See: containerDetail smart constructor.
data ContainerDetail
-- | 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 the STARTING
-- status.
-- - cdUlimits - A list of ulimit values 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 the root user).
-- - 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
-- is awsbatch/job . Each container attempt receives a
-- log stream name when they reach the RUNNING status.
-- - 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.
--
containerDetail :: ContainerDetail
-- | The image used to start the container.
cdImage :: Lens' ContainerDetail (Maybe Text)
-- | The command that is passed to the container.
cdCommand :: Lens' ContainerDetail [Text]
-- | The environment variables to pass to a container.
cdEnvironment :: Lens' ContainerDetail [KeyValuePair]
-- | 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.
cdTaskARN :: Lens' ContainerDetail (Maybe Text)
-- | A list of ulimit values to set in the container.
cdUlimits :: Lens' ContainerDetail [Ulimit]
-- | The Amazon Resource Name (ARN) of the container instance on which the
-- container is running.
cdContainerInstanceARN :: Lens' ContainerDetail (Maybe Text)
-- | When this parameter is true, the container is given elevated
-- privileges on the host container instance (similar to the
-- root user).
cdPrivileged :: Lens' ContainerDetail (Maybe Bool)
-- | The Amazon Resource Name (ARN) associated with the job upon execution.
cdJobRoleARN :: Lens' ContainerDetail (Maybe Text)
-- | The number of MiB of memory reserved for the job.
cdMemory :: Lens' ContainerDetail (Maybe Int)
-- | The user name to use inside the container.
cdUser :: Lens' ContainerDetail (Maybe Text)
-- | A short (255 max characters) human-readable string to provide
-- additional details about a running or stopped container.
cdReason :: Lens' ContainerDetail (Maybe Text)
-- | 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.
cdLogStreamName :: Lens' ContainerDetail (Maybe Text)
-- | The mount points for data volumes in your container.
cdMountPoints :: Lens' ContainerDetail [MountPoint]
-- | The exit code to return upon completion.
cdExitCode :: Lens' ContainerDetail (Maybe Int)
-- | The number of VCPUs allocated for the job.
cdVcpus :: Lens' ContainerDetail (Maybe Int)
-- | When this parameter is true, the container is given read-only access
-- to its root file system.
cdReadonlyRootFilesystem :: Lens' ContainerDetail (Maybe Bool)
-- | A list of volumes associated with the job.
cdVolumes :: Lens' ContainerDetail [Volume]
-- | The overrides that should be sent to a container.
--
-- See: containerOverrides smart constructor.
data ContainerOverrides
-- | 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.
--
containerOverrides :: ContainerOverrides
-- | The command to send to the container that overrides the default
-- command from the Docker image or the job definition.
coCommand :: Lens' ContainerOverrides [Text]
-- | 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.
coEnvironment :: Lens' ContainerOverrides [KeyValuePair]
-- | The number of MiB of memory reserved for the job. This value overrides
-- the value set in the job definition.
coMemory :: Lens' ContainerOverrides (Maybe Int)
-- | The number of vCPUs to reserve for the container. This value overrides
-- the value set in the job definition.
coVcpus :: Lens' ContainerOverrides (Maybe Int)
-- | Container properties are used in job definitions to describe the
-- container that is launched as part of a job.
--
-- See: containerProperties smart constructor.
data ContainerProperties
-- | 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 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 - 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 plain text environment variables for sensitive
-- information, such as credential data.
-- - cpUlimits - 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 - 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 - 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 to User in the Create a container
-- section of the Docker Remote API and the --user option
-- to docker run .
-- - cpMountPoints - 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 - 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 .
-- - 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
-- 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 - 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 1 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 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.
--
containerProperties :: Text -> Int -> Int -> ContainerProperties
-- | 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 .
cpCommand :: Lens' ContainerProperties [Text]
-- | 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 plain text
-- environment variables for sensitive information, such as credential
-- data.
cpEnvironment :: Lens' ContainerProperties [KeyValuePair]
-- | 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 .
cpUlimits :: Lens' ContainerProperties [Ulimit]
-- | 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 .
cpPrivileged :: Lens' ContainerProperties (Maybe Bool)
-- | The Amazon Resource Name (ARN) of the IAM role that the container can
-- assume for AWS permissions.
cpJobRoleARN :: Lens' ContainerProperties (Maybe Text)
-- | 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 .
cpUser :: Lens' ContainerProperties (Maybe Text)
-- | 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 .
cpMountPoints :: Lens' ContainerProperties [MountPoint]
-- | 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 .
cpReadonlyRootFilesystem :: Lens' ContainerProperties (Maybe Bool)
-- | A list of data volumes used in a job.
cpVolumes :: Lens' ContainerProperties [Volume]
-- | 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 ).
cpImage :: Lens' ContainerProperties Text
-- | 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 1 vCPU.
cpVcpus :: Lens' ContainerProperties Int
-- | 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.
cpMemory :: Lens' ContainerProperties Int
-- | 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.
data Host
-- | 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 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.
--
host :: Host
-- | 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.
hSourcePath :: Lens' Host (Maybe Text)
-- | An object representing an AWS Batch job definition.
--
-- See: jobDefinition smart constructor.
data 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:
--
--
-- - jStatus - The status of the job definition.
-- - jRetryStrategy - The retry strategy to use for failed jobs
-- that are submitted with this job definition.
-- - jParameters - 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.
-- - jContainerProperties - An object with various properties
-- specific to container-based jobs.
-- - jJobDefinitionName - The name of the job definition.
-- - jJobDefinitionARN - The Amazon Resource Name (ARN) for the
-- job definition.
-- - jRevision - The revision of the job definition.
-- - jType - The type of job definition.
--
jobDefinition :: Text -> Text -> Int -> Text -> JobDefinition
-- | The status of the job definition.
jStatus :: Lens' JobDefinition (Maybe Text)
-- | The retry strategy to use for failed jobs that are submitted with this
-- job definition.
jRetryStrategy :: Lens' JobDefinition (Maybe RetryStrategy)
-- | 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.
jParameters :: Lens' JobDefinition (HashMap Text Text)
-- | An object with various properties specific to container-based jobs.
jContainerProperties :: Lens' JobDefinition (Maybe ContainerProperties)
-- | The name of the job definition.
jJobDefinitionName :: Lens' JobDefinition Text
-- | The Amazon Resource Name (ARN) for the job definition.
jJobDefinitionARN :: Lens' JobDefinition Text
-- | The revision of the job definition.
jRevision :: Lens' JobDefinition Int
-- | The type of job definition.
jType :: Lens' JobDefinition Text
-- | An object representing an AWS Batch job dependency.
--
-- See: jobDependency smart constructor.
data JobDependency
-- | 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 - The job ID of the AWS Batch job associated with
-- this dependency.
--
jobDependency :: JobDependency
-- | The job ID of the AWS Batch job associated with this dependency.
jJobId :: Lens' JobDependency (Maybe Text)
-- | An object representing an AWS Batch job.
--
-- See: jobDetail smart constructor.
data JobDetail
-- | 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 timestamp for when the job was
-- stopped (when the task transitioned from the RUNNING state to
-- the STOPPED state).
-- - jdCreatedAt - The Unix timestamp for when the job was
-- created (when the task entered the PENDING state).
-- - 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.
-- - 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 timestamp for when the job was
-- started (when the task transitioned from the PENDING state to
-- the RUNNING state).
-- - jdJobDefinition - The job definition that is used by this
-- job.
--
jobDetail :: Text -> Text -> Text -> JobStatus -> Integer -> Text -> JobDetail
-- | The Unix timestamp for when the job was stopped (when the task
-- transitioned from the RUNNING state to the STOPPED
-- state).
jdStoppedAt :: Lens' JobDetail (Maybe Integer)
-- | The Unix timestamp for when the job was created (when the task entered
-- the PENDING state).
jdCreatedAt :: Lens' JobDetail (Maybe Integer)
-- | The retry strategy to use for this job if an attempt fails.
jdRetryStrategy :: Lens' JobDetail (Maybe RetryStrategy)
-- | A list of job attempts associated with this job.
jdAttempts :: Lens' JobDetail [AttemptDetail]
-- | A list of job names or IDs on which this job depends.
jdDependsOn :: Lens' JobDetail [JobDependency]
-- | An object representing the details of the container that is associated
-- with the job.
jdContainer :: Lens' JobDetail (Maybe ContainerDetail)
-- | Additional parameters passed to the job that replace parameter
-- substitution placeholders or override any corresponding parameter
-- defaults from the job definition.
jdParameters :: Lens' JobDetail (HashMap Text Text)
-- | A short, human-readable string to provide additional details about the
-- current status of the job.
jdStatusReason :: Lens' JobDetail (Maybe Text)
-- | The name of the job.
jdJobName :: Lens' JobDetail Text
-- | The ID for the job.
jdJobId :: Lens' JobDetail Text
-- | The Amazon Resource Name (ARN) of the job queue with which the job is
-- associated.
jdJobQueue :: Lens' JobDetail Text
-- | The current status for the job.
jdStatus :: Lens' JobDetail JobStatus
-- | The Unix timestamp for when the job was started (when the task
-- transitioned from the PENDING state to the RUNNING
-- state).
jdStartedAt :: Lens' JobDetail Integer
-- | The job definition that is used by this job.
jdJobDefinition :: Lens' JobDetail Text
-- | An object representing the details of an AWS Batch job queue.
--
-- See: jobQueueDetail smart constructor.
data 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,
-- CREATING or VALID ).
-- - 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.
--
jobQueueDetail :: Text -> Text -> JQState -> Int -> JobQueueDetail
-- | The status of the job queue (for example, CREATING or
-- VALID ).
jqdStatus :: Lens' JobQueueDetail (Maybe JQStatus)
-- | A short, human-readable string to provide additional details about the
-- current status of the job queue.
jqdStatusReason :: Lens' JobQueueDetail (Maybe Text)
-- | The name of the job queue.
jqdJobQueueName :: Lens' JobQueueDetail Text
-- | The Amazon Resource Name (ARN) of the job queue.
jqdJobQueueARN :: Lens' JobQueueDetail Text
-- | Describes the ability of the queue to accept new jobs.
jqdState :: Lens' JobQueueDetail JQState
-- | The priority of the job queue.
jqdPriority :: Lens' JobQueueDetail Int
-- | 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.
jqdComputeEnvironmentOrder :: Lens' JobQueueDetail [ComputeEnvironmentOrder]
-- | An object representing summary details of a job.
--
-- See: jobSummary smart constructor.
data 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:
--
--
jobSummary :: Text -> Text -> JobSummary
-- | The ID of the job.
jsJobId :: Lens' JobSummary Text
-- | The name of the job.
jsJobName :: Lens' JobSummary Text
-- | A key-value pair object.
--
-- See: keyValuePair smart constructor.
data KeyValuePair
-- | 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 - The value of the key value pair. For environment
-- variables, this is the value of the environment variable.
-- - kvpName - The name of the key value pair. For environment
-- variables, this is the name of the environment variable.
--
keyValuePair :: KeyValuePair
-- | The value of the key value pair. For environment variables, this is
-- the value of the environment variable.
kvpValue :: Lens' KeyValuePair (Maybe Text)
-- | The name of the key value pair. For environment variables, this is the
-- name of the environment variable.
kvpName :: Lens' KeyValuePair (Maybe Text)
-- | Details on a Docker volume mount point that is used in a job's
-- container properties.
--
-- See: mountPoint smart constructor.
data MountPoint
-- | 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 is true , the container
-- has read-only access to the volume; otherwise, the container can write
-- to the volume. The default value is false .
--
mountPoint :: MountPoint
-- | The path on the container at which to mount the host volume.
mpContainerPath :: Lens' MountPoint (Maybe Text)
-- | The name of the volume to mount.
mpSourceVolume :: Lens' MountPoint (Maybe Text)
-- | 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 .
mpReadOnly :: Lens' MountPoint (Maybe Bool)
-- | The retry strategy associated with a job.
--
-- See: retryStrategy smart constructor.
data RetryStrategy
-- | 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 the
-- RUNNABLE status. You may specify between 1 and 10 attempts.
-- If attempts is greater than one, the job is retried if it
-- fails until it has moved to RUNNABLE that many times.
--
retryStrategy :: RetryStrategy
-- | The number of times to move a job to the RUNNABLE status. You
-- may specify between 1 and 10 attempts. If attempts is greater
-- than one, the job is retried if it fails until it has moved to
-- RUNNABLE that many times.
rsAttempts :: Lens' RetryStrategy (Maybe Int)
-- | The ulimit settings to pass to the container.
--
-- See: ulimit smart constructor.
data Ulimit
-- | 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 the ulimit
-- type.
-- - uName - The type of the ulimit .
-- - uSoftLimit - The soft limit for the ulimit
-- type.
--
ulimit :: Int -> Text -> Int -> Ulimit
-- | The hard limit for the ulimit type.
uHardLimit :: Lens' Ulimit Int
-- | The type of the ulimit .
uName :: Lens' Ulimit Text
-- | The soft limit for the ulimit type.
uSoftLimit :: Lens' Ulimit Int
-- | A data volume used in a job's container properties.
--
-- See: volume smart constructor.
data Volume
-- | 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 the sourceVolume
-- parameter of container definition mountPoints .
-- - vHost - 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.
--
volume :: Volume
-- | 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 .
vName :: Lens' Volume (Maybe Text)
-- | 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.
vHost :: Lens' Volume (Maybe Host)