amazonka-batch-2.0: Amazon Batch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Batch.RegisterJobDefinition

Description

Registers an Batch job definition.

Synopsis

Creating a Request

data RegisterJobDefinition Source #

Contains the parameters for RegisterJobDefinition.

See: newRegisterJobDefinition smart constructor.

Constructors

RegisterJobDefinition' 

Fields

  • containerProperties :: Maybe 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.

  • eksProperties :: Maybe 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.

  • nodeProperties :: Maybe 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.

  • parameters :: Maybe (HashMap Text Text)

    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.

  • platformCapabilities :: Maybe [PlatformCapability]

    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.

  • propagateTags :: Maybe Bool

    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.

  • retryStrategy :: Maybe 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.

  • schedulingPriority :: Maybe Int

    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.

  • tags :: Maybe (HashMap Text Text)

    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.

  • timeout :: Maybe JobTimeout

    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.

  • jobDefinitionName :: Text

    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 (_).

  • type' :: JobDefinitionType

    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.

Instances

Instances details
ToJSON RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

ToHeaders RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

ToPath RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

ToQuery RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

AWSRequest RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Associated Types

type AWSResponse RegisterJobDefinition #

Generic RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Associated Types

type Rep RegisterJobDefinition :: Type -> Type #

Read RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Show RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

NFData RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Methods

rnf :: RegisterJobDefinition -> () #

Eq RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Hashable RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type AWSResponse RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type Rep RegisterJobDefinition Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type Rep RegisterJobDefinition = D1 ('MetaData "RegisterJobDefinition" "Amazonka.Batch.RegisterJobDefinition" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "RegisterJobDefinition'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "containerProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContainerProperties)) :*: (S1 ('MetaSel ('Just "eksProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EksProperties)) :*: S1 ('MetaSel ('Just "nodeProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NodeProperties)))) :*: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "platformCapabilities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PlatformCapability])) :*: S1 ('MetaSel ('Just "propagateTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :*: ((S1 ('MetaSel ('Just "retryStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryStrategy)) :*: (S1 ('MetaSel ('Just "schedulingPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :*: (S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe JobTimeout)) :*: (S1 ('MetaSel ('Just "jobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobDefinitionType))))))

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.

Constructors

RegisterJobDefinitionResponse' 

Fields

Instances

Instances details
Generic RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Associated Types

type Rep RegisterJobDefinitionResponse :: Type -> Type #

Read RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Show RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

NFData RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

Eq RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type Rep RegisterJobDefinitionResponse Source # 
Instance details

Defined in Amazonka.Batch.RegisterJobDefinition

type Rep RegisterJobDefinitionResponse = D1 ('MetaData "RegisterJobDefinitionResponse" "Amazonka.Batch.RegisterJobDefinition" "amazonka-batch-2.0-Ey2VZ5obnq65VwmlrJ2r2K" 'False) (C1 ('MetaCons "RegisterJobDefinitionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "jobDefinitionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "jobDefinitionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "revision") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRegisterJobDefinitionResponse Source #

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_jobDefinitionArn :: Lens' RegisterJobDefinitionResponse Text Source #

The Amazon Resource Name (ARN) of the job definition.