@Generated(value="software.amazon.awssdk:codegen") public interface CloudWatchEventsClient 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 ActivateEventSourceResponse |
activateEventSource(ActivateEventSourceRequest activateEventSourceRequest)
Activates a partner event source that has been deactivated.
|
default ActivateEventSourceResponse |
activateEventSource(Consumer<ActivateEventSourceRequest.Builder> activateEventSourceRequest)
Activates a partner event source that has been deactivated.
|
static CloudWatchEventsClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudWatchEventsClient. |
default CancelReplayResponse |
cancelReplay(CancelReplayRequest cancelReplayRequest)
Cancels the specified replay.
|
default CancelReplayResponse |
cancelReplay(Consumer<CancelReplayRequest.Builder> cancelReplayRequest)
Cancels the specified replay.
|
static CloudWatchEventsClient |
create()
Create a
CloudWatchEventsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateArchiveResponse |
createArchive(Consumer<CreateArchiveRequest.Builder> createArchiveRequest)
Creates an archive of events with the specified settings.
|
default CreateArchiveResponse |
createArchive(CreateArchiveRequest createArchiveRequest)
Creates an archive of events with the specified settings.
|
default CreateEventBusResponse |
createEventBus(Consumer<CreateEventBusRequest.Builder> createEventBusRequest)
Creates a new event bus within your account.
|
default CreateEventBusResponse |
createEventBus(CreateEventBusRequest createEventBusRequest)
Creates a new event bus within your account.
|
default CreatePartnerEventSourceResponse |
createPartnerEventSource(Consumer<CreatePartnerEventSourceRequest.Builder> createPartnerEventSourceRequest)
Called by an SaaS partner to create a partner event source.
|
default CreatePartnerEventSourceResponse |
createPartnerEventSource(CreatePartnerEventSourceRequest createPartnerEventSourceRequest)
Called by an SaaS partner to create a partner event source.
|
default DeactivateEventSourceResponse |
deactivateEventSource(Consumer<DeactivateEventSourceRequest.Builder> deactivateEventSourceRequest)
You can use this operation to temporarily stop receiving events from the specified partner event source.
|
default DeactivateEventSourceResponse |
deactivateEventSource(DeactivateEventSourceRequest deactivateEventSourceRequest)
You can use this operation to temporarily stop receiving events from the specified partner event source.
|
default DeleteArchiveResponse |
deleteArchive(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest)
Deletes the specified archive.
|
default DeleteArchiveResponse |
deleteArchive(DeleteArchiveRequest deleteArchiveRequest)
Deletes the specified archive.
|
default DeleteEventBusResponse |
deleteEventBus(Consumer<DeleteEventBusRequest.Builder> deleteEventBusRequest)
Deletes the specified custom event bus or partner event bus.
|
default DeleteEventBusResponse |
deleteEventBus(DeleteEventBusRequest deleteEventBusRequest)
Deletes the specified custom event bus or partner event bus.
|
default DeletePartnerEventSourceResponse |
deletePartnerEventSource(Consumer<DeletePartnerEventSourceRequest.Builder> deletePartnerEventSourceRequest)
This operation is used by SaaS partners to delete a partner event source.
|
default DeletePartnerEventSourceResponse |
deletePartnerEventSource(DeletePartnerEventSourceRequest deletePartnerEventSourceRequest)
This operation is used by SaaS partners to delete a partner event source.
|
default DeleteRuleResponse |
deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
Deletes the specified rule.
|
default DeleteRuleResponse |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the specified rule.
|
default DescribeArchiveResponse |
describeArchive(Consumer<DescribeArchiveRequest.Builder> describeArchiveRequest)
Retrieves details about an archive.
|
default DescribeArchiveResponse |
describeArchive(DescribeArchiveRequest describeArchiveRequest)
Retrieves details about an archive.
|
default DescribeEventBusResponse |
describeEventBus()
Displays details about an event bus in your account.
|
default DescribeEventBusResponse |
describeEventBus(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest)
Displays details about an event bus in your account.
|
default DescribeEventBusResponse |
describeEventBus(DescribeEventBusRequest describeEventBusRequest)
Displays details about an event bus in your account.
|
default DescribeEventSourceResponse |
describeEventSource(Consumer<DescribeEventSourceRequest.Builder> describeEventSourceRequest)
This operation lists details about a partner event source that is shared with your account.
|
default DescribeEventSourceResponse |
describeEventSource(DescribeEventSourceRequest describeEventSourceRequest)
This operation lists details about a partner event source that is shared with your account.
|
default 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 DescribePartnerEventSourceResponse |
describePartnerEventSource(DescribePartnerEventSourceRequest describePartnerEventSourceRequest)
An SaaS partner can use this operation to list details about a partner event source that they have created.
|
default DescribeReplayResponse |
describeReplay(Consumer<DescribeReplayRequest.Builder> describeReplayRequest)
Retrieves details about a replay.
|
default DescribeReplayResponse |
describeReplay(DescribeReplayRequest describeReplayRequest)
Retrieves details about a replay.
|
default DescribeRuleResponse |
describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest)
Describes the specified rule.
|
default DescribeRuleResponse |
describeRule(DescribeRuleRequest describeRuleRequest)
Describes the specified rule.
|
default DisableRuleResponse |
disableRule(Consumer<DisableRuleRequest.Builder> disableRuleRequest)
Disables the specified rule.
|
default DisableRuleResponse |
disableRule(DisableRuleRequest disableRuleRequest)
Disables the specified rule.
|
default EnableRuleResponse |
enableRule(Consumer<EnableRuleRequest.Builder> enableRuleRequest)
Enables the specified rule.
|
default EnableRuleResponse |
enableRule(EnableRuleRequest enableRuleRequest)
Enables the specified rule.
|
default ListArchivesResponse |
listArchives(Consumer<ListArchivesRequest.Builder> listArchivesRequest)
Lists your archives.
|
default ListArchivesResponse |
listArchives(ListArchivesRequest listArchivesRequest)
Lists your archives.
|
default 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 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 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 ListEventSourcesResponse |
listEventSources(ListEventSourcesRequest listEventSourcesRequest)
You can use this to see all the partner event sources that have been shared with your AWS account.
|
default 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 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 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 ListPartnerEventSourcesResponse |
listPartnerEventSources(ListPartnerEventSourcesRequest listPartnerEventSourcesRequest)
An SaaS partner can use this operation to list all the partner event source names that they have created.
|
default ListReplaysResponse |
listReplays(Consumer<ListReplaysRequest.Builder> listReplaysRequest)
Lists your replays.
|
default ListReplaysResponse |
listReplays(ListReplaysRequest listReplaysRequest)
Lists your replays.
|
default ListRuleNamesByTargetResponse |
listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> listRuleNamesByTargetRequest)
Lists the rules for the specified target.
|
default ListRuleNamesByTargetResponse |
listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)
Lists the rules for the specified target.
|
default ListRulesResponse |
listRules()
Lists your Amazon EventBridge rules.
|
default ListRulesResponse |
listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)
Lists your Amazon EventBridge rules.
|
default ListRulesResponse |
listRules(ListRulesRequest listRulesRequest)
Lists your Amazon EventBridge rules.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Displays the tags associated with an EventBridge resource.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Displays the tags associated with an EventBridge resource.
|
default ListTargetsByRuleResponse |
listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
|
default ListTargetsByRuleResponse |
listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
|
default PutEventsResponse |
putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)
Sends custom events to Amazon EventBridge so that they can be matched to rules.
|
default PutEventsResponse |
putEvents(PutEventsRequest putEventsRequest)
Sends custom events to Amazon EventBridge so that they can be matched to rules.
|
default PutPartnerEventsResponse |
putPartnerEvents(Consumer<PutPartnerEventsRequest.Builder> putPartnerEventsRequest)
This is used by SaaS partners to write events to a customer's partner event bus.
|
default PutPartnerEventsResponse |
putPartnerEvents(PutPartnerEventsRequest putPartnerEventsRequest)
This is used by SaaS partners to write events to a customer's partner event bus.
|
default 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 PutPermissionResponse |
putPermission(PutPermissionRequest putPermissionRequest)
Running
PutPermission permits the specified AWS account or AWS organization to put events to the
specified event bus. |
default PutRuleResponse |
putRule(Consumer<PutRuleRequest.Builder> putRuleRequest)
Creates or updates the specified rule.
|
default PutRuleResponse |
putRule(PutRuleRequest putRuleRequest)
Creates or updates the specified rule.
|
default 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 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 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 RemovePermissionResponse |
removePermission(RemovePermissionRequest removePermissionRequest)
Revokes the permission of another AWS account to be able to put events to the specified event bus.
|
default RemoveTargetsResponse |
removeTargets(Consumer<RemoveTargetsRequest.Builder> removeTargetsRequest)
Removes the specified targets from the specified rule.
|
default RemoveTargetsResponse |
removeTargets(RemoveTargetsRequest removeTargetsRequest)
Removes the specified targets from the specified rule.
|
static ServiceMetadata |
serviceMetadata() |
default StartReplayResponse |
startReplay(Consumer<StartReplayRequest.Builder> startReplayRequest)
Starts the specified replay.
|
default StartReplayResponse |
startReplay(StartReplayRequest startReplayRequest)
Starts the specified replay.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified EventBridge resource.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Assigns one or more tags (key-value pairs) to the specified EventBridge resource.
|
default TestEventPatternResponse |
testEventPattern(Consumer<TestEventPatternRequest.Builder> testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
|
default TestEventPatternResponse |
testEventPattern(TestEventPatternRequest testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes one or more tags from the specified EventBridge resource.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes one or more tags from the specified EventBridge resource.
|
default UpdateArchiveResponse |
updateArchive(Consumer<UpdateArchiveRequest.Builder> updateArchiveRequest)
Updates the specified archive.
|
default UpdateArchiveResponse |
updateArchive(UpdateArchiveRequest updateArchiveRequest)
Updates the specified archive.
|
serviceNameclosestatic final String SERVICE_NAME
static CloudWatchEventsClient create()
CloudWatchEventsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudWatchEventsClientBuilder builder()
CloudWatchEventsClient.default ActivateEventSourceResponse activateEventSource(ActivateEventSourceRequest activateEventSourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
activateEventSourceRequest - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.InvalidStateException - The specified state is not a valid state for an event source.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ActivateEventSourceResponse activateEventSource(Consumer<ActivateEventSourceRequest.Builder> activateEventSourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.InvalidStateException - The specified state is not a valid state for an event source.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelReplayResponse cancelReplay(CancelReplayRequest cancelReplayRequest) throws ResourceNotFoundException, ConcurrentModificationException, IllegalStatusException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Cancels the specified replay.
cancelReplayRequest - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.IllegalStatusException - An error occurred because a replay can be canceled only when the state is Running or Starting.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CancelReplayResponse cancelReplay(Consumer<CancelReplayRequest.Builder> cancelReplayRequest) throws ResourceNotFoundException, ConcurrentModificationException, IllegalStatusException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.IllegalStatusException - An error occurred because a replay can be canceled only when the state is Running or Starting.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateArchiveResponse createArchive(CreateArchiveRequest createArchiveRequest) throws ConcurrentModificationException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ResourceAlreadyExistsException - The resource you are trying to create already exists.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.InvalidEventPatternException - The event pattern is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateArchiveResponse createArchive(Consumer<CreateArchiveRequest.Builder> createArchiveRequest) throws ConcurrentModificationException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ResourceAlreadyExistsException - The resource you are trying to create already exists.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.InvalidEventPatternException - The event pattern is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEventBusResponse createEventBus(CreateEventBusRequest createEventBusRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, InvalidStateException, InternalException, ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceAlreadyExistsException - The resource you are trying to create already exists.ResourceNotFoundException - An entity that you specified does not exist.InvalidStateException - The specified state is not a valid state for an event source.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateEventBusResponse createEventBus(Consumer<CreateEventBusRequest.Builder> createEventBusRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, InvalidStateException, InternalException, ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceAlreadyExistsException - The resource you are trying to create already exists.ResourceNotFoundException - An entity that you specified does not exist.InvalidStateException - The specified state is not a valid state for an event source.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePartnerEventSourceResponse createPartnerEventSource(CreatePartnerEventSourceRequest createPartnerEventSourceRequest) throws ResourceAlreadyExistsException, InternalException, ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceAlreadyExistsException - The resource you are trying to create already exists.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreatePartnerEventSourceResponse createPartnerEventSource(Consumer<CreatePartnerEventSourceRequest.Builder> createPartnerEventSourceRequest) throws ResourceAlreadyExistsException, InternalException, ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceAlreadyExistsException - The resource you are trying to create already exists.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeactivateEventSourceResponse deactivateEventSource(DeactivateEventSourceRequest deactivateEventSourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.InvalidStateException - The specified state is not a valid state for an event source.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeactivateEventSourceResponse deactivateEventSource(Consumer<DeactivateEventSourceRequest.Builder> deactivateEventSourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.InvalidStateException - The specified state is not a valid state for an event source.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteArchiveResponse deleteArchive(DeleteArchiveRequest deleteArchiveRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Deletes the specified archive.
deleteArchiveRequest - ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteArchiveResponse deleteArchive(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventBusResponse deleteEventBus(DeleteEventBusRequest deleteEventBusRequest) throws InternalException, ConcurrentModificationException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteEventBusResponse deleteEventBus(Consumer<DeleteEventBusRequest.Builder> deleteEventBusRequest) throws InternalException, ConcurrentModificationException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePartnerEventSourceResponse deletePartnerEventSource(DeletePartnerEventSourceRequest deletePartnerEventSourceRequest) throws InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeletePartnerEventSourceResponse deletePartnerEventSource(Consumer<DeletePartnerEventSourceRequest.Builder> deletePartnerEventSourceRequest) throws InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest) throws ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.ResourceNotFoundException - An entity that you specified does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRuleResponse deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) throws ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.ResourceNotFoundException - An entity that you specified does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeArchiveResponse describeArchive(DescribeArchiveRequest describeArchiveRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Retrieves details about an archive.
describeArchiveRequest - ResourceAlreadyExistsException - The resource you are trying to create already exists.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeArchiveResponse describeArchive(Consumer<DescribeArchiveRequest.Builder> describeArchiveRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceAlreadyExistsException - The resource you are trying to create already exists.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventBusResponse describeEventBus() throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.
ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEventBus(DescribeEventBusRequest),
AWS API
Documentationdefault DescribeEventBusResponse describeEventBus(DescribeEventBusRequest describeEventBusRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventBusResponse describeEventBus(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventSourceResponse describeEventSource(DescribeEventSourceRequest describeEventSourceRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
This operation lists details about a partner event source that is shared with your account.
describeEventSourceRequest - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventSourceResponse describeEventSource(Consumer<DescribeEventSourceRequest.Builder> describeEventSourceRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePartnerEventSourceResponse describePartnerEventSource(DescribePartnerEventSourceRequest describePartnerEventSourceRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePartnerEventSourceResponse describePartnerEventSource(Consumer<DescribePartnerEventSourceRequest.Builder> describePartnerEventSourceRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReplayResponse describeReplay(DescribeReplayRequest describeReplayRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReplayResponse describeReplay(Consumer<DescribeReplayRequest.Builder> describeReplayRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRuleResponse describeRule(DescribeRuleRequest describeRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Describes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
describeRuleRequest - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRuleResponse describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableRuleResponse disableRule(DisableRuleRequest disableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableRuleResponse disableRule(Consumer<DisableRuleRequest.Builder> disableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableRuleResponse enableRule(EnableRuleRequest enableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableRuleResponse enableRule(Consumer<EnableRuleRequest.Builder> enableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListArchivesResponse listArchives(ListArchivesRequest listArchivesRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListArchivesResponse listArchives(Consumer<ListArchivesRequest.Builder> listArchivesRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventBusesResponse listEventBuses(ListEventBusesRequest listEventBusesRequest) throws InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
listEventBusesRequest - InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventBusesResponse listEventBuses(Consumer<ListEventBusesRequest.Builder> listEventBusesRequest) throws InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventSourcesResponse listEventSources(ListEventSourcesRequest listEventSourcesRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListEventSourcesResponse listEventSources(Consumer<ListEventSourcesRequest.Builder> listEventSourcesRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPartnerEventSourceAccountsResponse listPartnerEventSourceAccounts(ListPartnerEventSourceAccountsRequest listPartnerEventSourceAccountsRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPartnerEventSourceAccountsResponse listPartnerEventSourceAccounts(Consumer<ListPartnerEventSourceAccountsRequest.Builder> listPartnerEventSourceAccountsRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPartnerEventSourcesResponse listPartnerEventSources(ListPartnerEventSourcesRequest listPartnerEventSourcesRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPartnerEventSourcesResponse listPartnerEventSources(Consumer<ListPartnerEventSourcesRequest.Builder> listPartnerEventSourcesRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReplaysResponse listReplays(ListReplaysRequest listReplaysRequest) throws InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListReplaysResponse listReplays(Consumer<ListReplaysRequest.Builder> listReplaysRequest) throws InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRuleNamesByTargetResponse listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest) throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - InternalException - This exception occurs due to unexpected causes.ResourceNotFoundException - An entity that you specified does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRuleNamesByTargetResponse listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> listRuleNamesByTargetRequest) throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.ResourceNotFoundException - An entity that you specified does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRulesResponse listRules() throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.
InternalException - This exception occurs due to unexpected causes.ResourceNotFoundException - An entity that you specified does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistRules(ListRulesRequest),
AWS API
Documentationdefault ListRulesResponse listRules(ListRulesRequest listRulesRequest) throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - InternalException - This exception occurs due to unexpected causes.ResourceNotFoundException - An entity that you specified does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRulesResponse listRules(Consumer<ListRulesRequest.Builder> listRulesRequest) throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.ResourceNotFoundException - An entity that you specified does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
listTagsForResourceRequest - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTargetsByRuleResponse listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Lists the targets assigned to the specified rule.
listTargetsByRuleRequest - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTargetsByRuleResponse listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEventsResponse putEvents(PutEventsRequest putEventsRequest) throws InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Sends custom events to Amazon EventBridge so that they can be matched to rules.
putEventsRequest - InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEventsResponse putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest) throws InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPartnerEventsResponse putPartnerEvents(PutPartnerEventsRequest putPartnerEventsRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.
putPartnerEventsRequest - InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPartnerEventsResponse putPartnerEvents(Consumer<PutPartnerEventsRequest.Builder> putPartnerEventsRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InternalException - This exception occurs due to unexpected causes.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPermissionResponse putPermission(PutPermissionRequest putPermissionRequest) throws ResourceNotFoundException, PolicyLengthExceededException, InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.PolicyLengthExceededException - The event bus policy is too long. For more information, see the limits.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPermissionResponse putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest) throws ResourceNotFoundException, PolicyLengthExceededException, InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.PolicyLengthExceededException - The event bus policy is too long. For more information, see the limits.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRuleResponse putRule(PutRuleRequest putRuleRequest) throws InvalidEventPatternException, LimitExceededException, ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - InvalidEventPatternException - The event pattern is not valid.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.ResourceNotFoundException - An entity that you specified does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRuleResponse putRule(Consumer<PutRuleRequest.Builder> putRuleRequest) throws InvalidEventPatternException, LimitExceededException, ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InvalidEventPatternException - The event pattern is not valid.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.ResourceNotFoundException - An entity that you specified does not exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutTargetsResponse putTargets(PutTargetsRequest putTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, LimitExceededException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutTargetsResponse putTargets(Consumer<PutTargetsRequest.Builder> putTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, LimitExceededException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemovePermissionResponse removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.OperationDisabledException - The operation you are attempting is not available in this region.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTargetsResponse removeTargets(RemoveTargetsRequest removeTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTargetsResponse removeTargets(Consumer<RemoveTargetsRequest.Builder> removeTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartReplayResponse startReplay(StartReplayRequest startReplayRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, InvalidEventPatternException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.ResourceAlreadyExistsException - The resource you are trying to create already exists.InvalidEventPatternException - The event pattern is not valid.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartReplayResponse startReplay(Consumer<StartReplayRequest.Builder> startReplayRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, InvalidEventPatternException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.ResourceAlreadyExistsException - The resource you are trying to create already exists.InvalidEventPatternException - The event pattern is not valid.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, ManagedRuleException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.InternalException - This exception occurs due to unexpected causes.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, ManagedRuleException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.InternalException - This exception occurs due to unexpected causes.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestEventPatternResponse testEventPattern(TestEventPatternRequest testEventPatternRequest) throws InvalidEventPatternException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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 - InvalidEventPatternException - The event pattern is not valid.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestEventPatternResponse testEventPattern(Consumer<TestEventPatternRequest.Builder> testEventPatternRequest) throws InvalidEventPatternException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.InvalidEventPatternException - The event pattern is not valid.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, ManagedRuleException, AwsServiceException, SdkClientException, CloudWatchEventsException
Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.
untagResourceRequest - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, ManagedRuleException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you
see this error in response to DeleteRule or RemoveTargets, you can use the
Force parameter in those calls to delete the rule or remove targets from the rule. You
cannot modify these managed rules by using DisableRule, EnableRule,
PutTargets, PutRule, TagResource, or UntagResource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateArchiveResponse updateArchive(UpdateArchiveRequest updateArchiveRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, CloudWatchEventsException
Updates the specified archive.
updateArchiveRequest - ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.InvalidEventPatternException - The event pattern is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateArchiveResponse updateArchive(Consumer<UpdateArchiveRequest.Builder> updateArchiveRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.ConcurrentModificationException - There is concurrent modification on a rule, target, archive, or replay.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.LimitExceededException - The request failed because it attempted to create resource beyond the allowed service quota.InvalidEventPatternException - The event pattern is not valid.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2020. All rights reserved.