Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Registers an Batch job definition.
Synopsis
- data RegisterJobDefinition = RegisterJobDefinition' {
- containerProperties :: Maybe ContainerProperties
- eksProperties :: Maybe EksProperties
- nodeProperties :: Maybe NodeProperties
- parameters :: Maybe (HashMap Text Text)
- platformCapabilities :: Maybe [PlatformCapability]
- propagateTags :: Maybe Bool
- retryStrategy :: Maybe RetryStrategy
- schedulingPriority :: Maybe Int
- tags :: Maybe (HashMap Text Text)
- timeout :: Maybe JobTimeout
- jobDefinitionName :: Text
- type' :: JobDefinitionType
- newRegisterJobDefinition :: Text -> JobDefinitionType -> RegisterJobDefinition
- registerJobDefinition_containerProperties :: Lens' RegisterJobDefinition (Maybe ContainerProperties)
- registerJobDefinition_eksProperties :: Lens' RegisterJobDefinition (Maybe EksProperties)
- registerJobDefinition_nodeProperties :: Lens' RegisterJobDefinition (Maybe NodeProperties)
- registerJobDefinition_parameters :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text))
- registerJobDefinition_platformCapabilities :: Lens' RegisterJobDefinition (Maybe [PlatformCapability])
- registerJobDefinition_propagateTags :: Lens' RegisterJobDefinition (Maybe Bool)
- registerJobDefinition_retryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy)
- registerJobDefinition_schedulingPriority :: Lens' RegisterJobDefinition (Maybe Int)
- registerJobDefinition_tags :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text))
- registerJobDefinition_timeout :: Lens' RegisterJobDefinition (Maybe JobTimeout)
- registerJobDefinition_jobDefinitionName :: Lens' RegisterJobDefinition Text
- registerJobDefinition_type :: Lens' RegisterJobDefinition JobDefinitionType
- data RegisterJobDefinitionResponse = RegisterJobDefinitionResponse' {}
- newRegisterJobDefinitionResponse :: Int -> Text -> Text -> Int -> RegisterJobDefinitionResponse
- registerJobDefinitionResponse_httpStatus :: Lens' RegisterJobDefinitionResponse Int
- registerJobDefinitionResponse_jobDefinitionName :: Lens' RegisterJobDefinitionResponse Text
- registerJobDefinitionResponse_jobDefinitionArn :: Lens' RegisterJobDefinitionResponse Text
- registerJobDefinitionResponse_revision :: Lens' RegisterJobDefinitionResponse Int
Creating a Request
data RegisterJobDefinition Source #
Contains the parameters for RegisterJobDefinition
.
See: newRegisterJobDefinition
smart constructor.
RegisterJobDefinition' | |
|
Instances
newRegisterJobDefinition Source #
Create a value of RegisterJobDefinition
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterJobDefinition
, registerJobDefinition_containerProperties
- An object with various properties specific to Amazon ECS based
single-node container-based jobs. If the job definition's type
parameter is container
, then you must specify either
containerProperties
or nodeProperties
. This must not be specified
for Amazon EKS based job definitions.
If the job runs on Fargate resources, then you must not specify
nodeProperties
; use only containerProperties
.
RegisterJobDefinition
, registerJobDefinition_eksProperties
- An object with various properties that are specific to Amazon EKS based
jobs. This must not be specified for Amazon ECS based job definitions.
RegisterJobDefinition
, registerJobDefinition_nodeProperties
- An object with various properties specific to multi-node parallel jobs.
If you specify node properties for a job, it becomes a multi-node
parallel job. For more information, see
Multi-node Parallel Jobs
in the Batch User Guide. If the job definition's type
parameter is
container
, then you must specify either containerProperties
or
nodeProperties
.
If the job runs on Fargate resources, then you must not specify
nodeProperties
; use containerProperties
instead.
If the job runs on Amazon EKS resources, then you must not specify
nodeProperties
.
RegisterJobDefinition
, registerJobDefinition_parameters
- 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.
RegisterJobDefinition
, registerJobDefinition_platformCapabilities
- The platform capabilities required by the job definition. If no value is
specified, it defaults to EC2
. To run the job on Fargate resources,
specify FARGATE
.
If the job runs on Amazon EKS resources, then you must not specify
platformCapabilities
.
RegisterJobDefinition
, registerJobDefinition_propagateTags
- Specifies whether to propagate the tags from the job or job definition
to the corresponding Amazon ECS task. If no value is specified, the tags
are not propagated. Tags can only be propagated to the tasks during task
creation. For tags with the same name, job tags are given priority over
job definitions tags. If the total number of combined tags from the job
and job definition is over 50, the job is moved to the FAILED
state.
If the job runs on Amazon EKS resources, then you must not specify
propagateTags
.
RegisterJobDefinition
, registerJobDefinition_retryStrategy
- The retry strategy to use for failed jobs that are submitted with this
job definition. Any retry strategy that's specified during a SubmitJob
operation overrides the retry strategy defined here. If a job is
terminated due to a timeout, it isn't retried.
RegisterJobDefinition
, registerJobDefinition_schedulingPriority
- The scheduling priority for jobs that are submitted with this job
definition. This only affects jobs in job queues with a fair share
policy. Jobs with a higher scheduling priority are scheduled before jobs
with a lower scheduling priority.
The minimum supported value is 0 and the maximum supported value is 9999.
RegisterJobDefinition
, registerJobDefinition_tags
- The tags that you apply to the job definition to help you categorize and
organize your resources. Each tag consists of a key and an optional
value. For more information, see
Tagging Amazon Web Services Resources
in Batch User Guide.
RegisterJobDefinition
, registerJobDefinition_timeout
- The timeout configuration for jobs that are submitted with this job
definition, after which Batch terminates your jobs if they have not
finished. If a job is terminated due to a timeout, it isn't retried.
The minimum value for the timeout is 60 seconds. Any timeout
configuration that's specified during a SubmitJob operation overrides
the timeout configuration defined here. For more information, see
Job Timeouts
in the Batch User Guide.
RegisterJobDefinition
, registerJobDefinition_jobDefinitionName
- The name of the job definition to register. It can be up to 128 letters
long. It can contain uppercase and lowercase letters, numbers, hyphens
(-), and underscores (_).
RegisterJobDefinition
, registerJobDefinition_type
- The type of job definition. For more information about multi-node
parallel jobs, see
Creating a multi-node parallel job definition
in the Batch User Guide.
If the job is run on Fargate resources, then multinode
isn't
supported.
Request Lenses
registerJobDefinition_containerProperties :: Lens' RegisterJobDefinition (Maybe ContainerProperties) Source #
An object with various properties specific to Amazon ECS based
single-node container-based jobs. If the job definition's type
parameter is container
, then you must specify either
containerProperties
or nodeProperties
. This must not be specified
for Amazon EKS based job definitions.
If the job runs on Fargate resources, then you must not specify
nodeProperties
; use only containerProperties
.
registerJobDefinition_eksProperties :: Lens' RegisterJobDefinition (Maybe EksProperties) Source #
An object with various properties that are specific to Amazon EKS based jobs. This must not be specified for Amazon ECS based job definitions.
registerJobDefinition_nodeProperties :: Lens' RegisterJobDefinition (Maybe NodeProperties) Source #
An object with various properties specific to multi-node parallel jobs.
If you specify node properties for a job, it becomes a multi-node
parallel job. For more information, see
Multi-node Parallel Jobs
in the Batch User Guide. If the job definition's type
parameter is
container
, then you must specify either containerProperties
or
nodeProperties
.
If the job runs on Fargate resources, then you must not specify
nodeProperties
; use containerProperties
instead.
If the job runs on Amazon EKS resources, then you must not specify
nodeProperties
.
registerJobDefinition_parameters :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text)) Source #
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.
registerJobDefinition_platformCapabilities :: Lens' RegisterJobDefinition (Maybe [PlatformCapability]) Source #
The platform capabilities required by the job definition. If no value is
specified, it defaults to EC2
. To run the job on Fargate resources,
specify FARGATE
.
If the job runs on Amazon EKS resources, then you must not specify
platformCapabilities
.
registerJobDefinition_propagateTags :: Lens' RegisterJobDefinition (Maybe Bool) Source #
Specifies whether to propagate the tags from the job or job definition
to the corresponding Amazon ECS task. If no value is specified, the tags
are not propagated. Tags can only be propagated to the tasks during task
creation. For tags with the same name, job tags are given priority over
job definitions tags. If the total number of combined tags from the job
and job definition is over 50, the job is moved to the FAILED
state.
If the job runs on Amazon EKS resources, then you must not specify
propagateTags
.
registerJobDefinition_retryStrategy :: Lens' RegisterJobDefinition (Maybe RetryStrategy) Source #
The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.
registerJobDefinition_schedulingPriority :: Lens' RegisterJobDefinition (Maybe Int) Source #
The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.
The minimum supported value is 0 and the maximum supported value is 9999.
registerJobDefinition_tags :: Lens' RegisterJobDefinition (Maybe (HashMap Text Text)) Source #
The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.
registerJobDefinition_timeout :: Lens' RegisterJobDefinition (Maybe JobTimeout) Source #
The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.
registerJobDefinition_jobDefinitionName :: Lens' RegisterJobDefinition Text Source #
The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
registerJobDefinition_type :: Lens' RegisterJobDefinition JobDefinitionType Source #
The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.
If the job is run on Fargate resources, then multinode
isn't
supported.
Destructuring the Response
data RegisterJobDefinitionResponse Source #
See: newRegisterJobDefinitionResponse
smart constructor.
RegisterJobDefinitionResponse' | |
|
Instances
newRegisterJobDefinitionResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> Int | |
-> RegisterJobDefinitionResponse |
Create a value of RegisterJobDefinitionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:RegisterJobDefinitionResponse'
, registerJobDefinitionResponse_httpStatus
- The response's http status code.
RegisterJobDefinition
, registerJobDefinitionResponse_jobDefinitionName
- The name of the job definition.
RegisterJobDefinitionResponse
, registerJobDefinitionResponse_jobDefinitionArn
- The Amazon Resource Name (ARN) of the job definition.
RegisterJobDefinitionResponse
, registerJobDefinitionResponse_revision
- The revision of the job definition.
Response Lenses
registerJobDefinitionResponse_httpStatus :: Lens' RegisterJobDefinitionResponse Int Source #
The response's http status code.
registerJobDefinitionResponse_jobDefinitionName :: Lens' RegisterJobDefinitionResponse Text Source #
The name of the job definition.
registerJobDefinitionResponse_jobDefinitionArn :: Lens' RegisterJobDefinitionResponse Text Source #
The Amazon Resource Name (ARN) of the job definition.
registerJobDefinitionResponse_revision :: Lens' RegisterJobDefinitionResponse Int Source #
The revision of the job definition.