@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCloudWatchEventsAsync extends AbstractAmazonCloudWatchEvents implements AmazonCloudWatchEventsAsync
AmazonCloudWatchEventsAsync. Convenient method forms pass through to the
corresponding overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIXactivateEventSource, cancelReplay, createApiDestination, createArchive, createConnection, createEventBus, createPartnerEventSource, deactivateEventSource, deauthorizeConnection, deleteApiDestination, deleteArchive, deleteConnection, deleteEventBus, deletePartnerEventSource, deleteRule, describeApiDestination, describeArchive, describeConnection, describeEventBus, describeEventSource, describePartnerEventSource, describeReplay, describeRule, disableRule, enableRule, getCachedResponseMetadata, listApiDestinations, listArchives, listConnections, listEventBuses, listEventSources, listPartnerEventSourceAccounts, listPartnerEventSources, listReplays, listRuleNamesByTarget, listRules, listTagsForResource, listTargetsByRule, putEvents, putPartnerEvents, putPermission, putRule, putTargets, removePermission, removeTargets, setEndpoint, setRegion, shutdown, startReplay, tagResource, testEventPattern, untagResource, updateApiDestination, updateArchive, updateConnectionequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitactivateEventSource, cancelReplay, createApiDestination, createArchive, createConnection, createEventBus, createPartnerEventSource, deactivateEventSource, deauthorizeConnection, deleteApiDestination, deleteArchive, deleteConnection, deleteEventBus, deletePartnerEventSource, deleteRule, describeApiDestination, describeArchive, describeConnection, describeEventBus, describeEventSource, describePartnerEventSource, describeReplay, describeRule, disableRule, enableRule, getCachedResponseMetadata, listApiDestinations, listArchives, listConnections, listEventBuses, listEventSources, listPartnerEventSourceAccounts, listPartnerEventSources, listReplays, listRuleNamesByTarget, listRules, listTagsForResource, listTargetsByRule, putEvents, putPartnerEvents, putPermission, putRule, putTargets, removePermission, removeTargets, setEndpoint, setRegion, shutdown, startReplay, tagResource, testEventPattern, untagResource, updateApiDestination, updateArchive, updateConnectionpublic Future<ActivateEventSourceResult> activateEventSourceAsync(ActivateEventSourceRequest request)
AmazonCloudWatchEventsAsyncActivates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
activateEventSourceAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ActivateEventSourceResult> activateEventSourceAsync(ActivateEventSourceRequest request, AsyncHandler<ActivateEventSourceRequest,ActivateEventSourceResult> asyncHandler)
AmazonCloudWatchEventsAsyncActivates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
activateEventSourceAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CancelReplayResult> cancelReplayAsync(CancelReplayRequest request)
AmazonCloudWatchEventsAsyncCancels the specified replay.
cancelReplayAsync in interface AmazonCloudWatchEventsAsyncpublic Future<CancelReplayResult> cancelReplayAsync(CancelReplayRequest request, AsyncHandler<CancelReplayRequest,CancelReplayResult> asyncHandler)
AmazonCloudWatchEventsAsyncCancels the specified replay.
cancelReplayAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateApiDestinationResult> createApiDestinationAsync(CreateApiDestinationRequest request)
AmazonCloudWatchEventsAsyncCreates an API destination, which is an HTTP invocation endpoint configured as a target for events.
createApiDestinationAsync in interface AmazonCloudWatchEventsAsyncpublic Future<CreateApiDestinationResult> createApiDestinationAsync(CreateApiDestinationRequest request, AsyncHandler<CreateApiDestinationRequest,CreateApiDestinationResult> asyncHandler)
AmazonCloudWatchEventsAsyncCreates an API destination, which is an HTTP invocation endpoint configured as a target for events.
createApiDestinationAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateArchiveResult> createArchiveAsync(CreateArchiveRequest request)
AmazonCloudWatchEventsAsyncCreates 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.
createArchiveAsync in interface AmazonCloudWatchEventsAsyncpublic Future<CreateArchiveResult> createArchiveAsync(CreateArchiveRequest request, AsyncHandler<CreateArchiveRequest,CreateArchiveResult> asyncHandler)
AmazonCloudWatchEventsAsyncCreates 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.
createArchiveAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateConnectionResult> createConnectionAsync(CreateConnectionRequest request)
AmazonCloudWatchEventsAsyncCreates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
createConnectionAsync in interface AmazonCloudWatchEventsAsyncpublic Future<CreateConnectionResult> createConnectionAsync(CreateConnectionRequest request, AsyncHandler<CreateConnectionRequest,CreateConnectionResult> asyncHandler)
AmazonCloudWatchEventsAsyncCreates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
createConnectionAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateEventBusResult> createEventBusAsync(CreateEventBusRequest request)
AmazonCloudWatchEventsAsyncCreates 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.
createEventBusAsync in interface AmazonCloudWatchEventsAsyncpublic Future<CreateEventBusResult> createEventBusAsync(CreateEventBusRequest request, AsyncHandler<CreateEventBusRequest,CreateEventBusResult> asyncHandler)
AmazonCloudWatchEventsAsyncCreates 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.
createEventBusAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreatePartnerEventSourceResult> createPartnerEventSourceAsync(CreatePartnerEventSourceRequest request)
AmazonCloudWatchEventsAsyncCalled 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 combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.
createPartnerEventSourceAsync in interface AmazonCloudWatchEventsAsyncpublic Future<CreatePartnerEventSourceResult> createPartnerEventSourceAsync(CreatePartnerEventSourceRequest request, AsyncHandler<CreatePartnerEventSourceRequest,CreatePartnerEventSourceResult> asyncHandler)
AmazonCloudWatchEventsAsyncCalled 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 combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.
createPartnerEventSourceAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeactivateEventSourceResult> deactivateEventSourceAsync(DeactivateEventSourceRequest request)
AmazonCloudWatchEventsAsyncYou 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.
deactivateEventSourceAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DeactivateEventSourceResult> deactivateEventSourceAsync(DeactivateEventSourceRequest request, AsyncHandler<DeactivateEventSourceRequest,DeactivateEventSourceResult> asyncHandler)
AmazonCloudWatchEventsAsyncYou 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.
deactivateEventSourceAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeauthorizeConnectionResult> deauthorizeConnectionAsync(DeauthorizeConnectionRequest request)
AmazonCloudWatchEventsAsyncRemoves 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.
deauthorizeConnectionAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DeauthorizeConnectionResult> deauthorizeConnectionAsync(DeauthorizeConnectionRequest request, AsyncHandler<DeauthorizeConnectionRequest,DeauthorizeConnectionResult> asyncHandler)
AmazonCloudWatchEventsAsyncRemoves 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.
deauthorizeConnectionAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteApiDestinationResult> deleteApiDestinationAsync(DeleteApiDestinationRequest request)
AmazonCloudWatchEventsAsyncDeletes the specified API destination.
deleteApiDestinationAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DeleteApiDestinationResult> deleteApiDestinationAsync(DeleteApiDestinationRequest request, AsyncHandler<DeleteApiDestinationRequest,DeleteApiDestinationResult> asyncHandler)
AmazonCloudWatchEventsAsyncDeletes the specified API destination.
deleteApiDestinationAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteArchiveResult> deleteArchiveAsync(DeleteArchiveRequest request)
AmazonCloudWatchEventsAsyncDeletes the specified archive.
deleteArchiveAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DeleteArchiveResult> deleteArchiveAsync(DeleteArchiveRequest request, AsyncHandler<DeleteArchiveRequest,DeleteArchiveResult> asyncHandler)
AmazonCloudWatchEventsAsyncDeletes the specified archive.
deleteArchiveAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteConnectionResult> deleteConnectionAsync(DeleteConnectionRequest request)
AmazonCloudWatchEventsAsyncDeletes a connection.
deleteConnectionAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DeleteConnectionResult> deleteConnectionAsync(DeleteConnectionRequest request, AsyncHandler<DeleteConnectionRequest,DeleteConnectionResult> asyncHandler)
AmazonCloudWatchEventsAsyncDeletes a connection.
deleteConnectionAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteEventBusResult> deleteEventBusAsync(DeleteEventBusRequest request)
AmazonCloudWatchEventsAsyncDeletes 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.
deleteEventBusAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DeleteEventBusResult> deleteEventBusAsync(DeleteEventBusRequest request, AsyncHandler<DeleteEventBusRequest,DeleteEventBusResult> asyncHandler)
AmazonCloudWatchEventsAsyncDeletes 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.
deleteEventBusAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeletePartnerEventSourceResult> deletePartnerEventSourceAsync(DeletePartnerEventSourceRequest request)
AmazonCloudWatchEventsAsyncThis 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.
deletePartnerEventSourceAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DeletePartnerEventSourceResult> deletePartnerEventSourceAsync(DeletePartnerEventSourceRequest request, AsyncHandler<DeletePartnerEventSourceRequest,DeletePartnerEventSourceResult> asyncHandler)
AmazonCloudWatchEventsAsyncThis 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.
deletePartnerEventSourceAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request)
AmazonCloudWatchEventsAsyncDeletes 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.
deleteRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request, AsyncHandler<DeleteRuleRequest,DeleteRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncDeletes 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.
deleteRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeApiDestinationResult> describeApiDestinationAsync(DescribeApiDestinationRequest request)
AmazonCloudWatchEventsAsyncRetrieves details about an API destination.
describeApiDestinationAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribeApiDestinationResult> describeApiDestinationAsync(DescribeApiDestinationRequest request, AsyncHandler<DescribeApiDestinationRequest,DescribeApiDestinationResult> asyncHandler)
AmazonCloudWatchEventsAsyncRetrieves details about an API destination.
describeApiDestinationAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeArchiveResult> describeArchiveAsync(DescribeArchiveRequest request)
AmazonCloudWatchEventsAsyncRetrieves details about an archive.
describeArchiveAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribeArchiveResult> describeArchiveAsync(DescribeArchiveRequest request, AsyncHandler<DescribeArchiveRequest,DescribeArchiveResult> asyncHandler)
AmazonCloudWatchEventsAsyncRetrieves details about an archive.
describeArchiveAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeConnectionResult> describeConnectionAsync(DescribeConnectionRequest request)
AmazonCloudWatchEventsAsyncRetrieves details about a connection.
describeConnectionAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribeConnectionResult> describeConnectionAsync(DescribeConnectionRequest request, AsyncHandler<DescribeConnectionRequest,DescribeConnectionResult> asyncHandler)
AmazonCloudWatchEventsAsyncRetrieves details about a connection.
describeConnectionAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEventBusResult> describeEventBusAsync(DescribeEventBusRequest request)
AmazonCloudWatchEventsAsyncDisplays 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.
describeEventBusAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribeEventBusResult> describeEventBusAsync(DescribeEventBusRequest request, AsyncHandler<DescribeEventBusRequest,DescribeEventBusResult> asyncHandler)
AmazonCloudWatchEventsAsyncDisplays 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.
describeEventBusAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEventSourceResult> describeEventSourceAsync(DescribeEventSourceRequest request)
AmazonCloudWatchEventsAsyncThis operation lists details about a partner event source that is shared with your account.
describeEventSourceAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribeEventSourceResult> describeEventSourceAsync(DescribeEventSourceRequest request, AsyncHandler<DescribeEventSourceRequest,DescribeEventSourceResult> asyncHandler)
AmazonCloudWatchEventsAsyncThis operation lists details about a partner event source that is shared with your account.
describeEventSourceAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePartnerEventSourceResult> describePartnerEventSourceAsync(DescribePartnerEventSourceRequest request)
AmazonCloudWatchEventsAsyncAn 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.
describePartnerEventSourceAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribePartnerEventSourceResult> describePartnerEventSourceAsync(DescribePartnerEventSourceRequest request, AsyncHandler<DescribePartnerEventSourceRequest,DescribePartnerEventSourceResult> asyncHandler)
AmazonCloudWatchEventsAsyncAn 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.
describePartnerEventSourceAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeReplayResult> describeReplayAsync(DescribeReplayRequest request)
AmazonCloudWatchEventsAsync
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.
describeReplayAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribeReplayResult> describeReplayAsync(DescribeReplayRequest request, AsyncHandler<DescribeReplayRequest,DescribeReplayResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
describeReplayAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest request)
AmazonCloudWatchEventsAsyncDescribes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
describeRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest request, AsyncHandler<DescribeRuleRequest,DescribeRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncDescribes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
describeRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisableRuleResult> disableRuleAsync(DisableRuleRequest request)
AmazonCloudWatchEventsAsyncDisables 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.
disableRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DisableRuleResult> disableRuleAsync(DisableRuleRequest request, AsyncHandler<DisableRuleRequest,DisableRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncDisables 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.
disableRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EnableRuleResult> enableRuleAsync(EnableRuleRequest request)
AmazonCloudWatchEventsAsyncEnables 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.
enableRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<EnableRuleResult> enableRuleAsync(EnableRuleRequest request, AsyncHandler<EnableRuleRequest,EnableRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncEnables 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.
enableRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListApiDestinationsResult> listApiDestinationsAsync(ListApiDestinationsRequest request)
AmazonCloudWatchEventsAsyncRetrieves a list of API destination in the account in the current Region.
listApiDestinationsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListApiDestinationsResult> listApiDestinationsAsync(ListApiDestinationsRequest request, AsyncHandler<ListApiDestinationsRequest,ListApiDestinationsResult> asyncHandler)
AmazonCloudWatchEventsAsyncRetrieves a list of API destination in the account in the current Region.
listApiDestinationsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListArchivesResult> listArchivesAsync(ListArchivesRequest request)
AmazonCloudWatchEventsAsyncLists 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.
listArchivesAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListArchivesResult> listArchivesAsync(ListArchivesRequest request, AsyncHandler<ListArchivesRequest,ListArchivesResult> asyncHandler)
AmazonCloudWatchEventsAsyncLists 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.
listArchivesAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListConnectionsResult> listConnectionsAsync(ListConnectionsRequest request)
AmazonCloudWatchEventsAsyncRetrieves a list of connections from the account.
listConnectionsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListConnectionsResult> listConnectionsAsync(ListConnectionsRequest request, AsyncHandler<ListConnectionsRequest,ListConnectionsResult> asyncHandler)
AmazonCloudWatchEventsAsyncRetrieves a list of connections from the account.
listConnectionsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEventBusesResult> listEventBusesAsync(ListEventBusesRequest request)
AmazonCloudWatchEventsAsyncLists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
listEventBusesAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListEventBusesResult> listEventBusesAsync(ListEventBusesRequest request, AsyncHandler<ListEventBusesRequest,ListEventBusesResult> asyncHandler)
AmazonCloudWatchEventsAsyncLists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
listEventBusesAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListEventSourcesResult> listEventSourcesAsync(ListEventSourcesRequest request)
AmazonCloudWatchEventsAsyncYou 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.
listEventSourcesAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListEventSourcesResult> listEventSourcesAsync(ListEventSourcesRequest request, AsyncHandler<ListEventSourcesRequest,ListEventSourcesResult> asyncHandler)
AmazonCloudWatchEventsAsyncYou 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.
listEventSourcesAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPartnerEventSourceAccountsResult> listPartnerEventSourceAccountsAsync(ListPartnerEventSourceAccountsRequest request)
AmazonCloudWatchEventsAsyncAn 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.
listPartnerEventSourceAccountsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListPartnerEventSourceAccountsResult> listPartnerEventSourceAccountsAsync(ListPartnerEventSourceAccountsRequest request, AsyncHandler<ListPartnerEventSourceAccountsRequest,ListPartnerEventSourceAccountsResult> asyncHandler)
AmazonCloudWatchEventsAsyncAn 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.
listPartnerEventSourceAccountsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListPartnerEventSourcesResult> listPartnerEventSourcesAsync(ListPartnerEventSourcesRequest request)
AmazonCloudWatchEventsAsyncAn 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.
listPartnerEventSourcesAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListPartnerEventSourcesResult> listPartnerEventSourcesAsync(ListPartnerEventSourcesRequest request, AsyncHandler<ListPartnerEventSourcesRequest,ListPartnerEventSourcesResult> asyncHandler)
AmazonCloudWatchEventsAsyncAn 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.
listPartnerEventSourcesAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListReplaysResult> listReplaysAsync(ListReplaysRequest request)
AmazonCloudWatchEventsAsyncLists 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.
listReplaysAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListReplaysResult> listReplaysAsync(ListReplaysRequest request, AsyncHandler<ListReplaysRequest,ListReplaysResult> asyncHandler)
AmazonCloudWatchEventsAsyncLists 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.
listReplaysAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRuleNamesByTargetResult> listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest request)
AmazonCloudWatchEventsAsyncLists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.
listRuleNamesByTargetAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListRuleNamesByTargetResult> listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest request, AsyncHandler<ListRuleNamesByTargetRequest,ListRuleNamesByTargetResult> asyncHandler)
AmazonCloudWatchEventsAsyncLists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.
listRuleNamesByTargetAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRulesResult> listRulesAsync(ListRulesRequest request)
AmazonCloudWatchEventsAsyncLists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
listRulesAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListRulesResult> listRulesAsync(ListRulesRequest request, AsyncHandler<ListRulesRequest,ListRulesResult> asyncHandler)
AmazonCloudWatchEventsAsyncLists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
listRulesAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonCloudWatchEventsAsyncDisplays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
listTagsForResourceAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonCloudWatchEventsAsyncDisplays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
listTagsForResourceAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTargetsByRuleResult> listTargetsByRuleAsync(ListTargetsByRuleRequest request)
AmazonCloudWatchEventsAsyncLists the targets assigned to the specified rule.
listTargetsByRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListTargetsByRuleResult> listTargetsByRuleAsync(ListTargetsByRuleRequest request, AsyncHandler<ListTargetsByRuleRequest,ListTargetsByRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncLists the targets assigned to the specified rule.
listTargetsByRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutEventsResult> putEventsAsync(PutEventsRequest request)
AmazonCloudWatchEventsAsyncSends custom events to Amazon EventBridge so that they can be matched to rules.
putEventsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<PutEventsResult> putEventsAsync(PutEventsRequest request, AsyncHandler<PutEventsRequest,PutEventsResult> asyncHandler)
AmazonCloudWatchEventsAsyncSends custom events to Amazon EventBridge so that they can be matched to rules.
putEventsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutPartnerEventsResult> putPartnerEventsAsync(PutPartnerEventsRequest request)
AmazonCloudWatchEventsAsyncThis is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
putPartnerEventsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<PutPartnerEventsResult> putPartnerEventsAsync(PutPartnerEventsRequest request, AsyncHandler<PutPartnerEventsRequest,PutPartnerEventsResult> asyncHandler)
AmazonCloudWatchEventsAsyncThis is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
putPartnerEventsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutPermissionResult> putPermissionAsync(PutPermissionRequest request)
AmazonCloudWatchEventsAsync
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.
putPermissionAsync in interface AmazonCloudWatchEventsAsyncpublic Future<PutPermissionResult> putPermissionAsync(PutPermissionRequest request, AsyncHandler<PutPermissionRequest,PutPermissionResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
putPermissionAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutRuleResult> putRuleAsync(PutRuleRequest request)
AmazonCloudWatchEventsAsyncCreates 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.
putRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<PutRuleResult> putRuleAsync(PutRuleRequest request, AsyncHandler<PutRuleRequest,PutRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncCreates 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.
putRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutTargetsResult> putTargetsAsync(PutTargetsRequest request)
AmazonCloudWatchEventsAsyncAdds 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.
You can configure the following as targets for Events:
Amazon API Gateway REST API endpoints
API Gateway
Batch job queue
CloudWatch Logs group
CodeBuild project
CodePipeline
Amazon EC2 CreateSnapshot API call
Amazon EC2 RebootInstances API call
Amazon EC2 StopInstances API call
Amazon EC2 TerminateInstances API call
Amazon ECS tasks
Event bus in a different Amazon Web Services account or Region.
You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.
Firehose delivery stream (Kinesis Data Firehose)
Inspector assessment template (Amazon Inspector)
Kinesis stream (Kinesis Data Stream)
Lambda function
Redshift clusters (Data API statement execution)
Amazon SNS topic
Amazon SQS queues (includes FIFO queues
SSM Automation
SSM OpsItem
SSM Run Command
Step Functions state machines
Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call,
EC2 StopInstances API call, and 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 REST 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.
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.
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.
putTargetsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<PutTargetsResult> putTargetsAsync(PutTargetsRequest request, AsyncHandler<PutTargetsRequest,PutTargetsResult> asyncHandler)
AmazonCloudWatchEventsAsyncAdds 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.
You can configure the following as targets for Events:
Amazon API Gateway REST API endpoints
API Gateway
Batch job queue
CloudWatch Logs group
CodeBuild project
CodePipeline
Amazon EC2 CreateSnapshot API call
Amazon EC2 RebootInstances API call
Amazon EC2 StopInstances API call
Amazon EC2 TerminateInstances API call
Amazon ECS tasks
Event bus in a different Amazon Web Services account or Region.
You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.
Firehose delivery stream (Kinesis Data Firehose)
Inspector assessment template (Amazon Inspector)
Kinesis stream (Kinesis Data Stream)
Lambda function
Redshift clusters (Data API statement execution)
Amazon SNS topic
Amazon SQS queues (includes FIFO queues
SSM Automation
SSM OpsItem
SSM Run Command
Step Functions state machines
Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The
built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call,
EC2 StopInstances API call, and 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 REST 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.
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.
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.
putTargetsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest request)
AmazonCloudWatchEventsAsync
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
.
removePermissionAsync in interface AmazonCloudWatchEventsAsyncpublic Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest request, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
AmazonCloudWatchEventsAsync
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
.
removePermissionAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemoveTargetsResult> removeTargetsAsync(RemoveTargetsRequest request)
AmazonCloudWatchEventsAsyncRemoves the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
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.
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.
removeTargetsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<RemoveTargetsResult> removeTargetsAsync(RemoveTargetsRequest request, AsyncHandler<RemoveTargetsRequest,RemoveTargetsResult> asyncHandler)
AmazonCloudWatchEventsAsyncRemoves the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
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.
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.
removeTargetsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<StartReplayResult> startReplayAsync(StartReplayRequest request)
AmazonCloudWatchEventsAsync
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.
startReplayAsync in interface AmazonCloudWatchEventsAsyncpublic Future<StartReplayResult> startReplayAsync(StartReplayRequest request, AsyncHandler<StartReplayRequest,StartReplayResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
startReplayAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TagResourceResult> tagResourceAsync(TagResourceRequest request)
AmazonCloudWatchEventsAsyncAssigns 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.
tagResourceAsync in interface AmazonCloudWatchEventsAsyncpublic Future<TagResourceResult> tagResourceAsync(TagResourceRequest request, AsyncHandler<TagResourceRequest,TagResourceResult> asyncHandler)
AmazonCloudWatchEventsAsyncAssigns 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.
tagResourceAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TestEventPatternResult> testEventPatternAsync(TestEventPatternRequest request)
AmazonCloudWatchEventsAsyncTests whether the specified event pattern matches the provided event.
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.
testEventPatternAsync in interface AmazonCloudWatchEventsAsyncpublic Future<TestEventPatternResult> testEventPatternAsync(TestEventPatternRequest request, AsyncHandler<TestEventPatternRequest,TestEventPatternResult> asyncHandler)
AmazonCloudWatchEventsAsyncTests whether the specified event pattern matches the provided event.
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.
testEventPatternAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request)
AmazonCloudWatchEventsAsyncRemoves one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.
untagResourceAsync in interface AmazonCloudWatchEventsAsyncpublic Future<UntagResourceResult> untagResourceAsync(UntagResourceRequest request, AsyncHandler<UntagResourceRequest,UntagResourceResult> asyncHandler)
AmazonCloudWatchEventsAsyncRemoves one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.
untagResourceAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateApiDestinationResult> updateApiDestinationAsync(UpdateApiDestinationRequest request)
AmazonCloudWatchEventsAsyncUpdates an API destination.
updateApiDestinationAsync in interface AmazonCloudWatchEventsAsyncpublic Future<UpdateApiDestinationResult> updateApiDestinationAsync(UpdateApiDestinationRequest request, AsyncHandler<UpdateApiDestinationRequest,UpdateApiDestinationResult> asyncHandler)
AmazonCloudWatchEventsAsyncUpdates an API destination.
updateApiDestinationAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateArchiveResult> updateArchiveAsync(UpdateArchiveRequest request)
AmazonCloudWatchEventsAsyncUpdates the specified archive.
updateArchiveAsync in interface AmazonCloudWatchEventsAsyncpublic Future<UpdateArchiveResult> updateArchiveAsync(UpdateArchiveRequest request, AsyncHandler<UpdateArchiveRequest,UpdateArchiveResult> asyncHandler)
AmazonCloudWatchEventsAsyncUpdates the specified archive.
updateArchiveAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<UpdateConnectionResult> updateConnectionAsync(UpdateConnectionRequest request)
AmazonCloudWatchEventsAsyncUpdates settings for a connection.
updateConnectionAsync in interface AmazonCloudWatchEventsAsyncpublic Future<UpdateConnectionResult> updateConnectionAsync(UpdateConnectionRequest request, AsyncHandler<UpdateConnectionRequest,UpdateConnectionResult> asyncHandler)
AmazonCloudWatchEventsAsyncUpdates settings for a connection.
updateConnectionAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.