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

Amazonka.Pipes.Types.PipeTargetBatchJobParameters

Description

Synopsis

Documentation

data PipeTargetBatchJobParameters Source #

The parameters for using an Batch job as a target.

See: newPipeTargetBatchJobParameters smart constructor.

Constructors

PipeTargetBatchJobParameters'

Fields

arrayProperties :: Maybe BatchArrayProperties
The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.
containerOverrides :: Maybe BatchContainerOverrides
The overrides that are sent to a container.
dependsOn :: Maybe [BatchJobDependency]
A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.
parameters :: Maybe (HashMap Text Text)
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 included here override any corresponding parameter defaults from the job definition.
retryStrategy :: Maybe BatchRetryStrategy
The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.
jobDefinition :: Text
The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.
jobName :: Text
The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Instances

Instances details

FromJSON PipeTargetBatchJobParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetBatchJobParameters Methods parseJSON :: Value -> Parser PipeTargetBatchJobParameters # parseJSONList :: Value -> Parser [PipeTargetBatchJobParameters] #
ToJSON PipeTargetBatchJobParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetBatchJobParameters Methods toJSON :: PipeTargetBatchJobParameters -> Value # toEncoding :: PipeTargetBatchJobParameters -> Encoding # toJSONList :: [PipeTargetBatchJobParameters] -> Value # toEncodingList :: [PipeTargetBatchJobParameters] -> Encoding #
Generic PipeTargetBatchJobParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetBatchJobParameters Associated Types type Rep PipeTargetBatchJobParameters :: Type -> Type # Methods from :: PipeTargetBatchJobParameters -> Rep PipeTargetBatchJobParameters x # to :: Rep PipeTargetBatchJobParameters x -> PipeTargetBatchJobParameters #
Read PipeTargetBatchJobParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetBatchJobParameters Methods readsPrec :: Int -> ReadS PipeTargetBatchJobParameters # readList :: ReadS [PipeTargetBatchJobParameters] # readPrec :: ReadPrec PipeTargetBatchJobParameters # readListPrec :: ReadPrec [PipeTargetBatchJobParameters] #
Show PipeTargetBatchJobParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetBatchJobParameters Methods showsPrec :: Int -> PipeTargetBatchJobParameters -> ShowS # show :: PipeTargetBatchJobParameters -> String # showList :: [PipeTargetBatchJobParameters] -> ShowS #
NFData PipeTargetBatchJobParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetBatchJobParameters Methods rnf :: PipeTargetBatchJobParameters -> () #
Eq PipeTargetBatchJobParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetBatchJobParameters Methods (==) :: PipeTargetBatchJobParameters -> PipeTargetBatchJobParameters -> Bool # (/=) :: PipeTargetBatchJobParameters -> PipeTargetBatchJobParameters -> Bool #
Hashable PipeTargetBatchJobParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetBatchJobParameters Methods hashWithSalt :: Int -> PipeTargetBatchJobParameters -> Int # hash :: PipeTargetBatchJobParameters -> Int #
type Rep PipeTargetBatchJobParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeTargetBatchJobParameters type Rep PipeTargetBatchJobParameters = D1 ('MetaData "PipeTargetBatchJobParameters" "Amazonka.Pipes.Types.PipeTargetBatchJobParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeTargetBatchJobParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arrayProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchArrayProperties)) :: (S1 ('MetaSel ('Just "containerOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchContainerOverrides)) :: S1 ('MetaSel ('Just "dependsOn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BatchJobDependency])))) :: ((S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "retryStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchRetryStrategy))) :: (S1 ('MetaSel ('Just "jobDefinition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPipeTargetBatchJobParameters Source #

Arguments

:: Text	`$sel:jobDefinition:PipeTargetBatchJobParameters'`
-> Text	`$sel:jobName:PipeTargetBatchJobParameters'`
-> PipeTargetBatchJobParameters

Create a value of PipeTargetBatchJobParameters 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:arrayProperties:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_arrayProperties - The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

$sel:containerOverrides:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_containerOverrides - The overrides that are sent to a container.

$sel:dependsOn:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_dependsOn - A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

$sel:parameters:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_parameters - 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 included here override any corresponding parameter defaults from the job definition.

$sel:retryStrategy:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_retryStrategy - The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

$sel:jobDefinition:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_jobDefinition - The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

$sel:jobName:PipeTargetBatchJobParameters', pipeTargetBatchJobParameters_jobName - The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

pipeTargetBatchJobParameters_arrayProperties :: Lens' PipeTargetBatchJobParameters (Maybe BatchArrayProperties) Source #

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an Batch job.

pipeTargetBatchJobParameters_containerOverrides :: Lens' PipeTargetBatchJobParameters (Maybe BatchContainerOverrides) Source #

The overrides that are sent to a container.

pipeTargetBatchJobParameters_dependsOn :: Lens' PipeTargetBatchJobParameters (Maybe [BatchJobDependency]) Source #

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

pipeTargetBatchJobParameters_parameters :: Lens' PipeTargetBatchJobParameters (Maybe (HashMap Text Text)) Source #

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 included here override any corresponding parameter defaults from the job definition.

pipeTargetBatchJobParameters_retryStrategy :: Lens' PipeTargetBatchJobParameters (Maybe BatchRetryStrategy) Source #

The retry strategy to use for failed jobs. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

pipeTargetBatchJobParameters_jobDefinition :: Lens' PipeTargetBatchJobParameters Text Source #

The job definition used by this job. This value can be one of name, name:revision, or the Amazon Resource Name (ARN) for the job definition. If name is specified without a revision then the latest active revision is used.

pipeTargetBatchJobParameters_jobName :: Lens' PipeTargetBatchJobParameters Text Source #

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).