amazonka-cloudwatch-events-2.0: Amazon EventBridge 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.CloudWatchEvents.Types.BatchParameters

Description

 
Synopsis

Documentation

data BatchParameters Source #

The custom parameters to be used when the target is an Batch job.

See: newBatchParameters smart constructor.

Constructors

BatchParameters' 

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.

  • retryStrategy :: Maybe BatchRetryStrategy

    The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

  • jobDefinition :: Text

    The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

  • jobName :: Text

    The name to use for this execution of the job, if the target is an Batch job.

Instances

Instances details
FromJSON BatchParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.BatchParameters

ToJSON BatchParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.BatchParameters

Generic BatchParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.BatchParameters

Associated Types

type Rep BatchParameters :: Type -> Type #

Read BatchParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.BatchParameters

Show BatchParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.BatchParameters

NFData BatchParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.BatchParameters

Methods

rnf :: BatchParameters -> () #

Eq BatchParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.BatchParameters

Hashable BatchParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.BatchParameters

type Rep BatchParameters Source # 
Instance details

Defined in Amazonka.CloudWatchEvents.Types.BatchParameters

type Rep BatchParameters = D1 ('MetaData "BatchParameters" "Amazonka.CloudWatchEvents.Types.BatchParameters" "amazonka-cloudwatch-events-2.0-GJzRBos1CnlE3BT39axMc5" 'False) (C1 ('MetaCons "BatchParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arrayProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BatchArrayProperties)) :*: 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))))

newBatchParameters Source #

Create a value of BatchParameters 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:BatchParameters', batchParameters_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:retryStrategy:BatchParameters', batchParameters_retryStrategy - The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

$sel:jobDefinition:BatchParameters', batchParameters_jobDefinition - The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

$sel:jobName:BatchParameters', batchParameters_jobName - The name to use for this execution of the job, if the target is an Batch job.

batchParameters_arrayProperties :: Lens' BatchParameters (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.

batchParameters_retryStrategy :: Lens' BatchParameters (Maybe BatchRetryStrategy) Source #

The retry strategy to use for failed jobs, if the target is an Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1–10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

batchParameters_jobDefinition :: Lens' BatchParameters Text Source #

The ARN or name of the job definition to use if the event target is an Batch job. This job definition must already exist.

batchParameters_jobName :: Lens' BatchParameters Text Source #

The name to use for this execution of the job, if the target is an Batch job.