Interface IAmazonEventBridge

Namespace: Amazon.EventBridge

Assembly: AWSSDK.EventBridge.dll

Interface for accessing EventBridge

Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to 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 Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
Direct specific API records from 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.

public interface IAmazonEventBridge : IAmazonService, IDisposable

Inherited Members: IDisposable.Dispose()

Methods

ActivateEventSourceAsync(ActivateEventSourceRequest, CancellationToken)

Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

Task<ActivateEventSourceResponse> ActivateEventSourceAsync(ActivateEventSourceRequest request, CancellationToken cancellationToken = default)

Parameters

request ActivateEventSourceRequest: Container for the necessary parameters to execute the ActivateEventSource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ActivateEventSourceResponse>: The response from the ActivateEventSource service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
InvalidStateException: The specified state is not a valid state for an event source.
OperationDisabledException: The operation you are attempting is not available in this region.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for ActivateEventSource Operation

CancelReplayAsync(CancelReplayRequest, CancellationToken)

Cancels the specified replay.

Task<CancelReplayResponse> CancelReplayAsync(CancelReplayRequest request, CancellationToken cancellationToken = default)

Parameters

request CancelReplayRequest: Container for the necessary parameters to execute the CancelReplay service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CancelReplayResponse>: The response from the CancelReplay service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
IllegalStatusException: An error occurred because a replay can be canceled only when the state is Running or Starting.
InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for CancelReplay Operation

CreateApiDestinationAsync(CreateApiDestinationRequest, CancellationToken)

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.

Task<CreateApiDestinationResponse> CreateApiDestinationAsync(CreateApiDestinationRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateApiDestinationRequest: Container for the necessary parameters to execute the CreateApiDestination service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateApiDestinationResponse>: The response from the CreateApiDestination service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
ResourceAlreadyExistsException: The resource you are trying to create already exists.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for CreateApiDestination Operation

CreateArchiveAsync(CreateArchiveRequest, CancellationToken)

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.

Task<CreateArchiveResponse> CreateArchiveAsync(CreateArchiveRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateArchiveRequest: Container for the necessary parameters to execute the CreateArchive service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateArchiveResponse>: The response from the CreateArchive service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
InvalidEventPatternException: The event pattern is not valid.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
ResourceAlreadyExistsException: The resource you are trying to create already exists.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for CreateArchive Operation

CreateConnectionAsync(CreateConnectionRequest, CancellationToken)

Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.

Task<CreateConnectionResponse> CreateConnectionAsync(CreateConnectionRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateConnectionRequest: Container for the necessary parameters to execute the CreateConnection service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateConnectionResponse>: The response from the CreateConnection service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
ResourceAlreadyExistsException: The resource you are trying to create already exists.

See Also: REST API Reference for CreateConnection Operation

CreateEndpointAsync(CreateEndpointRequest, CancellationToken)

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.

Task<CreateEndpointResponse> CreateEndpointAsync(CreateEndpointRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateEndpointRequest: Container for the necessary parameters to execute the CreateEndpoint service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateEndpointResponse>: The response from the CreateEndpoint service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
ResourceAlreadyExistsException: The resource you are trying to create already exists.

See Also: REST API Reference for CreateEndpoint Operation

CreateEventBusAsync(CreateEventBusRequest, CancellationToken)

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.

Task<CreateEventBusResponse> CreateEventBusAsync(CreateEventBusRequest request, CancellationToken cancellationToken = default)

Parameters

request CreateEventBusRequest: Container for the necessary parameters to execute the CreateEventBus service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreateEventBusResponse>: The response from the CreateEventBus service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
InvalidStateException: The specified state is not a valid state for an event source.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
OperationDisabledException: The operation you are attempting is not available in this region.
ResourceAlreadyExistsException: The resource you are trying to create already exists.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for CreateEventBus Operation

CreatePartnerEventSourceAsync(CreatePartnerEventSourceRequest, CancellationToken)

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.

Task<CreatePartnerEventSourceResponse> CreatePartnerEventSourceAsync(CreatePartnerEventSourceRequest request, CancellationToken cancellationToken = default)

Parameters

request CreatePartnerEventSourceRequest: Container for the necessary parameters to execute the CreatePartnerEventSource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<CreatePartnerEventSourceResponse>: The response from the CreatePartnerEventSource service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
OperationDisabledException: The operation you are attempting is not available in this region.
ResourceAlreadyExistsException: The resource you are trying to create already exists.

See Also: REST API Reference for CreatePartnerEventSource Operation

DeactivateEventSourceAsync(DeactivateEventSourceRequest, CancellationToken)

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.

Task<DeactivateEventSourceResponse> DeactivateEventSourceAsync(DeactivateEventSourceRequest request, CancellationToken cancellationToken = default)

Parameters

request DeactivateEventSourceRequest: Container for the necessary parameters to execute the DeactivateEventSource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeactivateEventSourceResponse>: The response from the DeactivateEventSource service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
InvalidStateException: The specified state is not a valid state for an event source.
OperationDisabledException: The operation you are attempting is not available in this region.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DeactivateEventSource Operation

DeauthorizeConnectionAsync(DeauthorizeConnectionRequest, CancellationToken)

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.

Task<DeauthorizeConnectionResponse> DeauthorizeConnectionAsync(DeauthorizeConnectionRequest request, CancellationToken cancellationToken = default)

Parameters

request DeauthorizeConnectionRequest: Container for the necessary parameters to execute the DeauthorizeConnection service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeauthorizeConnectionResponse>: The response from the DeauthorizeConnection service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DeauthorizeConnection Operation

DeleteApiDestinationAsync(DeleteApiDestinationRequest, CancellationToken)

Deletes the specified API destination.

Task<DeleteApiDestinationResponse> DeleteApiDestinationAsync(DeleteApiDestinationRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteApiDestinationRequest: Container for the necessary parameters to execute the DeleteApiDestination service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteApiDestinationResponse>: The response from the DeleteApiDestination service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DeleteApiDestination Operation

DeleteArchiveAsync(DeleteArchiveRequest, CancellationToken)

Deletes the specified archive.

Task<DeleteArchiveResponse> DeleteArchiveAsync(DeleteArchiveRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteArchiveRequest: Container for the necessary parameters to execute the DeleteArchive service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteArchiveResponse>: The response from the DeleteArchive service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DeleteArchive Operation

DeleteConnectionAsync(DeleteConnectionRequest, CancellationToken)

Deletes a connection.

Task<DeleteConnectionResponse> DeleteConnectionAsync(DeleteConnectionRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteConnectionRequest: Container for the necessary parameters to execute the DeleteConnection service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteConnectionResponse>: The response from the DeleteConnection service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DeleteConnection Operation

DeleteEndpointAsync(DeleteEndpointRequest, CancellationToken)

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 .

Task<DeleteEndpointResponse> DeleteEndpointAsync(DeleteEndpointRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteEndpointRequest: Container for the necessary parameters to execute the DeleteEndpoint service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteEndpointResponse>: The response from the DeleteEndpoint service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DeleteEndpoint Operation

DeleteEventBusAsync(DeleteEventBusRequest, CancellationToken)

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.

Task<DeleteEventBusResponse> DeleteEventBusAsync(DeleteEventBusRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteEventBusRequest: Container for the necessary parameters to execute the DeleteEventBus service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteEventBusResponse>: The response from the DeleteEventBus service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.

See Also: REST API Reference for DeleteEventBus Operation

DeletePartnerEventSourceAsync(DeletePartnerEventSourceRequest, CancellationToken)

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.

Task<DeletePartnerEventSourceResponse> DeletePartnerEventSourceAsync(DeletePartnerEventSourceRequest request, CancellationToken cancellationToken = default)

Parameters

request DeletePartnerEventSourceRequest: Container for the necessary parameters to execute the DeletePartnerEventSource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeletePartnerEventSourceResponse>: The response from the DeletePartnerEventSource service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.

See Also: REST API Reference for DeletePartnerEventSource Operation

DeleteRuleAsync(DeleteRuleRequest, CancellationToken)

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.

Task<DeleteRuleResponse> DeleteRuleAsync(DeleteRuleRequest request, CancellationToken cancellationToken = default)

Parameters

request DeleteRuleRequest: Container for the necessary parameters to execute the DeleteRule service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DeleteRuleResponse>: The response from the DeleteRule service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
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.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DeleteRule Operation

DescribeApiDestinationAsync(DescribeApiDestinationRequest, CancellationToken)

Retrieves details about an API destination.

Task<DescribeApiDestinationResponse> DescribeApiDestinationAsync(DescribeApiDestinationRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeApiDestinationRequest: Container for the necessary parameters to execute the DescribeApiDestination service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeApiDestinationResponse>: The response from the DescribeApiDestination service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DescribeApiDestination Operation

DescribeArchiveAsync(DescribeArchiveRequest, CancellationToken)

Retrieves details about an archive.

Task<DescribeArchiveResponse> DescribeArchiveAsync(DescribeArchiveRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeArchiveRequest: Container for the necessary parameters to execute the DescribeArchive service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeArchiveResponse>: The response from the DescribeArchive service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceAlreadyExistsException: The resource you are trying to create already exists.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DescribeArchive Operation

DescribeConnectionAsync(DescribeConnectionRequest, CancellationToken)

Retrieves details about a connection.

Task<DescribeConnectionResponse> DescribeConnectionAsync(DescribeConnectionRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeConnectionRequest: Container for the necessary parameters to execute the DescribeConnection service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeConnectionResponse>: The response from the DescribeConnection service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DescribeConnection Operation

DescribeEndpointAsync(DescribeEndpointRequest, CancellationToken)

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 .

Task<DescribeEndpointResponse> DescribeEndpointAsync(DescribeEndpointRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeEndpointRequest: Container for the necessary parameters to execute the DescribeEndpoint service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeEndpointResponse>: The response from the DescribeEndpoint service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DescribeEndpoint Operation

DescribeEventBusAsync(DescribeEventBusRequest, CancellationToken)

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.

Task<DescribeEventBusResponse> DescribeEventBusAsync(DescribeEventBusRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeEventBusRequest: Container for the necessary parameters to execute the DescribeEventBus service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeEventBusResponse>: The response from the DescribeEventBus service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DescribeEventBus Operation

DescribeEventSourceAsync(DescribeEventSourceRequest, CancellationToken)

This operation lists details about a partner event source that is shared with your account.

Task<DescribeEventSourceResponse> DescribeEventSourceAsync(DescribeEventSourceRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeEventSourceRequest: Container for the necessary parameters to execute the DescribeEventSource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeEventSourceResponse>: The response from the DescribeEventSource service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DescribeEventSource Operation

DescribePartnerEventSourceAsync(DescribePartnerEventSourceRequest, CancellationToken)

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.

Task<DescribePartnerEventSourceResponse> DescribePartnerEventSourceAsync(DescribePartnerEventSourceRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribePartnerEventSourceRequest: Container for the necessary parameters to execute the DescribePartnerEventSource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribePartnerEventSourceResponse>: The response from the DescribePartnerEventSource service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DescribePartnerEventSource Operation

DescribeReplayAsync(DescribeReplayRequest, CancellationToken)

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.

Task<DescribeReplayResponse> DescribeReplayAsync(DescribeReplayRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeReplayRequest: Container for the necessary parameters to execute the DescribeReplay service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeReplayResponse>: The response from the DescribeReplay service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DescribeReplay Operation

DescribeRuleAsync(DescribeRuleRequest, CancellationToken)

Describes the specified rule.

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

Task<DescribeRuleResponse> DescribeRuleAsync(DescribeRuleRequest request, CancellationToken cancellationToken = default)

Parameters

request DescribeRuleRequest: Container for the necessary parameters to execute the DescribeRule service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DescribeRuleResponse>: The response from the DescribeRule service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DescribeRule Operation

DetermineServiceOperationEndpoint(AmazonWebServiceRequest)

Returns the endpoint that will be used for a particular request.

Endpoint DetermineServiceOperationEndpoint(AmazonWebServiceRequest request)

Parameters

request AmazonWebServiceRequest: Request for the desired service operation.

Returns

Endpoint: The resolved endpoint for the given request.

DisableRuleAsync(DisableRuleRequest, CancellationToken)

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.

Task<DisableRuleResponse> DisableRuleAsync(DisableRuleRequest request, CancellationToken cancellationToken = default)

Parameters

request DisableRuleRequest: Container for the necessary parameters to execute the DisableRule service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<DisableRuleResponse>: The response from the DisableRule service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
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.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for DisableRule Operation

EnableRuleAsync(EnableRuleRequest, CancellationToken)

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.

Task<EnableRuleResponse> EnableRuleAsync(EnableRuleRequest request, CancellationToken cancellationToken = default)

Parameters

request EnableRuleRequest: Container for the necessary parameters to execute the EnableRule service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<EnableRuleResponse>: The response from the EnableRule service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
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.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for EnableRule Operation

ListApiDestinationsAsync(ListApiDestinationsRequest, CancellationToken)

Retrieves a list of API destination in the account in the current Region.

Task<ListApiDestinationsResponse> ListApiDestinationsAsync(ListApiDestinationsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListApiDestinationsRequest: Container for the necessary parameters to execute the ListApiDestinations service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListApiDestinationsResponse>: The response from the ListApiDestinations service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.

See Also: REST API Reference for ListApiDestinations Operation

ListArchivesAsync(ListArchivesRequest, CancellationToken)

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.

Task<ListArchivesResponse> ListArchivesAsync(ListArchivesRequest request, CancellationToken cancellationToken = default)

Parameters

request ListArchivesRequest: Container for the necessary parameters to execute the ListArchives service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListArchivesResponse>: The response from the ListArchives service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for ListArchives Operation

ListConnectionsAsync(ListConnectionsRequest, CancellationToken)

Retrieves a list of connections from the account.

Task<ListConnectionsResponse> ListConnectionsAsync(ListConnectionsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListConnectionsRequest: Container for the necessary parameters to execute the ListConnections service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListConnectionsResponse>: The response from the ListConnections service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.

See Also: REST API Reference for ListConnections Operation

ListEndpointsAsync(ListEndpointsRequest, CancellationToken)

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 .

Task<ListEndpointsResponse> ListEndpointsAsync(ListEndpointsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListEndpointsRequest: Container for the necessary parameters to execute the ListEndpoints service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListEndpointsResponse>: The response from the ListEndpoints service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.

See Also: REST API Reference for ListEndpoints Operation

ListEventBusesAsync(ListEventBusesRequest, CancellationToken)

Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.

Task<ListEventBusesResponse> ListEventBusesAsync(ListEventBusesRequest request, CancellationToken cancellationToken = default)

Parameters

request ListEventBusesRequest: Container for the necessary parameters to execute the ListEventBuses service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListEventBusesResponse>: The response from the ListEventBuses service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.

See Also: REST API Reference for ListEventBuses Operation

ListEventSourcesAsync(ListEventSourcesRequest, CancellationToken)

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.

Task<ListEventSourcesResponse> ListEventSourcesAsync(ListEventSourcesRequest request, CancellationToken cancellationToken = default)

Parameters

request ListEventSourcesRequest: Container for the necessary parameters to execute the ListEventSources service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListEventSourcesResponse>: The response from the ListEventSources service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.

See Also: REST API Reference for ListEventSources Operation

ListPartnerEventSourceAccountsAsync(ListPartnerEventSourceAccountsRequest, CancellationToken)

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.

Task<ListPartnerEventSourceAccountsResponse> ListPartnerEventSourceAccountsAsync(ListPartnerEventSourceAccountsRequest request, CancellationToken cancellationToken = default)

Parameters

request ListPartnerEventSourceAccountsRequest: Container for the necessary parameters to execute the ListPartnerEventSourceAccounts service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListPartnerEventSourceAccountsResponse>: The response from the ListPartnerEventSourceAccounts service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for ListPartnerEventSourceAccounts Operation

ListPartnerEventSourcesAsync(ListPartnerEventSourcesRequest, CancellationToken)

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.

Task<ListPartnerEventSourcesResponse> ListPartnerEventSourcesAsync(ListPartnerEventSourcesRequest request, CancellationToken cancellationToken = default)

Parameters

request ListPartnerEventSourcesRequest: Container for the necessary parameters to execute the ListPartnerEventSources service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListPartnerEventSourcesResponse>: The response from the ListPartnerEventSources service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.

See Also: REST API Reference for ListPartnerEventSources Operation

ListReplaysAsync(ListReplaysRequest, CancellationToken)

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.

Task<ListReplaysResponse> ListReplaysAsync(ListReplaysRequest request, CancellationToken cancellationToken = default)

Parameters

request ListReplaysRequest: Container for the necessary parameters to execute the ListReplays service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListReplaysResponse>: The response from the ListReplays service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.

See Also: REST API Reference for ListReplays Operation

ListRuleNamesByTargetAsync(ListRuleNamesByTargetRequest, CancellationToken)

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.

Task<ListRuleNamesByTargetResponse> ListRuleNamesByTargetAsync(ListRuleNamesByTargetRequest request, CancellationToken cancellationToken = default)

Parameters

request ListRuleNamesByTargetRequest: Container for the necessary parameters to execute the ListRuleNamesByTarget service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListRuleNamesByTargetResponse>: The response from the ListRuleNamesByTarget service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for ListRuleNamesByTarget Operation

ListRulesAsync(ListRulesRequest, CancellationToken)

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.

Task<ListRulesResponse> ListRulesAsync(ListRulesRequest request, CancellationToken cancellationToken = default)

Parameters

request ListRulesRequest: Container for the necessary parameters to execute the ListRules service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListRulesResponse>: The response from the ListRules service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for ListRules Operation

ListTagsForResourceAsync(ListTagsForResourceRequest, CancellationToken)

Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.

Task<ListTagsForResourceResponse> ListTagsForResourceAsync(ListTagsForResourceRequest request, CancellationToken cancellationToken = default)

Parameters

request ListTagsForResourceRequest: Container for the necessary parameters to execute the ListTagsForResource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListTagsForResourceResponse>: The response from the ListTagsForResource service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for ListTagsForResource Operation

ListTargetsByRuleAsync(ListTargetsByRuleRequest, CancellationToken)

Lists the targets assigned to the specified rule.

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

Task<ListTargetsByRuleResponse> ListTargetsByRuleAsync(ListTargetsByRuleRequest request, CancellationToken cancellationToken = default)

Parameters

request ListTargetsByRuleRequest: Container for the necessary parameters to execute the ListTargetsByRule service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<ListTargetsByRuleResponse>: The response from the ListTargetsByRule service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for ListTargetsByRule Operation

PutEventsAsync(PutEventsRequest, CancellationToken)

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.

Task<PutEventsResponse> PutEventsAsync(PutEventsRequest request, CancellationToken cancellationToken = default)

Parameters

request PutEventsRequest: Container for the necessary parameters to execute the PutEvents service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutEventsResponse>: The response from the PutEvents service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.

See Also: REST API Reference for PutEvents Operation

PutPartnerEventsAsync(PutPartnerEventsRequest, CancellationToken)

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.

Task<PutPartnerEventsResponse> PutPartnerEventsAsync(PutPartnerEventsRequest request, CancellationToken cancellationToken = default)

Parameters

request PutPartnerEventsRequest: Container for the necessary parameters to execute the PutPartnerEvents service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutPartnerEventsResponse>: The response from the PutPartnerEvents service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.

See Also: REST API Reference for PutPartnerEvents Operation

PutPermissionAsync(PutPermissionRequest, CancellationToken)

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.

Task<PutPermissionResponse> PutPermissionAsync(PutPermissionRequest request, CancellationToken cancellationToken = default)

Parameters

request PutPermissionRequest: Container for the necessary parameters to execute the PutPermission service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutPermissionResponse>: The response from the PutPermission service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.
PolicyLengthExceededException: The event bus policy is too long. For more information, see the limits.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for PutPermission Operation

PutRuleAsync(PutRuleRequest, CancellationToken)

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.

Task<PutRuleResponse> PutRuleAsync(PutRuleRequest request, CancellationToken cancellationToken = default)

Parameters

request PutRuleRequest: Container for the necessary parameters to execute the PutRule service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutRuleResponse>: The response from the PutRule service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
InvalidEventPatternException: The event pattern is not valid.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
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.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for PutRule Operation

PutTargetsAsync(PutTargetsRequest, CancellationToken)

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.

Task<PutTargetsResponse> PutTargetsAsync(PutTargetsRequest request, CancellationToken cancellationToken = default)

Parameters

request PutTargetsRequest: Container for the necessary parameters to execute the PutTargets service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<PutTargetsResponse>: The response from the PutTargets service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
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.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for PutTargets Operation

RemovePermissionAsync(RemovePermissionRequest, CancellationToken)

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.

Task<RemovePermissionResponse> RemovePermissionAsync(RemovePermissionRequest request, CancellationToken cancellationToken = default)

Parameters

request RemovePermissionRequest: Container for the necessary parameters to execute the RemovePermission service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<RemovePermissionResponse>: The response from the RemovePermission service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for RemovePermission Operation

RemoveTargetsAsync(RemoveTargetsRequest, CancellationToken)

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.

Task<RemoveTargetsResponse> RemoveTargetsAsync(RemoveTargetsRequest request, CancellationToken cancellationToken = default)

Parameters

request RemoveTargetsRequest: Container for the necessary parameters to execute the RemoveTargets service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<RemoveTargetsResponse>: The response from the RemoveTargets service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
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.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for RemoveTargets Operation

StartReplayAsync(StartReplayRequest, CancellationToken)

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.

Task<StartReplayResponse> StartReplayAsync(StartReplayRequest request, CancellationToken cancellationToken = default)

Parameters

request StartReplayRequest: Container for the necessary parameters to execute the StartReplay service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<StartReplayResponse>: The response from the StartReplay service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
InvalidEventPatternException: The event pattern is not valid.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
ResourceAlreadyExistsException: The resource you are trying to create already exists.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for StartReplay Operation

TagResourceAsync(TagResourceRequest, CancellationToken)

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.

Task<TagResourceResponse> TagResourceAsync(TagResourceRequest request, CancellationToken cancellationToken = default)

Parameters

request TagResourceRequest: Container for the necessary parameters to execute the TagResource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<TagResourceResponse>: The response from the TagResource service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
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.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for TagResource Operation

TestEventPatternAsync(TestEventPatternRequest, CancellationToken)

Tests whether the specified event pattern matches the provided event.

Task<TestEventPatternResponse> TestEventPatternAsync(TestEventPatternRequest request, CancellationToken cancellationToken = default)

Parameters

request TestEventPatternRequest: Container for the necessary parameters to execute the TestEventPattern service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<TestEventPatternResponse>: The response from the TestEventPattern service method, as returned by EventBridge.

Exceptions

InternalException: This exception occurs due to unexpected causes.
InvalidEventPatternException: The event pattern is not valid.

See Also: REST API Reference for TestEventPattern Operation

UntagResourceAsync(UntagResourceRequest, CancellationToken)

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.

Task<UntagResourceResponse> UntagResourceAsync(UntagResourceRequest request, CancellationToken cancellationToken = default)

Parameters

request UntagResourceRequest: Container for the necessary parameters to execute the UntagResource service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UntagResourceResponse>: The response from the UntagResource service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
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.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for UntagResource Operation

UpdateApiDestinationAsync(UpdateApiDestinationRequest, CancellationToken)

Updates an API destination.

Task<UpdateApiDestinationResponse> UpdateApiDestinationAsync(UpdateApiDestinationRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateApiDestinationRequest: Container for the necessary parameters to execute the UpdateApiDestination service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateApiDestinationResponse>: The response from the UpdateApiDestination service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for UpdateApiDestination Operation

UpdateArchiveAsync(UpdateArchiveRequest, CancellationToken)

Updates the specified archive.

Task<UpdateArchiveResponse> UpdateArchiveAsync(UpdateArchiveRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateArchiveRequest: Container for the necessary parameters to execute the UpdateArchive service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateArchiveResponse>: The response from the UpdateArchive service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
InvalidEventPatternException: The event pattern is not valid.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for UpdateArchive Operation

UpdateConnectionAsync(UpdateConnectionRequest, CancellationToken)

Updates settings for a connection.

Task<UpdateConnectionResponse> UpdateConnectionAsync(UpdateConnectionRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateConnectionRequest: Container for the necessary parameters to execute the UpdateConnection service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateConnectionResponse>: The response from the UpdateConnection service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
LimitExceededException: The request failed because it attempted to create resource beyond the allowed service quota.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for UpdateConnection Operation

UpdateEndpointAsync(UpdateEndpointRequest, CancellationToken)

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 .

Task<UpdateEndpointResponse> UpdateEndpointAsync(UpdateEndpointRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateEndpointRequest: Container for the necessary parameters to execute the UpdateEndpoint service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateEndpointResponse>: The response from the UpdateEndpoint service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for UpdateEndpoint Operation

UpdateEventBusAsync(UpdateEventBusRequest, CancellationToken)

Updates the specified event bus.

Task<UpdateEventBusResponse> UpdateEventBusAsync(UpdateEventBusRequest request, CancellationToken cancellationToken = default)

Parameters

request UpdateEventBusRequest: Container for the necessary parameters to execute the UpdateEventBus service method.
cancellationToken CancellationToken: A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Returns

Task<UpdateEventBusResponse>: The response from the UpdateEventBus service method, as returned by EventBridge.

Exceptions

ConcurrentModificationException: There is concurrent modification on a rule, target, archive, or replay.
InternalException: This exception occurs due to unexpected causes.
OperationDisabledException: The operation you are attempting is not available in this region.
ResourceNotFoundException: An entity that you specified does not exist.

See Also: REST API Reference for UpdateEventBus Operation

Table of Contents

Interface IAmazonEventBridge

Methods

ActivateEventSourceAsync(ActivateEventSourceRequest, CancellationToken)

Parameters

Returns

Exceptions

CancelReplayAsync(CancelReplayRequest, CancellationToken)

Parameters

Returns

Exceptions

CreateApiDestinationAsync(CreateApiDestinationRequest, CancellationToken)

Parameters

Returns

Exceptions

CreateArchiveAsync(CreateArchiveRequest, CancellationToken)

note

Parameters

Returns

Exceptions

CreateConnectionAsync(CreateConnectionRequest, CancellationToken)

Parameters

Returns

Exceptions

CreateEndpointAsync(CreateEndpointRequest, CancellationToken)

Parameters

Returns

Exceptions

CreateEventBusAsync(CreateEventBusRequest, CancellationToken)

Parameters

Returns

Exceptions

CreatePartnerEventSourceAsync(CreatePartnerEventSourceRequest, CancellationToken)

Parameters

Returns

Exceptions

DeactivateEventSourceAsync(DeactivateEventSourceRequest, CancellationToken)

Parameters

Returns

Exceptions

DeauthorizeConnectionAsync(DeauthorizeConnectionRequest, CancellationToken)

Parameters

Returns

Exceptions

DeleteApiDestinationAsync(DeleteApiDestinationRequest, CancellationToken)

Parameters

Returns

Exceptions

DeleteArchiveAsync(DeleteArchiveRequest, CancellationToken)

Parameters

Returns

Exceptions

DeleteConnectionAsync(DeleteConnectionRequest, CancellationToken)

Parameters

Returns

Exceptions

DeleteEndpointAsync(DeleteEndpointRequest, CancellationToken)

Parameters

Returns

Exceptions

DeleteEventBusAsync(DeleteEventBusRequest, CancellationToken)

Parameters

Returns

Exceptions

DeletePartnerEventSourceAsync(DeletePartnerEventSourceRequest, CancellationToken)

Parameters

Returns

Exceptions

DeleteRuleAsync(DeleteRuleRequest, CancellationToken)

Parameters

Returns

Exceptions

DescribeApiDestinationAsync(DescribeApiDestinationRequest, CancellationToken)

Parameters

Returns

Exceptions

DescribeArchiveAsync(DescribeArchiveRequest, CancellationToken)

Parameters

Returns

Exceptions