Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that Amazon EventBridge can respond with.

Structs

ApiDestination

Contains details about an API destination.

AppSyncParameters

Contains the GraphQL operation to be parsed and executed, if the event target is an AppSync API.

Archive

An Archive object that contains details about an archive.

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.

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.

BatchParameters

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

BatchRetryStrategy

The retry strategy to use for failed jobs, if the target is an Batch job. If you specify a retry strategy here, it overrides the retry strategy defined in the job definition.

CapacityProviderStrategyItem

The details of a capacity provider strategy. To learn more, see CapacityProviderStrategyItem in the Amazon ECS API Reference.

Condition

A JSON string which you can use to limit the event bus permissions you are granting to only accounts that fulfill the condition. Currently, the only supported condition is membership in a certain Amazon Web Services organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the Amazon Web Services organization. Following is an example value for Condition:

'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'

Connection

Contains information about a connection.

ConnectionApiKeyAuthResponseParameters

Contains the authorization parameters for the connection if API Key is specified as the authorization type.

ConnectionAuthResponseParameters

Tthe authorization parameters to use for the connection.

ConnectionBasicAuthResponseParameters

The authorization parameters for the connection if Basic is specified as the authorization type.

ConnectionBodyParameter

Additional parameter included in the body. You can include up to 100 additional body parameters per request. An event payload cannot exceed 64 KB.

ConnectionHeaderParameter

Additional parameter included in the header. You can include up to 100 additional header parameters per request. An event payload cannot exceed 64 KB.

ConnectionHttpParameters

Any additional parameters for the connection.

ConnectionOAuthClientResponseParameters

The client response parameters for the connection when OAuth is specified as the authorization type.

ConnectionOAuthResponseParameters

The response parameters when OAuth is specified as the authorization type.

ConnectionQueryStringParameter

Any additional query string parameter for the connection. You can include up to 100 additional query string parameters per request. Each additional parameter counts towards the event payload size, which cannot exceed 64 KB.

ConnectivityResourceConfigurationArn

The Amazon Resource Name (ARN) of the Amazon VPC Lattice resource configuration for the resource endpoint.

ConnectivityResourceParameters

The parameters for EventBridge to use when invoking the resource endpoint.

CreateConnectionApiKeyAuthRequestParameters

The API key authorization parameters for the connection.

CreateConnectionAuthRequestParameters

The authorization parameters for the connection.

You must include only authorization parameters for the AuthorizationType you specify.

CreateConnectionBasicAuthRequestParameters

Contains the Basic authorization parameters to use for the connection.

CreateConnectionOAuthClientRequestParameters

The Basic authorization parameters to use for the connection.

CreateConnectionOAuthRequestParameters

Contains the OAuth authorization parameters to use for the connection.

DeadLetterConfig

Configuration details of the Amazon SQS queue for EventBridge to use as a dead-letter queue (DLQ).

For more information, see Using dead-letter queues to process undelivered events in the EventBridge User Guide.

DescribeConnectionConnectivityParameters

If the connection uses a private OAuth endpoint, the parameters for EventBridge to use when authenticating against the endpoint.

For more information, see Authorization methods for connections in the Amazon EventBridge User Guide .

DescribeConnectionResourceParameters

The parameters for EventBridge to use when invoking the resource endpoint.

EcsParameters

The custom parameters to be used when the target is an Amazon ECS task.

Endpoint

A global endpoint used to improve your application's availability by making it regional-fault tolerant. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

EndpointEventBus

The event buses the endpoint is associated with.

EventBus

An event bus receives events from a source, uses rules to evaluate them, applies any configured input transformation, and routes them to the appropriate target(s). Your account's default event bus receives events from Amazon Web Services services. A custom event bus can receive events from your custom applications and services. A partner event bus receives events from an event source created by an SaaS partner. These events come from the partners services or applications.

EventSource

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.

FailoverConfig

The failover configuration for an endpoint. This includes what triggers failover and what happens when it's triggered.

HttpParameters

These are custom parameter to be used when the target is an API Gateway APIs or EventBridge ApiDestinations. In the latter case, these are merged with any InvocationParameters specified on the Connection, with any values from the Connection taking precedence.

InputTransformer

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

KinesisParameters

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis data stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

NetworkConfiguration

This structure specifies the network configuration for an ECS task.

PartnerEventSource

A partner event source is created by an SaaS partner. If a customer creates a partner event bus that matches this event source, that Amazon Web Services account can receive events from the partner's applications or services.

PartnerEventSourceAccount

The Amazon Web Services account that a partner event source has been offered to.

PlacementConstraint

An object representing a constraint on task placement. To learn more, see Task Placement Constraints in the Amazon Elastic Container Service Developer Guide.

PlacementStrategy

The task placement strategy for a task or service. To learn more, see Task Placement Strategies in the Amazon Elastic Container Service Service Developer Guide.

Primary

The primary Region of the endpoint.

PutEventsRequestEntry

Represents an event to be submitted.

PutEventsResultEntry

Represents the results of an event submitted to an event bus.

If the submission was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

For information about the errors that are common to all actions, see Common Errors.

PutPartnerEventsRequestEntry

The details about an event generated by an SaaS partner.

PutPartnerEventsResultEntry

The result of an event entry the partner submitted in this request. If the event was successfully submitted, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.

PutTargetsResultEntry

Represents a target that failed to be added to a rule.

RedshiftDataParameters

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.

RemoveTargetsResultEntry

Represents a target that failed to be removed from a rule.

Replay

A Replay object that contains details about a replay.

ReplayDestination

A ReplayDestination object that contains details about a replay.

ReplicationConfig

Endpoints can replicate all events to the secondary Region.

RetryPolicy

A RetryPolicy object that includes information about the retry policy settings.

RoutingConfig

The routing configuration of the endpoint.

Rule

Contains information about a rule in Amazon EventBridge.

RunCommandParameters

This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

RunCommandTarget

Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.

SageMakerPipelineParameter

Name/Value pair of a parameter to start execution of a SageMaker AI Model Building Pipeline.

SageMakerPipelineParameters

These are custom parameters to use when the target is a SageMaker AI Model Building Pipeline that starts based on EventBridge events.

Secondary

The secondary Region that processes events when failover is triggered or replication is enabled.

SqsParameters

This structure includes the custom parameter to be used when the target is an SQS FIFO queue.

Tag

A key-value pair associated with an Amazon Web Services resource. In EventBridge, rules and event buses support tagging.

Target

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

UpdateConnectionApiKeyAuthRequestParameters

Contains the API key authorization parameters to use to update the connection.

UpdateConnectionAuthRequestParameters

Contains the additional parameters to use for the connection.

UpdateConnectionBasicAuthRequestParameters

The Basic authorization parameters for the connection.

UpdateConnectionOAuthClientRequestParameters

The OAuth authorization parameters to use for the connection.

UpdateConnectionOAuthRequestParameters

The OAuth request parameters to use for the connection.

Enums

ApiDestinationHttpMethod

When writing a match expression against ApiDestinationHttpMethod, 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.

ApiDestinationState

When writing a match expression against ApiDestinationState, 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.

ArchiveState

When writing a match expression against ArchiveState, 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.

ConnectionAuthorizationType

When writing a match expression against ConnectionAuthorizationType, 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.

ConnectionOAuthHttpMethod

When writing a match expression against ConnectionOAuthHttpMethod, 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.

ConnectionState

When writing a match expression against ConnectionState, 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.

EndpointState

When writing a match expression against EndpointState, 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.

EventSourceState

When writing a match expression against EventSourceState, 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.

ReplayState

When writing a match expression against ReplayState, 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.

ReplicationState

When writing a match expression against ReplicationState, 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.

RuleState

When writing a match expression against RuleState, 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.