@Generated(value="software.amazon.awssdk:codegen") public interface CloudWatchEventsAsyncClient extends SdkClient
builder() method.
Amazon EventBridge helps you to respond to state changes in your AWS resources. When your resources change state, they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:
Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
Direct specific API records from AWS CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.
Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.
For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<ActivateEventSourceResponse> |
activateEventSource(ActivateEventSourceRequest activateEventSourceRequest)
Activates a partner event source that has been deactivated.
|
default CompletableFuture<ActivateEventSourceResponse> |
activateEventSource(Consumer<ActivateEventSourceRequest.Builder> activateEventSourceRequest)
Activates a partner event source that has been deactivated.
|
static CloudWatchEventsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudWatchEventsAsyncClient. |
default CompletableFuture<CancelReplayResponse> |
cancelReplay(CancelReplayRequest cancelReplayRequest)
Cancels the specified replay.
|
default CompletableFuture<CancelReplayResponse> |
cancelReplay(Consumer<CancelReplayRequest.Builder> cancelReplayRequest)
Cancels the specified replay.
|
static CloudWatchEventsAsyncClient |
create()
Create a
CloudWatchEventsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<CreateArchiveResponse> |
createArchive(Consumer<CreateArchiveRequest.Builder> createArchiveRequest)
Creates an archive of events with the specified settings.
|
default CompletableFuture<CreateArchiveResponse> |
createArchive(CreateArchiveRequest createArchiveRequest)
Creates an archive of events with the specified settings.
|
default CompletableFuture<CreateEventBusResponse> |
createEventBus(Consumer<CreateEventBusRequest.Builder> createEventBusRequest)
Creates a new event bus within your account.
|
default CompletableFuture<CreateEventBusResponse> |
createEventBus(CreateEventBusRequest createEventBusRequest)
Creates a new event bus within your account.
|
default CompletableFuture<CreatePartnerEventSourceResponse> |
createPartnerEventSource(Consumer<CreatePartnerEventSourceRequest.Builder> createPartnerEventSourceRequest)
Called by an SaaS partner to create a partner event source.
|
default CompletableFuture<CreatePartnerEventSourceResponse> |
createPartnerEventSource(CreatePartnerEventSourceRequest createPartnerEventSourceRequest)
Called by an SaaS partner to create a partner event source.
|
default CompletableFuture<DeactivateEventSourceResponse> |
deactivateEventSource(Consumer<DeactivateEventSourceRequest.Builder> deactivateEventSourceRequest)
You can use this operation to temporarily stop receiving events from the specified partner event source.
|
default CompletableFuture<DeactivateEventSourceResponse> |
deactivateEventSource(DeactivateEventSourceRequest deactivateEventSourceRequest)
You can use this operation to temporarily stop receiving events from the specified partner event source.
|
default CompletableFuture<DeleteArchiveResponse> |
deleteArchive(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest)
Deletes the specified archive.
|
default CompletableFuture<DeleteArchiveResponse> |
deleteArchive(DeleteArchiveRequest deleteArchiveRequest)
Deletes the specified archive.
|
default CompletableFuture<DeleteEventBusResponse> |
deleteEventBus(Consumer<DeleteEventBusRequest.Builder> deleteEventBusRequest)
Deletes the specified custom event bus or partner event bus.
|
default CompletableFuture<DeleteEventBusResponse> |
deleteEventBus(DeleteEventBusRequest deleteEventBusRequest)
Deletes the specified custom event bus or partner event bus.
|
default CompletableFuture<DeletePartnerEventSourceResponse> |
deletePartnerEventSource(Consumer<DeletePartnerEventSourceRequest.Builder> deletePartnerEventSourceRequest)
This operation is used by SaaS partners to delete a partner event source.
|
default CompletableFuture<DeletePartnerEventSourceResponse> |
deletePartnerEventSource(DeletePartnerEventSourceRequest deletePartnerEventSourceRequest)
This operation is used by SaaS partners to delete a partner event source.
|
default CompletableFuture<DeleteRuleResponse> |
deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
Deletes the specified rule.
|
default CompletableFuture<DeleteRuleResponse> |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the specified rule.
|
default CompletableFuture<DescribeArchiveResponse> |
describeArchive(Consumer<DescribeArchiveRequest.Builder> describeArchiveRequest)
Retrieves details about an archive.
|
default CompletableFuture<DescribeArchiveResponse> |
describeArchive(DescribeArchiveRequest describeArchiveRequest)
Retrieves details about an archive.
|
default CompletableFuture<DescribeEventBusResponse> |
describeEventBus()
Displays details about an event bus in your account.
|
default CompletableFuture<DescribeEventBusResponse> |
describeEventBus(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest)
Displays details about an event bus in your account.
|
default CompletableFuture<DescribeEventBusResponse> |
describeEventBus(DescribeEventBusRequest describeEventBusRequest)
Displays details about an event bus in your account.
|
default CompletableFuture<DescribeEventSourceResponse> |
describeEventSource(Consumer<DescribeEventSourceRequest.Builder> describeEventSourceRequest)
This operation lists details about a partner event source that is shared with your account.
|
default CompletableFuture<DescribeEventSourceResponse> |
describeEventSource(DescribeEventSourceRequest describeEventSourceRequest)
This operation lists details about a partner event source that is shared with your account.
|
default CompletableFuture<DescribePartnerEventSourceResponse> |
describePartnerEventSource(Consumer<DescribePartnerEventSourceRequest.Builder> describePartnerEventSourceRequest)
An SaaS partner can use this operation to list details about a partner event source that they have created.
|
default CompletableFuture<DescribePartnerEventSourceResponse> |
describePartnerEventSource(DescribePartnerEventSourceRequest describePartnerEventSourceRequest)
An SaaS partner can use this operation to list details about a partner event source that they have created.
|
default CompletableFuture<DescribeReplayResponse> |
describeReplay(Consumer<DescribeReplayRequest.Builder> describeReplayRequest)
Retrieves details about a replay.
|
default CompletableFuture<DescribeReplayResponse> |
describeReplay(DescribeReplayRequest describeReplayRequest)
Retrieves details about a replay.
|
default CompletableFuture<DescribeRuleResponse> |
describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest)
Describes the specified rule.
|
default CompletableFuture<DescribeRuleResponse> |
describeRule(DescribeRuleRequest describeRuleRequest)
Describes the specified rule.
|
default CompletableFuture<DisableRuleResponse> |
disableRule(Consumer<DisableRuleRequest.Builder> disableRuleRequest)
Disables the specified rule.
|
default CompletableFuture<DisableRuleResponse> |
disableRule(DisableRuleRequest disableRuleRequest)
Disables the specified rule.
|
default CompletableFuture<EnableRuleResponse> |
enableRule(Consumer<EnableRuleRequest.Builder> enableRuleRequest)
Enables the specified rule.
|
default CompletableFuture<EnableRuleResponse> |
enableRule(EnableRuleRequest enableRuleRequest)
Enables the specified rule.
|
default CompletableFuture<ListArchivesResponse> |
listArchives(Consumer<ListArchivesRequest.Builder> listArchivesRequest)
Lists your archives.
|
default CompletableFuture<ListArchivesResponse> |
listArchives(ListArchivesRequest listArchivesRequest)
Lists your archives.
|
default CompletableFuture<ListEventBusesResponse> |
listEventBuses(Consumer<ListEventBusesRequest.Builder> listEventBusesRequest)
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event
buses.
|
default CompletableFuture<ListEventBusesResponse> |
listEventBuses(ListEventBusesRequest listEventBusesRequest)
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event
buses.
|
default CompletableFuture<ListEventSourcesResponse> |
listEventSources(Consumer<ListEventSourcesRequest.Builder> listEventSourcesRequest)
You can use this to see all the partner event sources that have been shared with your AWS account.
|
default CompletableFuture<ListEventSourcesResponse> |
listEventSources(ListEventSourcesRequest listEventSourcesRequest)
You can use this to see all the partner event sources that have been shared with your AWS account.
|
default CompletableFuture<ListPartnerEventSourceAccountsResponse> |
listPartnerEventSourceAccounts(Consumer<ListPartnerEventSourceAccountsRequest.Builder> listPartnerEventSourceAccountsRequest)
An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name
is associated with.
|
default CompletableFuture<ListPartnerEventSourceAccountsResponse> |
listPartnerEventSourceAccounts(ListPartnerEventSourceAccountsRequest listPartnerEventSourceAccountsRequest)
An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name
is associated with.
|
default CompletableFuture<ListPartnerEventSourcesResponse> |
listPartnerEventSources(Consumer<ListPartnerEventSourcesRequest.Builder> listPartnerEventSourcesRequest)
An SaaS partner can use this operation to list all the partner event source names that they have created.
|
default CompletableFuture<ListPartnerEventSourcesResponse> |
listPartnerEventSources(ListPartnerEventSourcesRequest listPartnerEventSourcesRequest)
An SaaS partner can use this operation to list all the partner event source names that they have created.
|
default CompletableFuture<ListReplaysResponse> |
listReplays(Consumer<ListReplaysRequest.Builder> listReplaysRequest)
Lists your replays.
|
default CompletableFuture<ListReplaysResponse> |
listReplays(ListReplaysRequest listReplaysRequest)
Lists your replays.
|
default CompletableFuture<ListRuleNamesByTargetResponse> |
listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> listRuleNamesByTargetRequest)
Lists the rules for the specified target.
|
default CompletableFuture<ListRuleNamesByTargetResponse> |
listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)
Lists the rules for the specified target.
|
default CompletableFuture<ListRulesResponse> |
listRules()
Lists your Amazon EventBridge rules.
|
default CompletableFuture<ListRulesResponse> |
listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)
Lists your Amazon EventBridge rules.
|
default CompletableFuture<ListRulesResponse> |
listRules(ListRulesRequest listRulesRequest)
Lists your Amazon EventBridge rules.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with an EventBridge resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an EventBridge resource.
|
default CompletableFuture<ListTargetsByRuleResponse> |
listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
|
default CompletableFuture<ListTargetsByRuleResponse> |
listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
|
default CompletableFuture<PutEventsResponse> |
putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)
Sends custom events to Amazon EventBridge so that they can be matched to rules.
|
default CompletableFuture<PutEventsResponse> |
putEvents(PutEventsRequest putEventsRequest)
Sends custom events to Amazon EventBridge so that they can be matched to rules.
|
default CompletableFuture<PutPartnerEventsResponse> |
putPartnerEvents(Consumer<PutPartnerEventsRequest.Builder> putPartnerEventsRequest)
This is used by SaaS partners to write events to a customer's partner event bus.
|
default CompletableFuture<PutPartnerEventsResponse> |
putPartnerEvents(PutPartnerEventsRequest putPartnerEventsRequest)
This is used by SaaS partners to write events to a customer's partner event bus.
|
default CompletableFuture<PutPermissionResponse> |
putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest)
Running
PutPermission permits the specified AWS account or AWS organization to put events to the
specified event bus. |
default CompletableFuture<PutPermissionResponse> |
putPermission(PutPermissionRequest putPermissionRequest)
Running
PutPermission permits the specified AWS account or AWS organization to put events to the
specified event bus. |
default CompletableFuture<PutRuleResponse> |
putRule(Consumer<PutRuleRequest.Builder> putRuleRequest)
Creates or updates the specified rule.
|
default CompletableFuture<PutRuleResponse> |
putRule(PutRuleRequest putRuleRequest)
Creates or updates the specified rule.
|
default CompletableFuture<PutTargetsResponse> |
putTargets(Consumer<PutTargetsRequest.Builder> putTargetsRequest)
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the
rule.
|
default CompletableFuture<PutTargetsResponse> |
putTargets(PutTargetsRequest putTargetsRequest)
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the
rule.
|
default CompletableFuture<RemovePermissionResponse> |
removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)
Revokes the permission of another AWS account to be able to put events to the specified event bus.
|
default CompletableFuture<RemovePermissionResponse> |
removePermission(RemovePermissionRequest removePermissionRequest)
Revokes the permission of another AWS account to be able to put events to the specified event bus.
|
default CompletableFuture<RemoveTargetsResponse> |
removeTargets(Consumer<RemoveTargetsRequest.Builder> removeTargetsRequest)
Removes the specified targets from the specified rule.
|
default CompletableFuture<RemoveTargetsResponse> |
removeTargets(RemoveTargetsRequest removeTargetsRequest)
Removes the specified targets from the specified rule.
|
default CompletableFuture<StartReplayResponse> |
startReplay(Consumer<StartReplayRequest.Builder> startReplayRequest)
Starts the specified replay.
|
default CompletableFuture<StartReplayResponse> |
startReplay(StartReplayRequest startReplayRequest)
Starts the specified replay.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified EventBridge resource.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified EventBridge resource.
|
default CompletableFuture<TestEventPatternResponse> |
testEventPattern(Consumer<TestEventPatternRequest.Builder> testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
|
default CompletableFuture<TestEventPatternResponse> |
testEventPattern(TestEventPatternRequest testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified EventBridge resource.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified EventBridge resource.
|
default CompletableFuture<UpdateArchiveResponse> |
updateArchive(Consumer<UpdateArchiveRequest.Builder> updateArchiveRequest)
Updates the specified archive.
|
default CompletableFuture<UpdateArchiveResponse> |
updateArchive(UpdateArchiveRequest updateArchiveRequest)
Updates the specified archive.
|
serviceNameclosestatic final String SERVICE_NAME
static CloudWatchEventsAsyncClient create()
CloudWatchEventsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudWatchEventsAsyncClientBuilder builder()
CloudWatchEventsAsyncClient.default CompletableFuture<ActivateEventSourceResponse> activateEventSource(ActivateEventSourceRequest activateEventSourceRequest)
Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
activateEventSourceRequest - default CompletableFuture<ActivateEventSourceResponse> activateEventSource(Consumer<ActivateEventSourceRequest.Builder> activateEventSourceRequest)
Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
This is a convenience which creates an instance of the ActivateEventSourceRequest.Builder avoiding the
need to create one manually via ActivateEventSourceRequest.builder()
activateEventSourceRequest - A Consumer that will call methods on ActivateEventSourceRequest.Builder to create a
request.default CompletableFuture<CancelReplayResponse> cancelReplay(CancelReplayRequest cancelReplayRequest)
Cancels the specified replay.
cancelReplayRequest - default CompletableFuture<CancelReplayResponse> cancelReplay(Consumer<CancelReplayRequest.Builder> cancelReplayRequest)
Cancels the specified replay.
This is a convenience which creates an instance of the CancelReplayRequest.Builder avoiding the need to
create one manually via CancelReplayRequest.builder()
cancelReplayRequest - A Consumer that will call methods on CancelReplayRequest.Builder to create a request.default CompletableFuture<CreateArchiveResponse> createArchive(CreateArchiveRequest createArchiveRequest)
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.
createArchiveRequest - default CompletableFuture<CreateArchiveResponse> createArchive(Consumer<CreateArchiveRequest.Builder> createArchiveRequest)
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.
This is a convenience which creates an instance of the CreateArchiveRequest.Builder avoiding the need to
create one manually via CreateArchiveRequest.builder()
createArchiveRequest - A Consumer that will call methods on CreateArchiveRequest.Builder to create a request.default CompletableFuture<CreateEventBusResponse> createEventBus(CreateEventBusRequest createEventBusRequest)
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.
createEventBusRequest - default CompletableFuture<CreateEventBusResponse> createEventBus(Consumer<CreateEventBusRequest.Builder> createEventBusRequest)
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.
This is a convenience which creates an instance of the CreateEventBusRequest.Builder avoiding the need to
create one manually via CreateEventBusRequest.builder()
createEventBusRequest - A Consumer that will call methods on CreateEventBusRequest.Builder to create a request.default CompletableFuture<CreatePartnerEventSourceResponse> createPartnerEventSource(CreatePartnerEventSourceRequest createPartnerEventSourceRequest)
Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers.
Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS 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 AWS 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 AWS 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 AWS 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 AWS customers decide whether to create an event bus to receive these events.
createPartnerEventSourceRequest - default CompletableFuture<CreatePartnerEventSourceResponse> createPartnerEventSource(Consumer<CreatePartnerEventSourceRequest.Builder> createPartnerEventSourceRequest)
Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers.
Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS 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 AWS 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 AWS 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 AWS 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 AWS customers decide whether to create an event bus to receive these events.
This is a convenience which creates an instance of the CreatePartnerEventSourceRequest.Builder avoiding
the need to create one manually via CreatePartnerEventSourceRequest.builder()
createPartnerEventSourceRequest - A Consumer that will call methods on CreatePartnerEventSourceRequest.Builder to create a
request.default CompletableFuture<DeactivateEventSourceResponse> deactivateEventSource(DeactivateEventSourceRequest deactivateEventSourceRequest)
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.
deactivateEventSourceRequest - default CompletableFuture<DeactivateEventSourceResponse> deactivateEventSource(Consumer<DeactivateEventSourceRequest.Builder> deactivateEventSourceRequest)
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.
This is a convenience which creates an instance of the DeactivateEventSourceRequest.Builder avoiding the
need to create one manually via DeactivateEventSourceRequest.builder()
deactivateEventSourceRequest - A Consumer that will call methods on DeactivateEventSourceRequest.Builder to create a
request.default CompletableFuture<DeleteArchiveResponse> deleteArchive(DeleteArchiveRequest deleteArchiveRequest)
Deletes the specified archive.
deleteArchiveRequest - default CompletableFuture<DeleteArchiveResponse> deleteArchive(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest)
Deletes the specified archive.
This is a convenience which creates an instance of the DeleteArchiveRequest.Builder avoiding the need to
create one manually via DeleteArchiveRequest.builder()
deleteArchiveRequest - A Consumer that will call methods on DeleteArchiveRequest.Builder to create a request.default CompletableFuture<DeleteEventBusResponse> deleteEventBus(DeleteEventBusRequest deleteEventBusRequest)
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.
deleteEventBusRequest - default CompletableFuture<DeleteEventBusResponse> deleteEventBus(Consumer<DeleteEventBusRequest.Builder> deleteEventBusRequest)
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.
This is a convenience which creates an instance of the DeleteEventBusRequest.Builder avoiding the need to
create one manually via DeleteEventBusRequest.builder()
deleteEventBusRequest - A Consumer that will call methods on DeleteEventBusRequest.Builder to create a request.default CompletableFuture<DeletePartnerEventSourceResponse> deletePartnerEventSource(DeletePartnerEventSourceRequest deletePartnerEventSourceRequest)
This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.
When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.
deletePartnerEventSourceRequest - default CompletableFuture<DeletePartnerEventSourceResponse> deletePartnerEventSource(Consumer<DeletePartnerEventSourceRequest.Builder> deletePartnerEventSourceRequest)
This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.
When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.
This is a convenience which creates an instance of the DeletePartnerEventSourceRequest.Builder avoiding
the need to create one manually via DeletePartnerEventSourceRequest.builder()
deletePartnerEventSourceRequest - A Consumer that will call methods on DeletePartnerEventSourceRequest.Builder to create a
request.default CompletableFuture<DeleteRuleResponse> deleteRule(DeleteRuleRequest deleteRuleRequest)
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.
Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by
those other AWS 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.
deleteRuleRequest - 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.default CompletableFuture<DeleteRuleResponse> deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
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.
Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by
those other AWS 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.
This is a convenience which creates an instance of the DeleteRuleRequest.Builder avoiding the need to
create one manually via DeleteRuleRequest.builder()
deleteRuleRequest - A Consumer that will call methods on DeleteRuleRequest.Builder to create a request.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.default CompletableFuture<DescribeArchiveResponse> describeArchive(DescribeArchiveRequest describeArchiveRequest)
Retrieves details about an archive.
describeArchiveRequest - default CompletableFuture<DescribeArchiveResponse> describeArchive(Consumer<DescribeArchiveRequest.Builder> describeArchiveRequest)
Retrieves details about an archive.
This is a convenience which creates an instance of the DescribeArchiveRequest.Builder avoiding the need
to create one manually via DescribeArchiveRequest.builder()
describeArchiveRequest - A Consumer that will call methods on DescribeArchiveRequest.Builder to create a request.default CompletableFuture<DescribeEventBusResponse> describeEventBus(DescribeEventBusRequest describeEventBusRequest)
Displays details about an event bus in your account. This can include the external AWS 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.
describeEventBusRequest - default CompletableFuture<DescribeEventBusResponse> describeEventBus(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest)
Displays details about an event bus in your account. This can include the external AWS 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.
This is a convenience which creates an instance of the DescribeEventBusRequest.Builder avoiding the need
to create one manually via DescribeEventBusRequest.builder()
describeEventBusRequest - A Consumer that will call methods on DescribeEventBusRequest.Builder to create a request.default CompletableFuture<DescribeEventBusResponse> describeEventBus()
Displays details about an event bus in your account. This can include the external AWS 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.
default CompletableFuture<DescribeEventSourceResponse> describeEventSource(DescribeEventSourceRequest describeEventSourceRequest)
This operation lists details about a partner event source that is shared with your account.
describeEventSourceRequest - default CompletableFuture<DescribeEventSourceResponse> describeEventSource(Consumer<DescribeEventSourceRequest.Builder> describeEventSourceRequest)
This operation lists details about a partner event source that is shared with your account.
This is a convenience which creates an instance of the DescribeEventSourceRequest.Builder avoiding the
need to create one manually via DescribeEventSourceRequest.builder()
describeEventSourceRequest - A Consumer that will call methods on DescribeEventSourceRequest.Builder to create a
request.default CompletableFuture<DescribePartnerEventSourceResponse> describePartnerEventSource(DescribePartnerEventSourceRequest describePartnerEventSourceRequest)
An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.
describePartnerEventSourceRequest - default CompletableFuture<DescribePartnerEventSourceResponse> describePartnerEventSource(Consumer<DescribePartnerEventSourceRequest.Builder> describePartnerEventSourceRequest)
An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.
This is a convenience which creates an instance of the DescribePartnerEventSourceRequest.Builder avoiding
the need to create one manually via DescribePartnerEventSourceRequest.builder()
describePartnerEventSourceRequest - A Consumer that will call methods on DescribePartnerEventSourceRequest.Builder to create a
request.default CompletableFuture<DescribeReplayResponse> describeReplay(DescribeReplayRequest describeReplayRequest)
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.
describeReplayRequest - default CompletableFuture<DescribeReplayResponse> describeReplay(Consumer<DescribeReplayRequest.Builder> describeReplayRequest)
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.
This is a convenience which creates an instance of the DescribeReplayRequest.Builder avoiding the need to
create one manually via DescribeReplayRequest.builder()
describeReplayRequest - A Consumer that will call methods on DescribeReplayRequest.Builder to create a request.default CompletableFuture<DescribeRuleResponse> describeRule(DescribeRuleRequest describeRuleRequest)
Describes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
describeRuleRequest - default CompletableFuture<DescribeRuleResponse> describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest)
Describes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
This is a convenience which creates an instance of the DescribeRuleRequest.Builder avoiding the need to
create one manually via DescribeRuleRequest.builder()
describeRuleRequest - A Consumer that will call methods on DescribeRuleRequest.Builder to create a request.default CompletableFuture<DisableRuleResponse> disableRule(DisableRuleRequest disableRuleRequest)
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.
disableRuleRequest - 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.default CompletableFuture<DisableRuleResponse> disableRule(Consumer<DisableRuleRequest.Builder> disableRuleRequest)
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.
This is a convenience which creates an instance of the DisableRuleRequest.Builder avoiding the need to
create one manually via DisableRuleRequest.builder()
disableRuleRequest - A Consumer that will call methods on DisableRuleRequest.Builder to create a request.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.default CompletableFuture<EnableRuleResponse> enableRule(EnableRuleRequest enableRuleRequest)
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.
enableRuleRequest - 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.default CompletableFuture<EnableRuleResponse> enableRule(Consumer<EnableRuleRequest.Builder> enableRuleRequest)
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.
This is a convenience which creates an instance of the EnableRuleRequest.Builder avoiding the need to
create one manually via EnableRuleRequest.builder()
enableRuleRequest - A Consumer that will call methods on EnableRuleRequest.Builder to create a request.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.default CompletableFuture<ListArchivesResponse> listArchives(ListArchivesRequest listArchivesRequest)
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.
listArchivesRequest - default CompletableFuture<ListArchivesResponse> listArchives(Consumer<ListArchivesRequest.Builder> listArchivesRequest)
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.
This is a convenience which creates an instance of the ListArchivesRequest.Builder avoiding the need to
create one manually via ListArchivesRequest.builder()
listArchivesRequest - A Consumer that will call methods on ListArchivesRequest.Builder to create a request.default CompletableFuture<ListEventBusesResponse> listEventBuses(ListEventBusesRequest listEventBusesRequest)
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
listEventBusesRequest - default CompletableFuture<ListEventBusesResponse> listEventBuses(Consumer<ListEventBusesRequest.Builder> listEventBusesRequest)
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
This is a convenience which creates an instance of the ListEventBusesRequest.Builder avoiding the need to
create one manually via ListEventBusesRequest.builder()
listEventBusesRequest - A Consumer that will call methods on ListEventBusesRequest.Builder to create a request.default CompletableFuture<ListEventSourcesResponse> listEventSources(ListEventSourcesRequest listEventSourcesRequest)
You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.
listEventSourcesRequest - default CompletableFuture<ListEventSourcesResponse> listEventSources(Consumer<ListEventSourcesRequest.Builder> listEventSourcesRequest)
You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.
This is a convenience which creates an instance of the ListEventSourcesRequest.Builder avoiding the need
to create one manually via ListEventSourcesRequest.builder()
listEventSourcesRequest - A Consumer that will call methods on ListEventSourcesRequest.Builder to create a request.default CompletableFuture<ListPartnerEventSourceAccountsResponse> listPartnerEventSourceAccounts(ListPartnerEventSourceAccountsRequest listPartnerEventSourceAccountsRequest)
An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is not used by AWS customers.
listPartnerEventSourceAccountsRequest - default CompletableFuture<ListPartnerEventSourceAccountsResponse> listPartnerEventSourceAccounts(Consumer<ListPartnerEventSourceAccountsRequest.Builder> listPartnerEventSourceAccountsRequest)
An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is not used by AWS customers.
This is a convenience which creates an instance of the ListPartnerEventSourceAccountsRequest.Builder
avoiding the need to create one manually via ListPartnerEventSourceAccountsRequest.builder()
listPartnerEventSourceAccountsRequest - A Consumer that will call methods on ListPartnerEventSourceAccountsRequest.Builder to
create a request.default CompletableFuture<ListPartnerEventSourcesResponse> listPartnerEventSources(ListPartnerEventSourcesRequest listPartnerEventSourcesRequest)
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 AWS customers.
listPartnerEventSourcesRequest - default CompletableFuture<ListPartnerEventSourcesResponse> listPartnerEventSources(Consumer<ListPartnerEventSourcesRequest.Builder> listPartnerEventSourcesRequest)
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 AWS customers.
This is a convenience which creates an instance of the ListPartnerEventSourcesRequest.Builder avoiding
the need to create one manually via ListPartnerEventSourcesRequest.builder()
listPartnerEventSourcesRequest - A Consumer that will call methods on ListPartnerEventSourcesRequest.Builder to create a
request.default CompletableFuture<ListReplaysResponse> listReplays(ListReplaysRequest listReplaysRequest)
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.
listReplaysRequest - default CompletableFuture<ListReplaysResponse> listReplays(Consumer<ListReplaysRequest.Builder> listReplaysRequest)
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.
This is a convenience which creates an instance of the ListReplaysRequest.Builder avoiding the need to
create one manually via ListReplaysRequest.builder()
listReplaysRequest - A Consumer that will call methods on ListReplaysRequest.Builder to create a request.default CompletableFuture<ListRuleNamesByTargetResponse> listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)
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.
listRuleNamesByTargetRequest - default CompletableFuture<ListRuleNamesByTargetResponse> listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> listRuleNamesByTargetRequest)
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.
This is a convenience which creates an instance of the ListRuleNamesByTargetRequest.Builder avoiding the
need to create one manually via ListRuleNamesByTargetRequest.builder()
listRuleNamesByTargetRequest - A Consumer that will call methods on ListRuleNamesByTargetRequest.Builder to create a
request.default CompletableFuture<ListRulesResponse> listRules(ListRulesRequest listRulesRequest)
Lists 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.
listRulesRequest - default CompletableFuture<ListRulesResponse> listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)
Lists 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.
This is a convenience which creates an instance of the ListRulesRequest.Builder avoiding the need to
create one manually via ListRulesRequest.builder()
listRulesRequest - A Consumer that will call methods on ListRulesRequest.Builder to create a request.default CompletableFuture<ListRulesResponse> listRules()
Lists 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.
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<ListTargetsByRuleResponse> listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
listTargetsByRuleRequest - default CompletableFuture<ListTargetsByRuleResponse> listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
This is a convenience which creates an instance of the ListTargetsByRuleRequest.Builder avoiding the need
to create one manually via ListTargetsByRuleRequest.builder()
listTargetsByRuleRequest - A Consumer that will call methods on ListTargetsByRuleRequest.Builder to create a request.default CompletableFuture<PutEventsResponse> putEvents(PutEventsRequest putEventsRequest)
Sends custom events to Amazon EventBridge so that they can be matched to rules.
putEventsRequest - default CompletableFuture<PutEventsResponse> putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)
Sends custom events to Amazon EventBridge so that they can be matched to rules.
This is a convenience which creates an instance of the PutEventsRequest.Builder avoiding the need to
create one manually via PutEventsRequest.builder()
putEventsRequest - A Consumer that will call methods on PutEventsRequest.Builder to create a request.default CompletableFuture<PutPartnerEventsResponse> putPartnerEvents(PutPartnerEventsRequest putPartnerEventsRequest)
This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.
putPartnerEventsRequest - default CompletableFuture<PutPartnerEventsResponse> putPartnerEvents(Consumer<PutPartnerEventsRequest.Builder> putPartnerEventsRequest)
This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.
This is a convenience which creates an instance of the PutPartnerEventsRequest.Builder avoiding the need
to create one manually via PutPartnerEventsRequest.builder()
putPartnerEventsRequest - A Consumer that will call methods on PutPartnerEventsRequest.Builder to create a request.default CompletableFuture<PutPermissionResponse> putPermission(PutPermissionRequest putPermissionRequest)
Running PutPermission permits the specified AWS account or AWS 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 AWS 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 AWS organization, you can run
PutPermission once specifying Principal as "*" and specifying the AWS 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 AWS Accounts in the Amazon EventBridge User Guide.
The permission policy on the default event bus cannot exceed 10 KB in size.
putPermissionRequest - default CompletableFuture<PutPermissionResponse> putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest)
Running PutPermission permits the specified AWS account or AWS 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 AWS 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 AWS organization, you can run
PutPermission once specifying Principal as "*" and specifying the AWS 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 AWS Accounts in the Amazon EventBridge User Guide.
The permission policy on the default event bus cannot exceed 10 KB in size.
This is a convenience which creates an instance of the PutPermissionRequest.Builder avoiding the need to
create one manually via PutPermissionRequest.builder()
putPermissionRequest - A Consumer that will call methods on PutPermissionRequest.Builder to create a request.default CompletableFuture<PutRuleResponse> putRule(PutRuleRequest putRuleRequest)
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 AWS 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 AWS 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.
putRuleRequest - 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.default CompletableFuture<PutRuleResponse> putRule(Consumer<PutRuleRequest.Builder> putRuleRequest)
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 AWS 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 AWS 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.
This is a convenience which creates an instance of the PutRuleRequest.Builder avoiding the need to create
one manually via PutRuleRequest.builder()
putRuleRequest - A Consumer that will call methods on PutRuleRequest.Builder to create a request.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.default CompletableFuture<PutTargetsResponse> putTargets(PutTargetsRequest putTargetsRequest)
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.
You can configure the following as targets for Events:
EC2 instances
SSM Run Command
SSM Automation
AWS Lambda functions
Data streams in Amazon Kinesis Data Streams
Data delivery streams in Amazon Kinesis Data Firehose
Amazon ECS tasks
AWS Step Functions state machines
AWS Batch jobs
AWS CodeBuild projects
Pipelines in AWS CodePipeline
Amazon Inspector assessment templates
Amazon SNS topics
Amazon SQS queues, including FIFO queues
The default event bus of another AWS account
Amazon API Gateway REST APIs
Redshift Clusters to invoke Data API ExecuteStatement on
Creating rules with built-in targets is supported only in the AWS 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 (CloudWatch Events) needs the
appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
For EC2 instances, Kinesis data streams, AWS 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 AWS 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 (CloudWatch Events) Pricing.
Input, InputPath, and InputTransformer are not available with
PutTarget if the target is an event bus of a different AWS 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 AWS 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.
putTargetsRequest - 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.default CompletableFuture<PutTargetsResponse> putTargets(Consumer<PutTargetsRequest.Builder> putTargetsRequest)
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.
You can configure the following as targets for Events:
EC2 instances
SSM Run Command
SSM Automation
AWS Lambda functions
Data streams in Amazon Kinesis Data Streams
Data delivery streams in Amazon Kinesis Data Firehose
Amazon ECS tasks
AWS Step Functions state machines
AWS Batch jobs
AWS CodeBuild projects
Pipelines in AWS CodePipeline
Amazon Inspector assessment templates
Amazon SNS topics
Amazon SQS queues, including FIFO queues
The default event bus of another AWS account
Amazon API Gateway REST APIs
Redshift Clusters to invoke Data API ExecuteStatement on
Creating rules with built-in targets is supported only in the AWS 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 (CloudWatch Events) needs the
appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
For EC2 instances, Kinesis data streams, AWS 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 AWS 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 (CloudWatch Events) Pricing.
Input, InputPath, and InputTransformer are not available with
PutTarget if the target is an event bus of a different AWS 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 AWS 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.
This is a convenience which creates an instance of the PutTargetsRequest.Builder avoiding the need to
create one manually via PutTargetsRequest.builder()
putTargetsRequest - A Consumer that will call methods on PutTargetsRequest.Builder to create a request.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.default CompletableFuture<RemovePermissionResponse> removePermission(RemovePermissionRequest removePermissionRequest)
Revokes the permission of another AWS 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.
removePermissionRequest - default CompletableFuture<RemovePermissionResponse> removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)
Revokes the permission of another AWS 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.
This is a convenience which creates an instance of the RemovePermissionRequest.Builder avoiding the need
to create one manually via RemovePermissionRequest.builder()
removePermissionRequest - A Consumer that will call methods on RemovePermissionRequest.Builder to create a request.default CompletableFuture<RemoveTargetsResponse> removeTargets(RemoveTargetsRequest removeTargetsRequest)
Removes 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.
removeTargetsRequest - 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.default CompletableFuture<RemoveTargetsResponse> removeTargets(Consumer<RemoveTargetsRequest.Builder> removeTargetsRequest)
Removes 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.
This is a convenience which creates an instance of the RemoveTargetsRequest.Builder avoiding the need to
create one manually via RemoveTargetsRequest.builder()
removeTargetsRequest - A Consumer that will call methods on RemoveTargetsRequest.Builder to create a request.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.default CompletableFuture<StartReplayResponse> startReplay(StartReplayRequest startReplayRequest)
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.
startReplayRequest - default CompletableFuture<StartReplayResponse> startReplay(Consumer<StartReplayRequest.Builder> startReplayRequest)
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.
This is a convenience which creates an instance of the StartReplayRequest.Builder avoiding the need to
create one manually via StartReplayRequest.builder()
startReplayRequest - A Consumer that will call methods on StartReplayRequest.Builder to create a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
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 AWS 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.
tagResourceRequest - 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.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
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 AWS 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.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.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.default CompletableFuture<TestEventPatternResponse> testEventPattern(TestEventPatternRequest testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
Most services in AWS 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.
testEventPatternRequest - default CompletableFuture<TestEventPatternResponse> testEventPattern(Consumer<TestEventPatternRequest.Builder> testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
Most services in AWS 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.
This is a convenience which creates an instance of the TestEventPatternRequest.Builder avoiding the need
to create one manually via TestEventPatternRequest.builder()
testEventPatternRequest - A Consumer that will call methods on TestEventPatternRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.
untagResourceRequest - 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.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.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.default CompletableFuture<UpdateArchiveResponse> updateArchive(UpdateArchiveRequest updateArchiveRequest)
Updates the specified archive.
updateArchiveRequest - default CompletableFuture<UpdateArchiveResponse> updateArchive(Consumer<UpdateArchiveRequest.Builder> updateArchiveRequest)
Updates the specified archive.
This is a convenience which creates an instance of the UpdateArchiveRequest.Builder avoiding the need to
create one manually via UpdateArchiveRequest.builder()
updateArchiveRequest - A Consumer that will call methods on UpdateArchiveRequest.Builder to create a request.Copyright © 2020. All rights reserved.