Namespace Amazon.EventBridge.Model

Classes

ActivateEventSourceRequest: Container for the parameters to the ActivateEventSource operation. Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

ActivateEventSourceResponse: This is the response object from the ActivateEventSource operation.

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.

CancelReplayRequest: Container for the parameters to the CancelReplay operation. Cancels the specified replay.

CancelReplayResponse: This is the response object from the CancelReplay operation.

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

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.

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: Contains the authorization parameters to use for the connection.

ConnectionBasicAuthResponseParameters: Contains 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: Contains additional parameters for the connection.

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

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

ConnectionQueryStringParameter: 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.

CreateApiDestinationRequest

Container for the parameters to the CreateApiDestination operation. Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.

API destinations do not support private destinations, such as interface VPC endpoints.

For more information, see API destinations in the EventBridge User Guide.

CreateApiDestinationResponse: This is the response object from the CreateApiDestination operation.

CreateArchiveRequest

Container for the parameters to the CreateArchive operation. Creates an archive of events with the specified settings. When you create an archive, incoming events might not immediately start being sent to the archive. Allow a short period of time for changes to take effect. If you do not specify a pattern to filter events sent to the archive, all events are sent to the archive except replayed events. Replayed events are not sent to an archive.

note

Archives and schema discovery are not supported for event buses encrypted using a customer managed key. EventBridge returns an error if:

You call CreateArchive on an event bus set to use a customer managed key for encryption.
You call CreateDiscoverer on an event bus set to use a customer managed key for encryption.
You call UpdatedEventBus to set a customer managed key on an event bus with an archives or schema discovery enabled.

To enable archives or schema discovery on an event bus, choose to use an Amazon Web Services owned key. For more information, see Data encryption in EventBridge in the Amazon EventBridge User Guide.

CreateArchiveResponse: This is the response object from the CreateArchive operation.

CreateConnectionApiKeyAuthRequestParameters: Contains the API key authorization parameters for the connection.

CreateConnectionAuthRequestParameters: Contains the authorization parameters for the connection.

CreateConnectionBasicAuthRequestParameters: Contains the Basic authorization parameters to use for the connection.

CreateConnectionOAuthClientRequestParameters: Contains the Basic authorization parameters to use for the connection.

CreateConnectionOAuthRequestParameters: Contains the OAuth authorization parameters to use for the connection.

CreateConnectionRequest: Container for the parameters to the CreateConnection operation. Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

CreateConnectionResponse: This is the response object from the CreateConnection operation.

CreateEndpointRequest: Container for the parameters to the CreateEndpoint operation. Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.

CreateEndpointResponse: This is the response object from the CreateEndpoint operation.

CreateEventBusRequest: Container for the parameters to the CreateEventBus operation. Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

CreateEventBusResponse: This is the response object from the CreateEventBus operation.

CreatePartnerEventSourceRequest

Container for the parameters to the CreatePartnerEventSource operation. Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.

Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types.

A partner event source creates events based on resources within the SaaS partner's service or application.

An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets.

Partner event source names follow this format:

partner_name/event_namespace/event_name

partner_name is determined during partner registration, and identifies the partner to Amazon Web Services customers.
event_namespace is determined by the partner, and is a way for the partner to categorize their events.
event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system.

The event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account.

The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.

CreatePartnerEventSourceResponse: This is the response object from the CreatePartnerEventSource operation.

DeactivateEventSourceRequest

Container for the parameters to the DeactivateEventSource operation. You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted.

When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted.

To activate a deactivated partner event source, use ActivateEventSource.

DeactivateEventSourceResponse: This is the response object from the DeactivateEventSource operation.

DeadLetterConfig

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

For more information, see Event retry policy and using dead-letter queues in the EventBridge User Guide.

DeauthorizeConnectionRequest: Container for the parameters to the DeauthorizeConnection operation. Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.

DeauthorizeConnectionResponse: This is the response object from the DeauthorizeConnection operation.

DeleteApiDestinationRequest: Container for the parameters to the DeleteApiDestination operation. Deletes the specified API destination.

DeleteApiDestinationResponse: This is the response object from the DeleteApiDestination operation.

DeleteArchiveRequest: Container for the parameters to the DeleteArchive operation. Deletes the specified archive.

DeleteArchiveResponse: This is the response object from the DeleteArchive operation.

DeleteConnectionRequest: Container for the parameters to the DeleteConnection operation. Deletes a connection.

DeleteConnectionResponse: This is the response object from the DeleteConnection operation.

DeleteEndpointRequest: Container for the parameters to the DeleteEndpoint operation. Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

DeleteEndpointResponse: This is the response object from the DeleteEndpoint operation.

DeleteEventBusRequest: Container for the parameters to the DeleteEventBus operation. Deletes the specified custom event bus or partner event bus. All rules associated with this event bus need to be deleted. You can't delete your account's default event bus.

DeleteEventBusResponse: This is the response object from the DeleteEventBus operation.

DeletePartnerEventSourceRequest

Container for the parameters to the DeletePartnerEventSource operation. This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers.

When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.

DeletePartnerEventSourceResponse: This is the response object from the DeletePartnerEventSource operation.

DeleteRuleRequest

Container for the parameters to the DeleteRule operation. Deletes the specified rule.

Before you can delete the rule, you must remove all targets, using RemoveTargets.

When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.

If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus, ResourceNotFoundException is returned.

Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.

DeleteRuleResponse: This is the response object from the DeleteRule operation.

DescribeApiDestinationRequest: Container for the parameters to the DescribeApiDestination operation. Retrieves details about an API destination.

DescribeApiDestinationResponse: This is the response object from the DescribeApiDestination operation.

DescribeArchiveRequest: Container for the parameters to the DescribeArchive operation. Retrieves details about an archive.

DescribeArchiveResponse: This is the response object from the DescribeArchive operation.

DescribeConnectionRequest: Container for the parameters to the DescribeConnection operation. Retrieves details about a connection.

DescribeConnectionResponse: This is the response object from the DescribeConnection operation.

DescribeEndpointRequest: Container for the parameters to the DescribeEndpoint operation. Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

DescribeEndpointResponse: This is the response object from the DescribeEndpoint operation.

DescribeEventBusRequest

Container for the parameters to the DescribeEventBus operation. Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.

To enable your account to receive events from other accounts on its default event bus, use PutPermission.

For more information about partner event buses, see CreateEventBus.

DescribeEventBusResponse: This is the response object from the DescribeEventBus operation.

DescribeEventSourceRequest: Container for the parameters to the DescribeEventSource operation. This operation lists details about a partner event source that is shared with your account.

DescribeEventSourceResponse: This is the response object from the DescribeEventSource operation.

DescribePartnerEventSourceRequest: Container for the parameters to the DescribePartnerEventSource operation. An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.

DescribePartnerEventSourceResponse: This is the response object from the DescribePartnerEventSource operation.

DescribeReplayRequest: Container for the parameters to the DescribeReplay operation. Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

DescribeReplayResponse: This is the response object from the DescribeReplay operation.

DescribeRuleRequest

Container for the parameters to the DescribeRule operation. Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

DescribeRuleResponse: This is the response object from the DescribeRule operation.

DisableRuleRequest

Container for the parameters to the DisableRule operation. Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

When you disable a rule, incoming events might continue to match to the disabled rule. Allow a short period of time for changes to take effect.

DisableRuleResponse: This is the response object from the DisableRule operation.

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

EnableRuleRequest

Container for the parameters to the EnableRule operation. Enables the specified rule. If the rule does not exist, the operation fails.

When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Allow a short period of time for changes to take effect.

EnableRuleResponse: This is the response object from the EnableRule operation.

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.

IllegalStatusException: An error occurred because a replay can be canceled only when the state is Running or Starting.

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.

InternalException: This exception occurs due to unexpected causes.

InvalidEventPatternException: The event pattern is not valid.

InvalidStateException: The specified state is not a valid state for an event source.

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.

LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.

ListApiDestinationsRequest: Container for the parameters to the ListApiDestinations operation. Retrieves a list of API destination in the account in the current Region.

ListApiDestinationsResponse: This is the response object from the ListApiDestinations operation.

ListArchivesRequest: Container for the parameters to the ListArchives operation. Lists your archives. You can either list all the archives or you can provide a prefix to match to the archive names. Filter parameters are exclusive.

ListArchivesResponse: This is the response object from the ListArchives operation.

ListConnectionsRequest: Container for the parameters to the ListConnections operation. Retrieves a list of connections from the account.

ListConnectionsResponse: This is the response object from the ListConnections operation.

ListEndpointsRequest: Container for the parameters to the ListEndpoints operation. List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

ListEndpointsResponse: This is the response object from the ListEndpoints operation.

ListEventBusesRequest: Container for the parameters to the ListEventBuses operation. Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

ListEventBusesResponse: This is the response object from the ListEventBuses operation.

ListEventSourcesRequest: Container for the parameters to the ListEventSources operation. You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.

ListEventSourcesResponse: This is the response object from the ListEventSources operation.

ListPartnerEventSourceAccountsRequest: Container for the parameters to the ListPartnerEventSourceAccounts operation. An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.

ListPartnerEventSourceAccountsResponse: This is the response object from the ListPartnerEventSourceAccounts operation.

ListPartnerEventSourcesRequest: Container for the parameters to the ListPartnerEventSources operation. An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.

ListPartnerEventSourcesResponse: This is the response object from the ListPartnerEventSources operation.

ListReplaysRequest: Container for the parameters to the ListReplays operation. Lists your replays. You can either list all the replays or you can provide a prefix to match to the replay names. Filter parameters are exclusive.

ListReplaysResponse: This is the response object from the ListReplays operation.

ListRuleNamesByTargetRequest

Container for the parameters to the ListRuleNamesByTarget operation. Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.

The maximum number of results per page for requests is 100.

ListRuleNamesByTargetResponse: This is the response object from the ListRuleNamesByTarget operation.

ListRulesRequest

Container for the parameters to the ListRules operation. Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.

The maximum number of results per page for requests is 100.

ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

ListRulesResponse: This is the response object from the ListRules operation.

ListTagsForResourceRequest: Container for the parameters to the ListTagsForResource operation. Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.

ListTagsForResourceResponse: This is the response object from the ListTagsForResource operation.

ListTargetsByRuleRequest

Container for the parameters to the ListTargetsByRule operation. Lists the targets assigned to the specified rule.

The maximum number of results per page for requests is 100.

ListTargetsByRuleResponse: This is the response object from the ListTargetsByRule operation.

ManagedRuleException: This rule was created by an Amazon Web Services service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, PutRule, TagResource, or UntagResource.

NetworkConfiguration: This structure specifies the network configuration for an ECS task.

OperationDisabledException: The operation you are attempting is not available in this region.

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.

PolicyLengthExceededException: The event bus policy is too long. For more information, see the limits.

Primary: The primary Region of the endpoint.

PutEventsRequest

Container for the parameters to the PutEvents operation. Sends custom events to Amazon EventBridge so that they can be matched to rules.

The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event. To learn more, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide

PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.

note

PutEvents will only process nested JSON up to 1100 levels deep.

PutEventsRequestEntry: Represents an event to be submitted.

PutEventsResponse: This is the response object from the PutEvents operation.

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.

PutPartnerEventsRequest

Container for the parameters to the PutPartnerEvents operation. This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.

For information on calculating event batch size, see Calculating EventBridge PutEvents event entry size in the EventBridge User Guide.

PutPartnerEventsRequestEntry: The details about an event generated by an SaaS partner.

PutPartnerEventsResponse: This is the response object from the PutPartnerEvents operation.

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.

PutPermissionRequest

Container for the parameters to the PutPermission operation. Running PutPermission permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.

For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.

To enable multiple Amazon Web Services accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can run PutPermission once specifying Principal as "*" and specifying the Amazon Web Services organization ID in Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.

The permission policy on the event bus cannot exceed 10 KB in size.

PutPermissionResponse: This is the response object from the PutPermission operation.

PutRuleRequest

Container for the parameters to the PutRule operation. Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.

A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.

If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values.

When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.

A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.

When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.

If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.

Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.

In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.

To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.

An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.

PutRuleResponse: This is the response object from the PutRule operation.

PutTargetsRequest

Container for the parameters to the PutTargets operation. Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

The maximum number of entries per request is 10.

note

Each rule can have up to five (5) targets associated with it at one time.

For a list of services you can configure as targets for events, see EventBridge targets in the Amazon EventBridge User Guide .

Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are:

Amazon EBS CreateSnapshot API call
Amazon EC2 RebootInstances API call
Amazon EC2 StopInstances API call
Amazon EC2 TerminateInstances API call

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:

For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets.

For more information, see Authentication and Access Control in the Amazon EventBridge User Guide .

If another Amazon Web Services account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing.

note

Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services account.

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.

note

If you have an IAM role on a cross-account event bus target, a PutTargets call without a role on the same target (same Id and Arn) will not remove the role.

For more information about enabling cross-account events, see PutPermission.

Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

PutTargetsResponse: This is the response object from the PutTargets operation.

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.

RemovePermissionRequest: Container for the parameters to the RemovePermission operation. Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.

RemovePermissionResponse: This is the response object from the RemovePermission operation.

RemoveTargetsRequest

Container for the parameters to the RemoveTargets operation. Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

note

A successful execution of RemoveTargets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.

When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.

The maximum number of entries per request is 10.

RemoveTargetsResponse: This is the response object from the RemoveTargets operation.

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.

ResourceAlreadyExistsException: The resource you are trying to create already exists.

ResourceNotFoundException: An entity that you specified does not exist.

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 Model Building Pipeline.

SageMakerPipelineParameters: These are custom parameters to use when the target is a SageMaker 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.

StartReplayRequest: Container for the parameters to the StartReplay operation. Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.

StartReplayResponse: This is the response object from the StartReplay operation.

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

TagResourceRequest

Container for the parameters to the TagResource operation. Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.

Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.

You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.

You can associate as many as 50 tags with a resource.

TagResourceResponse: This is the response object from the TagResource operation.

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.

TestEventPatternRequest

Container for the parameters to the TestEventPattern operation. Tests whether the specified event pattern matches the provided event.

TestEventPatternResponse: This is the response object from the TestEventPattern operation.

UntagResourceRequest: Container for the parameters to the UntagResource operation. Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.

UntagResourceResponse: This is the response object from the UntagResource operation.

UpdateApiDestinationRequest: Container for the parameters to the UpdateApiDestination operation. Updates an API destination.

UpdateApiDestinationResponse: This is the response object from the UpdateApiDestination operation.

UpdateArchiveRequest: Container for the parameters to the UpdateArchive operation. Updates the specified archive.

UpdateArchiveResponse: This is the response object from the UpdateArchive operation.

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

UpdateConnectionAuthRequestParameters: Contains the additional parameters to use for the connection.

UpdateConnectionBasicAuthRequestParameters: Contains the Basic authorization parameters for the connection.

UpdateConnectionOAuthClientRequestParameters: Contains the OAuth authorization parameters to use for the connection.

UpdateConnectionOAuthRequestParameters: Contains the OAuth request parameters to use for the connection.

UpdateConnectionRequest: Container for the parameters to the UpdateConnection operation. Updates settings for a connection.

UpdateConnectionResponse: This is the response object from the UpdateConnection operation.

UpdateEndpointRequest: Container for the parameters to the UpdateEndpoint operation. Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide .

UpdateEndpointResponse: This is the response object from the UpdateEndpoint operation.

UpdateEventBusRequest: Container for the parameters to the UpdateEventBus operation. Updates the specified event bus.

UpdateEventBusResponse: This is the response object from the UpdateEventBus operation.

Table of Contents

Namespace Amazon.EventBridge.Model

Classes

note

note

note

note

note

note