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.Scheduler.Types.Target

Description

Synopsis

data Target = Target' {
- deadLetterConfig :: Maybe DeadLetterConfig
- ecsParameters :: Maybe EcsParameters
- eventBridgeParameters :: Maybe EventBridgeParameters
- input :: Maybe Text
- kinesisParameters :: Maybe KinesisParameters
- retryPolicy :: Maybe RetryPolicy
- sageMakerPipelineParameters :: Maybe SageMakerPipelineParameters
- sqsParameters :: Maybe SqsParameters
- arn :: Text
- roleArn :: Text
}
newTarget :: Text -> Text -> Target
target_deadLetterConfig :: Lens' Target (Maybe DeadLetterConfig)
target_ecsParameters :: Lens' Target (Maybe EcsParameters)
target_eventBridgeParameters :: Lens' Target (Maybe EventBridgeParameters)
target_input :: Lens' Target (Maybe Text)
target_kinesisParameters :: Lens' Target (Maybe KinesisParameters)
target_retryPolicy :: Lens' Target (Maybe RetryPolicy)
target_sageMakerPipelineParameters :: Lens' Target (Maybe SageMakerPipelineParameters)
target_sqsParameters :: Lens' Target (Maybe SqsParameters)
target_arn :: Lens' Target Text
target_roleArn :: Lens' Target Text

Documentation

data Target Source #

The schedule's target. EventBridge Scheduler supports templated target that invoke common API operations, as well as universal targets that you can customize to invoke over 6,000 API operations across more than 270 services. You can only specify one templated or universal target for a schedule.

See: newTarget smart constructor.

Constructors

Target'

Fields

deadLetterConfig :: Maybe DeadLetterConfig
An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.
ecsParameters :: Maybe EcsParameters
The templated target type for the Amazon ECS RunTask API operation.
eventBridgeParameters :: Maybe EventBridgeParameters
The templated target type for the EventBridge PutEvents API operation.
input :: Maybe Text
The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.
kinesisParameters :: Maybe KinesisParameters
The templated target type for the Amazon Kinesis PutRecord API operation.
retryPolicy :: Maybe RetryPolicy
A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.
sageMakerPipelineParameters :: Maybe SageMakerPipelineParameters
The templated target type for the Amazon SageMaker StartPipelineExecution API operation.
sqsParameters :: Maybe SqsParameters
The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.
arn :: Text
The Amazon Resource Name (ARN) of the target.
roleArn :: Text
The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

Instances

Instances details

FromJSON Target Source #
Instance details Defined in Amazonka.Scheduler.Types.Target Methods parseJSON :: Value -> Parser Target # parseJSONList :: Value -> Parser [Target] #
ToJSON Target Source #
Instance details Defined in Amazonka.Scheduler.Types.Target Methods toJSON :: Target -> Value # toEncoding :: Target -> Encoding # toJSONList :: [Target] -> Value # toEncodingList :: [Target] -> Encoding #
Generic Target Source #
Instance details Defined in Amazonka.Scheduler.Types.Target Associated Types type Rep Target :: Type -> Type # Methods from :: Target -> Rep Target x # to :: Rep Target x -> Target #
Read Target Source #
Instance details Defined in Amazonka.Scheduler.Types.Target Methods readsPrec :: Int -> ReadS Target # readList :: ReadS [Target] # readPrec :: ReadPrec Target # readListPrec :: ReadPrec [Target] #
Show Target Source #
Instance details Defined in Amazonka.Scheduler.Types.Target Methods showsPrec :: Int -> Target -> ShowS # show :: Target -> String # showList :: [Target] -> ShowS #
NFData Target Source #
Instance details Defined in Amazonka.Scheduler.Types.Target Methods rnf :: Target -> () #
Eq Target Source #
Instance details Defined in Amazonka.Scheduler.Types.Target Methods (==) :: Target -> Target -> Bool # (/=) :: Target -> Target -> Bool #
Hashable Target Source #
Instance details Defined in Amazonka.Scheduler.Types.Target Methods hashWithSalt :: Int -> Target -> Int # hash :: Target -> Int #
type Rep Target Source #
Instance details Defined in Amazonka.Scheduler.Types.Target type Rep Target = D1 ('MetaData "Target" "Amazonka.Scheduler.Types.Target" "amazonka-scheduler-2.0-8LKlva3Whvt7TpHIvtcn6a" 'False) (C1 ('MetaCons "Target'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "deadLetterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeadLetterConfig)) :: S1 ('MetaSel ('Just "ecsParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EcsParameters))) :: (S1 ('MetaSel ('Just "eventBridgeParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EventBridgeParameters)) :: (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "kinesisParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KinesisParameters))))) :: ((S1 ('MetaSel ('Just "retryPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RetryPolicy)) :: S1 ('MetaSel ('Just "sageMakerPipelineParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SageMakerPipelineParameters))) :: (S1 ('MetaSel ('Just "sqsParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SqsParameters)) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newTarget Source #

Arguments

:: Text	`Target`
-> Text	`$sel:roleArn:Target'`
-> Target

Create a value of Target 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:deadLetterConfig:Target', target_deadLetterConfig - An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

$sel:ecsParameters:Target', target_ecsParameters - The templated target type for the Amazon ECS RunTask API operation.

$sel:eventBridgeParameters:Target', target_eventBridgeParameters - The templated target type for the EventBridge PutEvents API operation.

$sel:input:Target', target_input - The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.

$sel:kinesisParameters:Target', target_kinesisParameters - The templated target type for the Amazon Kinesis PutRecord API operation.

$sel:retryPolicy:Target', target_retryPolicy - A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

$sel:sageMakerPipelineParameters:Target', target_sageMakerPipelineParameters - The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

$sel:sqsParameters:Target', target_sqsParameters - The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.

Target, target_arn - The Amazon Resource Name (ARN) of the target.

$sel:roleArn:Target', target_roleArn - The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.

target_deadLetterConfig :: Lens' Target (Maybe DeadLetterConfig) Source #

An object that contains information about an Amazon SQS queue that EventBridge Scheduler uses as a dead-letter queue for your schedule. If specified, EventBridge Scheduler delivers failed events that could not be successfully delivered to a target to the queue.

target_ecsParameters :: Lens' Target (Maybe EcsParameters) Source #

The templated target type for the Amazon ECS RunTask API operation.

target_eventBridgeParameters :: Lens' Target (Maybe EventBridgeParameters) Source #

The templated target type for the EventBridge PutEvents API operation.

target_input :: Lens' Target (Maybe Text) Source #

The text, or well-formed JSON, passed to the target. If you are configuring a templated Lambda, AWS Step Functions, or Amazon EventBridge target, the input must be a well-formed JSON. For all other target types, a JSON is not required. If you do not specify anything for this field, EventBridge Scheduler delivers a default notification to the target.

target_kinesisParameters :: Lens' Target (Maybe KinesisParameters) Source #

The templated target type for the Amazon Kinesis PutRecord API operation.

target_retryPolicy :: Lens' Target (Maybe RetryPolicy) Source #

A RetryPolicy object that includes information about the retry policy settings, including the maximum age of an event, and the maximum number of times EventBridge Scheduler will try to deliver the event to a target.

target_sageMakerPipelineParameters :: Lens' Target (Maybe SageMakerPipelineParameters) Source #

The templated target type for the Amazon SageMaker StartPipelineExecution API operation.

target_sqsParameters :: Lens' Target (Maybe SqsParameters) Source #

The templated target type for the Amazon SQS SendMessage API operation. Contains the message group ID to use when the target is a FIFO queue. If you specify an Amazon SQS FIFO queue as a target, the queue must have content-based deduplication enabled. For more information, see Using the Amazon SQS message deduplication ID in the Amazon SQS Developer Guide.

target_arn :: Lens' Target Text Source #

The Amazon Resource Name (ARN) of the target.

target_roleArn :: Lens' Target Text Source #

The Amazon Resource Name (ARN) of the IAM role that EventBridge Scheduler will use for this target when the schedule is invoked.