logo
Expand description

Amazon EventBridge helps you to respond to state changes in your AWS resources. When your resources change state, they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:

  • Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.

  • Direct specific API records from AWS CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.

  • Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.

For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.

If you’re using the service, you’re probably looking for EventBridgeClient and EventBridge.

Structs

Contains details about an API destination.

An Archive object that contains details about an archive.

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.

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 AWS Batch job.

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

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

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

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 AWS organization. The string must contain Type, Key, and Value fields. The Value field specifies the ID of the AWS organization. Following is an example value for Condition:

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

Contains information about a connection.

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

Contains the authorization parameters to use for the connection.

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

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

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

Contains additional parameters for the connection.

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

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

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.

Contains the API key authorization parameters for the connection.

Contains the authorization parameters for the connection.

Contains the Basic authorization parameters to use for the connection.

Contains the Basic authorization parameters to use for the connection.

Contains the OAuth authorization parameters to use for the connection.

A DeadLetterConfig object that contains information about a dead-letter queue configuration.

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

A client for the Amazon EventBridge API.

An event bus receives events from a source and routes them to rules associated with that event bus. Your account's default event bus receives events from AWS 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.

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

These are custom parameter to be used when the target is an API Gateway REST 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.

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.

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.

This structure specifies the network configuration for an ECS task.

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

The AWS account that a partner event source has been offered to.

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

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

Represents an event to be submitted.

Represents an event that failed to be submitted.

The details about an event generated by an SaaS partner.

Represents an event that a partner tried to generate, but failed.

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

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

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

A Replay object that contains details about a replay.

A ReplayDestination object that contains details about a replay.

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

Contains information about a rule in Amazon EventBridge.

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

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.

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

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

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

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

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 AWS Accounts in the Amazon EventBridge User Guide.

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

Contains the additional parameters to use for the connection.

Contains the Basic authorization parameters for the connection.

Contains the OAuth authorization parameters to use for the connection.

Contains the OAuth request parameters to use for the connection.

Enums

Errors returned by ActivateEventSource

Errors returned by CancelReplay

Errors returned by CreateApiDestination

Errors returned by CreateArchive

Errors returned by CreateConnection

Errors returned by CreateEventBus

Errors returned by CreatePartnerEventSource

Errors returned by DeactivateEventSource

Errors returned by DeauthorizeConnection

Errors returned by DeleteApiDestination

Errors returned by DeleteArchive

Errors returned by DeleteConnection

Errors returned by DeleteEventBus

Errors returned by DeletePartnerEventSource

Errors returned by DeleteRule

Errors returned by DescribeApiDestination

Errors returned by DescribeArchive

Errors returned by DescribeConnection

Errors returned by DescribeEventBus

Errors returned by DescribeEventSource

Errors returned by DescribePartnerEventSource

Errors returned by DescribeReplay

Errors returned by DescribeRule

Errors returned by DisableRule

Errors returned by EnableRule

Errors returned by ListApiDestinations

Errors returned by ListArchives

Errors returned by ListConnections

Errors returned by ListEventBuses

Errors returned by ListEventSources

Errors returned by ListPartnerEventSourceAccounts

Errors returned by ListPartnerEventSources

Errors returned by ListReplays

Errors returned by ListRuleNamesByTarget

Errors returned by ListRules

Errors returned by ListTagsForResource

Errors returned by ListTargetsByRule

Errors returned by PutEvents

Errors returned by PutPartnerEvents

Errors returned by PutPermission

Errors returned by PutRule

Errors returned by PutTargets

Errors returned by RemovePermission

Errors returned by RemoveTargets

Errors returned by StartReplay

Errors returned by TagResource

Errors returned by TestEventPattern

Errors returned by UntagResource

Errors returned by UpdateApiDestination

Errors returned by UpdateArchive

Errors returned by UpdateConnection

Traits

Trait representing the capabilities of the Amazon EventBridge API. Amazon EventBridge clients implement this trait.