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§
- Activate
Event Source Request - AwsVpc
Configuration 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
awsvpcnetwork mode.- Batch
Array Properties 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.
- Batch
Parameters The custom parameters to be used when the target is an AWS Batch job.
- Batch
Retry Strategy 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.
- 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 AWS organization. The string must contain
Type,Key, andValuefields. TheValuefield specifies the ID of the AWS organization. Following is an example value forCondition:'{"Type" : "StringEquals", "Key": "aws:PrincipalOrgID", "Value": "o-1234567890"}'- Create
Event BusRequest - Create
Event BusResponse - Create
Partner Event Source Request - Create
Partner Event Source Response - Deactivate
Event Source Request - Delete
Event BusRequest - Delete
Partner Event Source Request - Delete
Rule Request - Describe
Event BusRequest - Describe
Event BusResponse - Describe
Event Source Request - Describe
Event Source Response - Describe
Partner Event Source Request - Describe
Partner Event Source Response - Describe
Rule Request - Describe
Rule Response - Disable
Rule Request - EcsParameters
The custom parameters to be used when the target is an Amazon ECS task.
- Enable
Rule Request - Event
Bridge Client - A client for the Amazon EventBridge API.
- Event
Bus 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 rules from AWS services. A custom event bus can receive rules from AWS services as well as 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.
- Event
Source 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.
- Http
Parameters These are custom parameter to be used when the target is an API Gateway REST APIs.
- Input
Transformer 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.
- Kinesis
Parameters 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
eventIdas the partition key.- List
Event Buses Request - List
Event Buses Response - List
Event Sources Request - List
Event Sources Response - List
Partner Event Source Accounts Request - List
Partner Event Source Accounts Response - List
Partner Event Sources Request - List
Partner Event Sources Response - List
Rule Names ByTarget Request - List
Rule Names ByTarget Response - List
Rules Request - List
Rules Response - List
Tags ForResource Request - List
Tags ForResource Response - List
Targets ByRule Request - List
Targets ByRule Response - Network
Configuration This structure specifies the network configuration for an ECS task.
- Partner
Event Source 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.
- Partner
Event Source Account The AWS account that a partner event source has been offered to.
- PutEvents
Request - PutEvents
Request Entry Represents an event to be submitted.
- PutEvents
Response - PutEvents
Result Entry Represents an event that failed to be submitted.
- PutPartner
Events Request - PutPartner
Events Request Entry The details about an event generated by an SaaS partner.
- PutPartner
Events Response - PutPartner
Events Result Entry Represents an event that a partner tried to generate, but failed.
- PutPermission
Request - PutRule
Request - PutRule
Response - PutTargets
Request - PutTargets
Response - PutTargets
Result Entry Represents a target that failed to be added to a rule.
- Remove
Permission Request - Remove
Targets Request - Remove
Targets Response - Remove
Targets Result Entry Represents a target that failed to be removed from a rule.
- Rule
Contains information about a rule in Amazon EventBridge.
- RunCommand
Parameters This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.
- RunCommand
Target Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each
RunCommandTargetblock can include only one key, but this key may specify multiple values.- 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 AWS resource. In EventBridge, rules and event buses support tagging.
- TagResource
Request - TagResource
Response - 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
RoleArnwith proper permissions in theTargetstructure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.- Test
Event Pattern Request - Test
Event Pattern Response - Untag
Resource Request - Untag
Resource Response
Enums§
- Activate
Event Source Error - Errors returned by ActivateEventSource
- Create
Event BusError - Errors returned by CreateEventBus
- Create
Partner Event Source Error - Errors returned by CreatePartnerEventSource
- Deactivate
Event Source Error - Errors returned by DeactivateEventSource
- Delete
Event BusError - Errors returned by DeleteEventBus
- Delete
Partner Event Source Error - Errors returned by DeletePartnerEventSource
- Delete
Rule Error - Errors returned by DeleteRule
- Describe
Event BusError - Errors returned by DescribeEventBus
- Describe
Event Source Error - Errors returned by DescribeEventSource
- Describe
Partner Event Source Error - Errors returned by DescribePartnerEventSource
- Describe
Rule Error - Errors returned by DescribeRule
- Disable
Rule Error - Errors returned by DisableRule
- Enable
Rule Error - Errors returned by EnableRule
- List
Event Buses Error - Errors returned by ListEventBuses
- List
Event Sources Error - Errors returned by ListEventSources
- List
Partner Event Source Accounts Error - Errors returned by ListPartnerEventSourceAccounts
- List
Partner Event Sources Error - Errors returned by ListPartnerEventSources
- List
Rule Names ByTarget Error - Errors returned by ListRuleNamesByTarget
- List
Rules Error - Errors returned by ListRules
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
Targets ByRule Error - Errors returned by ListTargetsByRule
- PutEvents
Error - Errors returned by PutEvents
- PutPartner
Events Error - Errors returned by PutPartnerEvents
- PutPermission
Error - Errors returned by PutPermission
- PutRule
Error - Errors returned by PutRule
- PutTargets
Error - Errors returned by PutTargets
- Remove
Permission Error - Errors returned by RemovePermission
- Remove
Targets Error - Errors returned by RemoveTargets
- TagResource
Error - Errors returned by TagResource
- Test
Event Pattern Error - Errors returned by TestEventPattern
- Untag
Resource Error - Errors returned by UntagResource
Traits§
- Event
Bridge - Trait representing the capabilities of the Amazon EventBridge API. Amazon EventBridge clients implement this trait.