Module types

Module types 

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that Amazon EventBridge Scheduler can respond with.

Structs§

AwsVpcConfiguration

This structure specifies the VPC subnets and security groups for the task, and whether a public IP address is to be used. This structure is relevant only for ECS tasks that use the awsvpc network mode.

CapacityProviderStrategyItem

The details of a capacity provider strategy.

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

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

EventBridgeParameters

The templated target type for the EventBridge PutEvents API operation.

FlexibleTimeWindow

Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.

KinesisParameters

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

NetworkConfiguration

Specifies the network configuration for an ECS task.

PlacementConstraint

An object representing a constraint on task placement.

PlacementStrategy

The task placement strategy for a task or service.

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.

SageMakerPipelineParameter

The name and value pair of a parameter to use to start execution of a SageMaker Model Building Pipeline.

SageMakerPipelineParameters

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

ScheduleGroupSummary

The details of a schedule group.

ScheduleSummary

The details of a schedule.

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.

Tag

Tag to associate with a schedule group.

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.

TargetSummary

The details of a target.

Enums§

ActionAfterCompletion
When writing a match expression against ActionAfterCompletion, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AssignPublicIp
When writing a match expression against AssignPublicIp, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FlexibleTimeWindowMode
When writing a match expression against FlexibleTimeWindowMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
LaunchType
When writing a match expression against LaunchType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PlacementConstraintType
When writing a match expression against PlacementConstraintType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PlacementStrategyType
When writing a match expression against PlacementStrategyType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PropagateTags
When writing a match expression against PropagateTags, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ScheduleGroupState
When writing a match expression against ScheduleGroupState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ScheduleState
When writing a match expression against ScheduleState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.