Target

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.

Arn

The Amazon Resource Name (ARN) of the target.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes

RoleArn

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: ^arn:aws(-[a-z]+)?:iam::\d{12}:role\/[\w+=,.@\/-]+$

Required: Yes

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.

Type: DeadLetterConfig object

Required: No

EcsParameters

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

Type: EcsParameters object

Required: No

EventBridgeParameters

The templated target type for the EventBridge PutEvents API operation.

Type: EventBridgeParameters object

Required: No

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.

Type: String

Length Constraints: Minimum length of 1.

Required: No

KinesisParameters

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

Type: KinesisParameters object

Required: No

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.

Type: RetryPolicy object

Required: No

SageMakerPipelineParameters

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

Type: SageMakerPipelineParameters object

Required: No

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.

Type: SqsParameters object

Required: No

Target

Contents

See Also