Interface EventBridgeClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon EventBridge helps you to respond to state changes in your Amazon Web Services resources. When your resources change state, they automatically send events to an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a predetermined schedule. For example, you can configure rules to:
-
Automatically invoke an Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
-
Direct specific API records from CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.
-
Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.
For more information about the features of Amazon EventBridge, see the Amazon EventBridge User Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault ActivateEventSourceResponse
activateEventSource
(Consumer<ActivateEventSourceRequest.Builder> activateEventSourceRequest) Activates a partner event source that has been deactivated.default ActivateEventSourceResponse
activateEventSource
(ActivateEventSourceRequest activateEventSourceRequest) Activates a partner event source that has been deactivated.static EventBridgeClientBuilder
builder()
Create a builder that can be used to configure and create aEventBridgeClient
.default CancelReplayResponse
cancelReplay
(Consumer<CancelReplayRequest.Builder> cancelReplayRequest) Cancels the specified replay.default CancelReplayResponse
cancelReplay
(CancelReplayRequest cancelReplayRequest) Cancels the specified replay.static EventBridgeClient
create()
Create aEventBridgeClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateApiDestinationResponse
createApiDestination
(Consumer<CreateApiDestinationRequest.Builder> createApiDestinationRequest) Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.default CreateApiDestinationResponse
createApiDestination
(CreateApiDestinationRequest createApiDestinationRequest) Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.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 CreateConnectionResponse
createConnection
(Consumer<CreateConnectionRequest.Builder> createConnectionRequest) Creates a connection.default CreateConnectionResponse
createConnection
(CreateConnectionRequest createConnectionRequest) Creates a connection.default CreateEndpointResponse
createEndpoint
(Consumer<CreateEndpointRequest.Builder> createEndpointRequest) Creates a global endpoint.default CreateEndpointResponse
createEndpoint
(CreateEndpointRequest createEndpointRequest) Creates a global endpoint.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 DeauthorizeConnectionResponse
deauthorizeConnection
(Consumer<DeauthorizeConnectionRequest.Builder> deauthorizeConnectionRequest) Removes all authorization parameters from the connection.default DeauthorizeConnectionResponse
deauthorizeConnection
(DeauthorizeConnectionRequest deauthorizeConnectionRequest) Removes all authorization parameters from the connection.default DeleteApiDestinationResponse
deleteApiDestination
(Consumer<DeleteApiDestinationRequest.Builder> deleteApiDestinationRequest) Deletes the specified API destination.default DeleteApiDestinationResponse
deleteApiDestination
(DeleteApiDestinationRequest deleteApiDestinationRequest) Deletes the specified API destination.default DeleteArchiveResponse
deleteArchive
(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest) Deletes the specified archive.default DeleteArchiveResponse
deleteArchive
(DeleteArchiveRequest deleteArchiveRequest) Deletes the specified archive.default DeleteConnectionResponse
deleteConnection
(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest) Deletes a connection.default DeleteConnectionResponse
deleteConnection
(DeleteConnectionRequest deleteConnectionRequest) Deletes a connection.default DeleteEndpointResponse
deleteEndpoint
(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) Delete an existing global endpoint.default DeleteEndpointResponse
deleteEndpoint
(DeleteEndpointRequest deleteEndpointRequest) Delete an existing global endpoint.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 DescribeApiDestinationResponse
describeApiDestination
(Consumer<DescribeApiDestinationRequest.Builder> describeApiDestinationRequest) Retrieves details about an API destination.default DescribeApiDestinationResponse
describeApiDestination
(DescribeApiDestinationRequest describeApiDestinationRequest) Retrieves details about an API destination.default DescribeArchiveResponse
describeArchive
(Consumer<DescribeArchiveRequest.Builder> describeArchiveRequest) Retrieves details about an archive.default DescribeArchiveResponse
describeArchive
(DescribeArchiveRequest describeArchiveRequest) Retrieves details about an archive.default DescribeConnectionResponse
describeConnection
(Consumer<DescribeConnectionRequest.Builder> describeConnectionRequest) Retrieves details about a connection.default DescribeConnectionResponse
describeConnection
(DescribeConnectionRequest describeConnectionRequest) Retrieves details about a connection.default DescribeEndpointResponse
describeEndpoint
(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest) Get the information about an existing global endpoint.default DescribeEndpointResponse
describeEndpoint
(DescribeEndpointRequest describeEndpointRequest) Get the information about an existing global endpoint.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.describePartnerEventSource
(Consumer<DescribePartnerEventSourceRequest.Builder> describePartnerEventSourceRequest) An SaaS partner can use this operation to list details about a partner event source that they have created.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 ListApiDestinationsResponse
listApiDestinations
(Consumer<ListApiDestinationsRequest.Builder> listApiDestinationsRequest) Retrieves a list of API destination in the account in the current Region.default ListApiDestinationsResponse
listApiDestinations
(ListApiDestinationsRequest listApiDestinationsRequest) Retrieves a list of API destination in the account in the current Region.default ListArchivesResponse
listArchives
(Consumer<ListArchivesRequest.Builder> listArchivesRequest) Lists your archives.default ListArchivesResponse
listArchives
(ListArchivesRequest listArchivesRequest) Lists your archives.default ListConnectionsResponse
listConnections
(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest) Retrieves a list of connections from the account.default ListConnectionsResponse
listConnections
(ListConnectionsRequest listConnectionsRequest) Retrieves a list of connections from the account.default ListEndpointsResponse
listEndpoints
(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) List the global endpoints associated with this account.default ListEndpointsResponse
listEndpoints
(ListEndpointsRequest listEndpointsRequest) List the global endpoints associated with this account.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 Amazon Web Services account.default ListEventSourcesResponse
listEventSources
(ListEventSourcesRequest listEventSourcesRequest) You can use this to see all the partner event sources that have been shared with your Amazon Web Services account.listPartnerEventSourceAccounts
(Consumer<ListPartnerEventSourceAccountsRequest.Builder> listPartnerEventSourceAccountsRequest) An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with.listPartnerEventSourceAccounts
(ListPartnerEventSourceAccountsRequest listPartnerEventSourceAccountsRequest) An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with.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
(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) RunningPutPermission
permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus.default PutPermissionResponse
putPermission
(PutPermissionRequest putPermissionRequest) RunningPutPermission
permits the specified Amazon Web Services account or Amazon Web Services 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 Amazon Web Services account to be able to put events to the specified event bus.default RemovePermissionResponse
removePermission
(RemovePermissionRequest removePermissionRequest) Revokes the permission of another Amazon Web Services 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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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 UpdateApiDestinationResponse
updateApiDestination
(Consumer<UpdateApiDestinationRequest.Builder> updateApiDestinationRequest) Updates an API destination.default UpdateApiDestinationResponse
updateApiDestination
(UpdateApiDestinationRequest updateApiDestinationRequest) Updates an API destination.default UpdateArchiveResponse
updateArchive
(Consumer<UpdateArchiveRequest.Builder> updateArchiveRequest) Updates the specified archive.default UpdateArchiveResponse
updateArchive
(UpdateArchiveRequest updateArchiveRequest) Updates the specified archive.default UpdateConnectionResponse
updateConnection
(Consumer<UpdateConnectionRequest.Builder> updateConnectionRequest) Updates settings for a connection.default UpdateConnectionResponse
updateConnection
(UpdateConnectionRequest updateConnectionRequest) Updates settings for a connection.default UpdateEndpointResponse
updateEndpoint
(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest) Update an existing endpoint.default UpdateEndpointResponse
updateEndpoint
(UpdateEndpointRequest updateEndpointRequest) Update an existing endpoint.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
activateEventSource
default ActivateEventSourceResponse activateEventSource(ActivateEventSourceRequest activateEventSourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
- Parameters:
activateEventSourceRequest
-- Returns:
- Result of the ActivateEventSource operation returned by the service.
- See Also:
-
activateEventSource
default ActivateEventSourceResponse activateEventSource(Consumer<ActivateEventSourceRequest.Builder> activateEventSourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException 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 viaActivateEventSourceRequest.builder()
- Parameters:
activateEventSourceRequest
- AConsumer
that will call methods onActivateEventSourceRequest.Builder
to create a request.- Returns:
- Result of the ActivateEventSource operation returned by the service.
- See Also:
-
cancelReplay
default CancelReplayResponse cancelReplay(CancelReplayRequest cancelReplayRequest) throws ResourceNotFoundException, ConcurrentModificationException, IllegalStatusException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Cancels the specified replay.
- Parameters:
cancelReplayRequest
-- Returns:
- Result of the CancelReplay operation returned by the service.
- See Also:
-
cancelReplay
default CancelReplayResponse cancelReplay(Consumer<CancelReplayRequest.Builder> cancelReplayRequest) throws ResourceNotFoundException, ConcurrentModificationException, IllegalStatusException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Cancels the specified replay.
This is a convenience which creates an instance of the
CancelReplayRequest.Builder
avoiding the need to create one manually viaCancelReplayRequest.builder()
- Parameters:
cancelReplayRequest
- AConsumer
that will call methods onCancelReplayRequest.Builder
to create a request.- Returns:
- Result of the CancelReplay operation returned by the service.
- See Also:
-
createApiDestination
default CreateApiDestinationResponse createApiDestination(CreateApiDestinationRequest createApiDestinationRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
API destinations do not support private destinations, such as interface VPC endpoints.
For more information, see API destinations in the EventBridge User Guide.
- Parameters:
createApiDestinationRequest
-- Returns:
- Result of the CreateApiDestination operation returned by the service.
- See Also:
-
createApiDestination
default CreateApiDestinationResponse createApiDestination(Consumer<CreateApiDestinationRequest.Builder> createApiDestinationRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
API destinations do not support private destinations, such as interface VPC endpoints.
For more information, see API destinations in the EventBridge User Guide.
This is a convenience which creates an instance of the
CreateApiDestinationRequest.Builder
avoiding the need to create one manually viaCreateApiDestinationRequest.builder()
- Parameters:
createApiDestinationRequest
- AConsumer
that will call methods onCreateApiDestinationRequest.Builder
to create a request.- Returns:
- Result of the CreateApiDestination operation returned by the service.
- See Also:
-
createArchive
default CreateArchiveResponse createArchive(CreateArchiveRequest createArchiveRequest) throws ConcurrentModificationException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, EventBridgeException 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.
- Parameters:
createArchiveRequest
-- Returns:
- Result of the CreateArchive operation returned by the service.
- See Also:
-
createArchive
default CreateArchiveResponse createArchive(Consumer<CreateArchiveRequest.Builder> createArchiveRequest) throws ConcurrentModificationException, ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, EventBridgeException 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 viaCreateArchiveRequest.builder()
- Parameters:
createArchiveRequest
- AConsumer
that will call methods onCreateArchiveRequest.Builder
to create a request.- Returns:
- Result of the CreateArchive operation returned by the service.
- See Also:
-
createConnection
default CreateConnectionResponse createConnection(CreateConnectionRequest createConnectionRequest) throws ResourceAlreadyExistsException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
- Parameters:
createConnectionRequest
-- Returns:
- Result of the CreateConnection operation returned by the service.
- See Also:
-
createConnection
default CreateConnectionResponse createConnection(Consumer<CreateConnectionRequest.Builder> createConnectionRequest) throws ResourceAlreadyExistsException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
This is a convenience which creates an instance of the
CreateConnectionRequest.Builder
avoiding the need to create one manually viaCreateConnectionRequest.builder()
- Parameters:
createConnectionRequest
- AConsumer
that will call methods onCreateConnectionRequest.Builder
to create a request.- Returns:
- Result of the CreateConnection operation returned by the service.
- See Also:
-
createEndpoint
default CreateEndpointResponse createEndpoint(CreateEndpointRequest createEndpointRequest) throws ResourceAlreadyExistsException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.
- Parameters:
createEndpointRequest
-- Returns:
- Result of the CreateEndpoint operation returned by the service.
- See Also:
-
createEndpoint
default CreateEndpointResponse createEndpoint(Consumer<CreateEndpointRequest.Builder> createEndpointRequest) throws ResourceAlreadyExistsException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Creates a global endpoint. Global endpoints improve your application's availability by making it regional-fault tolerant. To do this, you define a primary and secondary Region with event buses in each Region. You also create a Amazon Route 53 health check that will tell EventBridge to route events to the secondary Region when an "unhealthy" state is encountered and events will be routed back to the primary Region when the health check reports a "healthy" state.
This is a convenience which creates an instance of the
CreateEndpointRequest.Builder
avoiding the need to create one manually viaCreateEndpointRequest.builder()
- Parameters:
createEndpointRequest
- AConsumer
that will call methods onCreateEndpointRequest.Builder
to create a request.- Returns:
- Result of the CreateEndpoint operation returned by the service.
- See Also:
-
createEventBus
default CreateEventBusResponse createEventBus(CreateEventBusRequest createEventBusRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, InvalidStateException, InternalException, ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException 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.
- Parameters:
createEventBusRequest
-- Returns:
- Result of the CreateEventBus operation returned by the service.
- See Also:
-
createEventBus
default CreateEventBusResponse createEventBus(Consumer<CreateEventBusRequest.Builder> createEventBusRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, InvalidStateException, InternalException, ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException 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 viaCreateEventBusRequest.builder()
- Parameters:
createEventBusRequest
- AConsumer
that will call methods onCreateEventBusRequest.Builder
to create a request.- Returns:
- Result of the CreateEventBus operation returned by the service.
- See Also:
-
createPartnerEventSource
default CreatePartnerEventSourceResponse createPartnerEventSource(CreatePartnerEventSourceRequest createPartnerEventSourceRequest) throws ResourceAlreadyExistsException, InternalException, ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.
Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types.
A partner event source creates events based on resources within the SaaS partner's service or application.
An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets.
Partner event source names follow this format:
partner_name/event_namespace/event_name
-
partner_name is determined during partner registration, and identifies the partner to Amazon Web Services customers.
-
event_namespace is determined by the partner, and is a way for the partner to categorize their events.
-
event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system.
The event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account.
The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.
- Parameters:
createPartnerEventSourceRequest
-- Returns:
- Result of the CreatePartnerEventSource operation returned by the service.
- See Also:
-
-
createPartnerEventSource
default CreatePartnerEventSourceResponse createPartnerEventSource(Consumer<CreatePartnerEventSourceRequest.Builder> createPartnerEventSourceRequest) throws ResourceAlreadyExistsException, InternalException, ConcurrentModificationException, LimitExceededException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException Called by an SaaS partner to create a partner event source. This operation is not used by Amazon Web Services customers.
Each partner event source can be used by one Amazon Web Services account to create a matching partner event bus in that Amazon Web Services account. A SaaS partner must create one partner event source for each Amazon Web Services account that wants to receive those event types.
A partner event source creates events based on resources within the SaaS partner's service or application.
An Amazon Web Services account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using Amazon Web Services Events rules and targets.
Partner event source names follow this format:
partner_name/event_namespace/event_name
-
partner_name is determined during partner registration, and identifies the partner to Amazon Web Services customers.
-
event_namespace is determined by the partner, and is a way for the partner to categorize their events.
-
event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system.
The event_name must be unique across all Amazon Web Services customers. This is because the event source is a shared resource between the partner and customer accounts, and each partner event source unique in the partner account.
The combination of event_namespace and event_name should help Amazon Web Services customers decide whether to create an event bus to receive these events.
This is a convenience which creates an instance of the
CreatePartnerEventSourceRequest.Builder
avoiding the need to create one manually viaCreatePartnerEventSourceRequest.builder()
- Parameters:
createPartnerEventSourceRequest
- AConsumer
that will call methods onCreatePartnerEventSourceRequest.Builder
to create a request.- Returns:
- Result of the CreatePartnerEventSource operation returned by the service.
- See Also:
-
-
deactivateEventSource
default DeactivateEventSourceResponse deactivateEventSource(DeactivateEventSourceRequest deactivateEventSourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException 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.
- Parameters:
deactivateEventSourceRequest
-- Returns:
- Result of the DeactivateEventSource operation returned by the service.
- See Also:
-
deactivateEventSource
default DeactivateEventSourceResponse deactivateEventSource(Consumer<DeactivateEventSourceRequest.Builder> deactivateEventSourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InvalidStateException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException 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 viaDeactivateEventSourceRequest.builder()
- Parameters:
deactivateEventSourceRequest
- AConsumer
that will call methods onDeactivateEventSourceRequest.Builder
to create a request.- Returns:
- Result of the DeactivateEventSource operation returned by the service.
- See Also:
-
deauthorizeConnection
default DeauthorizeConnectionResponse deauthorizeConnection(DeauthorizeConnectionRequest deauthorizeConnectionRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.
- Parameters:
deauthorizeConnectionRequest
-- Returns:
- Result of the DeauthorizeConnection operation returned by the service.
- See Also:
-
deauthorizeConnection
default DeauthorizeConnectionResponse deauthorizeConnection(Consumer<DeauthorizeConnectionRequest.Builder> deauthorizeConnectionRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Removes all authorization parameters from the connection. This lets you remove the secret from the connection so you can reuse it without having to create a new connection.
This is a convenience which creates an instance of the
DeauthorizeConnectionRequest.Builder
avoiding the need to create one manually viaDeauthorizeConnectionRequest.builder()
- Parameters:
deauthorizeConnectionRequest
- AConsumer
that will call methods onDeauthorizeConnectionRequest.Builder
to create a request.- Returns:
- Result of the DeauthorizeConnection operation returned by the service.
- See Also:
-
deleteApiDestination
default DeleteApiDestinationResponse deleteApiDestination(DeleteApiDestinationRequest deleteApiDestinationRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Deletes the specified API destination.
- Parameters:
deleteApiDestinationRequest
-- Returns:
- Result of the DeleteApiDestination operation returned by the service.
- See Also:
-
deleteApiDestination
default DeleteApiDestinationResponse deleteApiDestination(Consumer<DeleteApiDestinationRequest.Builder> deleteApiDestinationRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Deletes the specified API destination.
This is a convenience which creates an instance of the
DeleteApiDestinationRequest.Builder
avoiding the need to create one manually viaDeleteApiDestinationRequest.builder()
- Parameters:
deleteApiDestinationRequest
- AConsumer
that will call methods onDeleteApiDestinationRequest.Builder
to create a request.- Returns:
- Result of the DeleteApiDestination operation returned by the service.
- See Also:
-
deleteArchive
default DeleteArchiveResponse deleteArchive(DeleteArchiveRequest deleteArchiveRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Deletes the specified archive.
- Parameters:
deleteArchiveRequest
-- Returns:
- Result of the DeleteArchive operation returned by the service.
- See Also:
-
deleteArchive
default DeleteArchiveResponse deleteArchive(Consumer<DeleteArchiveRequest.Builder> deleteArchiveRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Deletes the specified archive.
This is a convenience which creates an instance of the
DeleteArchiveRequest.Builder
avoiding the need to create one manually viaDeleteArchiveRequest.builder()
- Parameters:
deleteArchiveRequest
- AConsumer
that will call methods onDeleteArchiveRequest.Builder
to create a request.- Returns:
- Result of the DeleteArchive operation returned by the service.
- See Also:
-
deleteConnection
default DeleteConnectionResponse deleteConnection(DeleteConnectionRequest deleteConnectionRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Deletes a connection.
- Parameters:
deleteConnectionRequest
-- Returns:
- Result of the DeleteConnection operation returned by the service.
- See Also:
-
deleteConnection
default DeleteConnectionResponse deleteConnection(Consumer<DeleteConnectionRequest.Builder> deleteConnectionRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Deletes a connection.
This is a convenience which creates an instance of the
DeleteConnectionRequest.Builder
avoiding the need to create one manually viaDeleteConnectionRequest.builder()
- Parameters:
deleteConnectionRequest
- AConsumer
that will call methods onDeleteConnectionRequest.Builder
to create a request.- Returns:
- Result of the DeleteConnection operation returned by the service.
- See Also:
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(DeleteEndpointRequest deleteEndpointRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
- Parameters:
deleteEndpointRequest
-- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
deleteEndpoint
default DeleteEndpointResponse deleteEndpoint(Consumer<DeleteEndpointRequest.Builder> deleteEndpointRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Delete an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
This is a convenience which creates an instance of the
DeleteEndpointRequest.Builder
avoiding the need to create one manually viaDeleteEndpointRequest.builder()
- Parameters:
deleteEndpointRequest
- AConsumer
that will call methods onDeleteEndpointRequest.Builder
to create a request.- Returns:
- Result of the DeleteEndpoint operation returned by the service.
- See Also:
-
deleteEventBus
default DeleteEventBusResponse deleteEventBus(DeleteEventBusRequest deleteEventBusRequest) throws InternalException, ConcurrentModificationException, AwsServiceException, SdkClientException, EventBridgeException 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.
- Parameters:
deleteEventBusRequest
-- Returns:
- Result of the DeleteEventBus operation returned by the service.
- See Also:
-
deleteEventBus
default DeleteEventBusResponse deleteEventBus(Consumer<DeleteEventBusRequest.Builder> deleteEventBusRequest) throws InternalException, ConcurrentModificationException, AwsServiceException, SdkClientException, EventBridgeException 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 viaDeleteEventBusRequest.builder()
- Parameters:
deleteEventBusRequest
- AConsumer
that will call methods onDeleteEventBusRequest.Builder
to create a request.- Returns:
- Result of the DeleteEventBus operation returned by the service.
- See Also:
-
deletePartnerEventSource
default DeletePartnerEventSourceResponse deletePartnerEventSource(DeletePartnerEventSourceRequest deletePartnerEventSourceRequest) throws InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers.
When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.
- Parameters:
deletePartnerEventSourceRequest
-- Returns:
- Result of the DeletePartnerEventSource operation returned by the service.
- See Also:
-
deletePartnerEventSource
default DeletePartnerEventSourceResponse deletePartnerEventSource(Consumer<DeletePartnerEventSourceRequest.Builder> deletePartnerEventSourceRequest) throws InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException This operation is used by SaaS partners to delete a partner event source. This operation is not used by Amazon Web Services customers.
When you delete an event source, the status of the corresponding partner event bus in the Amazon Web Services customer account becomes DELETED.
This is a convenience which creates an instance of the
DeletePartnerEventSourceRequest.Builder
avoiding the need to create one manually viaDeletePartnerEventSourceRequest.builder()
- Parameters:
deletePartnerEventSourceRequest
- AConsumer
that will call methods onDeletePartnerEventSourceRequest.Builder
to create a request.- Returns:
- Result of the DeletePartnerEventSource operation returned by the service.
- See Also:
-
deleteRule
default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest) throws ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus,
ResourceNotFoundException
is returned.Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the
Force
option, but you should do so only if you are sure the other service is not still using that rule.- Parameters:
deleteRuleRequest
-- Returns:
- Result of the DeleteRule operation returned by the service.
- See Also:
-
deleteRule
default DeleteRuleResponse deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) throws ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
If you call delete rule multiple times for the same rule, all calls will succeed. When you call delete rule for a non-existent custom eventbus,
ResourceNotFoundException
is returned.Managed rules are rules created and managed by another Amazon Web Services service on your behalf. These rules are created by those other Amazon Web Services services to support functionality in those services. You can delete these rules using the
Force
option, but you should do so only if you are sure the other service is not still using that rule.
This is a convenience which creates an instance of the
DeleteRuleRequest.Builder
avoiding the need to create one manually viaDeleteRuleRequest.builder()
- Parameters:
deleteRuleRequest
- AConsumer
that will call methods onDeleteRuleRequest.Builder
to create a request.- Returns:
- Result of the DeleteRule operation returned by the service.
- See Also:
-
describeApiDestination
default DescribeApiDestinationResponse describeApiDestination(DescribeApiDestinationRequest describeApiDestinationRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves details about an API destination.
- Parameters:
describeApiDestinationRequest
-- Returns:
- Result of the DescribeApiDestination operation returned by the service.
- See Also:
-
describeApiDestination
default DescribeApiDestinationResponse describeApiDestination(Consumer<DescribeApiDestinationRequest.Builder> describeApiDestinationRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves details about an API destination.
This is a convenience which creates an instance of the
DescribeApiDestinationRequest.Builder
avoiding the need to create one manually viaDescribeApiDestinationRequest.builder()
- Parameters:
describeApiDestinationRequest
- AConsumer
that will call methods onDescribeApiDestinationRequest.Builder
to create a request.- Returns:
- Result of the DescribeApiDestination operation returned by the service.
- See Also:
-
describeArchive
default DescribeArchiveResponse describeArchive(DescribeArchiveRequest describeArchiveRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves details about an archive.
- Parameters:
describeArchiveRequest
-- Returns:
- Result of the DescribeArchive operation returned by the service.
- See Also:
-
describeArchive
default DescribeArchiveResponse describeArchive(Consumer<DescribeArchiveRequest.Builder> describeArchiveRequest) throws ResourceAlreadyExistsException, ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves details about an archive.
This is a convenience which creates an instance of the
DescribeArchiveRequest.Builder
avoiding the need to create one manually viaDescribeArchiveRequest.builder()
- Parameters:
describeArchiveRequest
- AConsumer
that will call methods onDescribeArchiveRequest.Builder
to create a request.- Returns:
- Result of the DescribeArchive operation returned by the service.
- See Also:
-
describeConnection
default DescribeConnectionResponse describeConnection(DescribeConnectionRequest describeConnectionRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves details about a connection.
- Parameters:
describeConnectionRequest
-- Returns:
- Result of the DescribeConnection operation returned by the service.
- See Also:
-
describeConnection
default DescribeConnectionResponse describeConnection(Consumer<DescribeConnectionRequest.Builder> describeConnectionRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves details about a connection.
This is a convenience which creates an instance of the
DescribeConnectionRequest.Builder
avoiding the need to create one manually viaDescribeConnectionRequest.builder()
- Parameters:
describeConnectionRequest
- AConsumer
that will call methods onDescribeConnectionRequest.Builder
to create a request.- Returns:
- Result of the DescribeConnection operation returned by the service.
- See Also:
-
describeEndpoint
default DescribeEndpointResponse describeEndpoint(DescribeEndpointRequest describeEndpointRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
- Parameters:
describeEndpointRequest
-- Returns:
- Result of the DescribeEndpoint operation returned by the service.
- See Also:
-
describeEndpoint
default DescribeEndpointResponse describeEndpoint(Consumer<DescribeEndpointRequest.Builder> describeEndpointRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Get the information about an existing global endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
This is a convenience which creates an instance of the
DescribeEndpointRequest.Builder
avoiding the need to create one manually viaDescribeEndpointRequest.builder()
- Parameters:
describeEndpointRequest
- AConsumer
that will call methods onDescribeEndpointRequest.Builder
to create a request.- Returns:
- Result of the DescribeEndpoint operation returned by the service.
- See Also:
-
describeEventBus
default DescribeEventBusResponse describeEventBus(DescribeEventBusRequest describeEventBusRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.
To enable your account to receive events from other accounts on its default event bus, use PutPermission.
For more information about partner event buses, see CreateEventBus.
- Parameters:
describeEventBusRequest
-- Returns:
- Result of the DescribeEventBus operation returned by the service.
- See Also:
-
describeEventBus
default DescribeEventBusResponse describeEventBus(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Displays details about an event bus in your account. This can include the external Amazon Web Services accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.
To enable your account to receive events from other accounts on its default event bus, use PutPermission.
For more information about partner event buses, see CreateEventBus.
This is a convenience which creates an instance of the
DescribeEventBusRequest.Builder
avoiding the need to create one manually viaDescribeEventBusRequest.builder()
- Parameters:
describeEventBusRequest
- AConsumer
that will call methods onDescribeEventBusRequest.Builder
to create a request.- Returns:
- Result of the DescribeEventBus operation returned by the service.
- See Also:
-
describeEventSource
default DescribeEventSourceResponse describeEventSource(DescribeEventSourceRequest describeEventSourceRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException This operation lists details about a partner event source that is shared with your account.
- Parameters:
describeEventSourceRequest
-- Returns:
- Result of the DescribeEventSource operation returned by the service.
- See Also:
-
describeEventSource
default DescribeEventSourceResponse describeEventSource(Consumer<DescribeEventSourceRequest.Builder> describeEventSourceRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException 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 viaDescribeEventSourceRequest.builder()
- Parameters:
describeEventSourceRequest
- AConsumer
that will call methods onDescribeEventSourceRequest.Builder
to create a request.- Returns:
- Result of the DescribeEventSource operation returned by the service.
- See Also:
-
describePartnerEventSource
default DescribePartnerEventSourceResponse describePartnerEventSource(DescribePartnerEventSourceRequest describePartnerEventSourceRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.
- Parameters:
describePartnerEventSourceRequest
-- Returns:
- Result of the DescribePartnerEventSource operation returned by the service.
- See Also:
-
describePartnerEventSource
default DescribePartnerEventSourceResponse describePartnerEventSource(Consumer<DescribePartnerEventSourceRequest.Builder> describePartnerEventSourceRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException An SaaS partner can use this operation to list details about a partner event source that they have created. Amazon Web Services customers do not use this operation. Instead, Amazon Web Services customers can use DescribeEventSource to see details about a partner event source that is shared with them.
This is a convenience which creates an instance of the
DescribePartnerEventSourceRequest.Builder
avoiding the need to create one manually viaDescribePartnerEventSourceRequest.builder()
- Parameters:
describePartnerEventSourceRequest
- AConsumer
that will call methods onDescribePartnerEventSourceRequest.Builder
to create a request.- Returns:
- Result of the DescribePartnerEventSource operation returned by the service.
- See Also:
-
describeReplay
default DescribeReplayResponse describeReplay(DescribeReplayRequest describeReplayRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 useStartReplay
and specify anEventStartTime
and anEventEndTime
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 useDescribeReplay
to determine the progress of a replay. The value returned forEventLastReplayedTime
indicates the time within the specified time range associated with the last event replayed.- Parameters:
describeReplayRequest
-- Returns:
- Result of the DescribeReplay operation returned by the service.
- See Also:
-
describeReplay
default DescribeReplayResponse describeReplay(Consumer<DescribeReplayRequest.Builder> describeReplayRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 useStartReplay
and specify anEventStartTime
and anEventEndTime
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 useDescribeReplay
to determine the progress of a replay. The value returned forEventLastReplayedTime
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 viaDescribeReplayRequest.builder()
- Parameters:
describeReplayRequest
- AConsumer
that will call methods onDescribeReplayRequest.Builder
to create a request.- Returns:
- Result of the DescribeReplay operation returned by the service.
- See Also:
-
describeRule
default DescribeRuleResponse describeRule(DescribeRuleRequest describeRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Describes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
- Parameters:
describeRuleRequest
-- Returns:
- Result of the DescribeRule operation returned by the service.
- See Also:
-
describeRule
default DescribeRuleResponse describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 viaDescribeRuleRequest.builder()
- Parameters:
describeRuleRequest
- AConsumer
that will call methods onDescribeRuleRequest.Builder
to create a request.- Returns:
- Result of the DescribeRule operation returned by the service.
- See Also:
-
disableRule
default DisableRuleResponse disableRule(DisableRuleRequest disableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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.
- Parameters:
disableRuleRequest
-- Returns:
- Result of the DisableRule operation returned by the service.
- See Also:
-
disableRule
default DisableRuleResponse disableRule(Consumer<DisableRuleRequest.Builder> disableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 viaDisableRuleRequest.builder()
- Parameters:
disableRuleRequest
- AConsumer
that will call methods onDisableRuleRequest.Builder
to create a request.- Returns:
- Result of the DisableRule operation returned by the service.
- See Also:
-
enableRule
default EnableRuleResponse enableRule(EnableRuleRequest enableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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.
- Parameters:
enableRuleRequest
-- Returns:
- Result of the EnableRule operation returned by the service.
- See Also:
-
enableRule
default EnableRuleResponse enableRule(Consumer<EnableRuleRequest.Builder> enableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 viaEnableRuleRequest.builder()
- Parameters:
enableRuleRequest
- AConsumer
that will call methods onEnableRuleRequest.Builder
to create a request.- Returns:
- Result of the EnableRule operation returned by the service.
- See Also:
-
listApiDestinations
default ListApiDestinationsResponse listApiDestinations(ListApiDestinationsRequest listApiDestinationsRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves a list of API destination in the account in the current Region.
- Parameters:
listApiDestinationsRequest
-- Returns:
- Result of the ListApiDestinations operation returned by the service.
- See Also:
-
listApiDestinations
default ListApiDestinationsResponse listApiDestinations(Consumer<ListApiDestinationsRequest.Builder> listApiDestinationsRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves a list of API destination in the account in the current Region.
This is a convenience which creates an instance of the
ListApiDestinationsRequest.Builder
avoiding the need to create one manually viaListApiDestinationsRequest.builder()
- Parameters:
listApiDestinationsRequest
- AConsumer
that will call methods onListApiDestinationsRequest.Builder
to create a request.- Returns:
- Result of the ListApiDestinations operation returned by the service.
- See Also:
-
listArchives
default ListArchivesResponse listArchives(ListArchivesRequest listArchivesRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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.
- Parameters:
listArchivesRequest
-- Returns:
- Result of the ListArchives operation returned by the service.
- See Also:
-
listArchives
default ListArchivesResponse listArchives(Consumer<ListArchivesRequest.Builder> listArchivesRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 viaListArchivesRequest.builder()
- Parameters:
listArchivesRequest
- AConsumer
that will call methods onListArchivesRequest.Builder
to create a request.- Returns:
- Result of the ListArchives operation returned by the service.
- See Also:
-
listConnections
default ListConnectionsResponse listConnections(ListConnectionsRequest listConnectionsRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves a list of connections from the account.
- Parameters:
listConnectionsRequest
-- Returns:
- Result of the ListConnections operation returned by the service.
- See Also:
-
listConnections
default ListConnectionsResponse listConnections(Consumer<ListConnectionsRequest.Builder> listConnectionsRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException Retrieves a list of connections from the account.
This is a convenience which creates an instance of the
ListConnectionsRequest.Builder
avoiding the need to create one manually viaListConnectionsRequest.builder()
- Parameters:
listConnectionsRequest
- AConsumer
that will call methods onListConnectionsRequest.Builder
to create a request.- Returns:
- Result of the ListConnections operation returned by the service.
- See Also:
-
listEndpoints
default ListEndpointsResponse listEndpoints(ListEndpointsRequest listEndpointsRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
- Parameters:
listEndpointsRequest
-- Returns:
- Result of the ListEndpoints operation returned by the service.
- See Also:
-
listEndpoints
default ListEndpointsResponse listEndpoints(Consumer<ListEndpointsRequest.Builder> listEndpointsRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException List the global endpoints associated with this account. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
This is a convenience which creates an instance of the
ListEndpointsRequest.Builder
avoiding the need to create one manually viaListEndpointsRequest.builder()
- Parameters:
listEndpointsRequest
- AConsumer
that will call methods onListEndpointsRequest.Builder
to create a request.- Returns:
- Result of the ListEndpoints operation returned by the service.
- See Also:
-
listEventBuses
default ListEventBusesResponse listEventBuses(ListEventBusesRequest listEventBusesRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
- Parameters:
listEventBusesRequest
-- Returns:
- Result of the ListEventBuses operation returned by the service.
- See Also:
-
listEventBuses
default ListEventBusesResponse listEventBuses(Consumer<ListEventBusesRequest.Builder> listEventBusesRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 viaListEventBusesRequest.builder()
- Parameters:
listEventBusesRequest
- AConsumer
that will call methods onListEventBusesRequest.Builder
to create a request.- Returns:
- Result of the ListEventBuses operation returned by the service.
- See Also:
-
listEventSources
default ListEventSourcesResponse listEventSources(ListEventSourcesRequest listEventSourcesRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.
- Parameters:
listEventSourcesRequest
-- Returns:
- Result of the ListEventSources operation returned by the service.
- See Also:
-
listEventSources
default ListEventSourcesResponse listEventSources(Consumer<ListEventSourcesRequest.Builder> listEventSourcesRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException You can use this to see all the partner event sources that have been shared with your Amazon Web Services account. For more information about partner event sources, see CreateEventBus.
This is a convenience which creates an instance of the
ListEventSourcesRequest.Builder
avoiding the need to create one manually viaListEventSourcesRequest.builder()
- Parameters:
listEventSourcesRequest
- AConsumer
that will call methods onListEventSourcesRequest.Builder
to create a request.- Returns:
- Result of the ListEventSources operation returned by the service.
- See Also:
-
listPartnerEventSourceAccounts
default ListPartnerEventSourceAccountsResponse listPartnerEventSourceAccounts(ListPartnerEventSourceAccountsRequest listPartnerEventSourceAccountsRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.
- Parameters:
listPartnerEventSourceAccountsRequest
-- Returns:
- Result of the ListPartnerEventSourceAccounts operation returned by the service.
- See Also:
-
listPartnerEventSourceAccounts
default ListPartnerEventSourceAccountsResponse listPartnerEventSourceAccounts(Consumer<ListPartnerEventSourceAccountsRequest.Builder> listPartnerEventSourceAccountsRequest) throws ResourceNotFoundException, InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException An SaaS partner can use this operation to display the Amazon Web Services account ID that a particular partner event source name is associated with. This operation is not used by Amazon Web Services customers.
This is a convenience which creates an instance of the
ListPartnerEventSourceAccountsRequest.Builder
avoiding the need to create one manually viaListPartnerEventSourceAccountsRequest.builder()
- Parameters:
listPartnerEventSourceAccountsRequest
- AConsumer
that will call methods onListPartnerEventSourceAccountsRequest.Builder
to create a request.- Returns:
- Result of the ListPartnerEventSourceAccounts operation returned by the service.
- See Also:
-
listPartnerEventSources
default ListPartnerEventSourcesResponse listPartnerEventSources(ListPartnerEventSourcesRequest listPartnerEventSourcesRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.
- Parameters:
listPartnerEventSourcesRequest
-- Returns:
- Result of the ListPartnerEventSources operation returned by the service.
- See Also:
-
listPartnerEventSources
default ListPartnerEventSourcesResponse listPartnerEventSources(Consumer<ListPartnerEventSourcesRequest.Builder> listPartnerEventSourcesRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by Amazon Web Services customers.
This is a convenience which creates an instance of the
ListPartnerEventSourcesRequest.Builder
avoiding the need to create one manually viaListPartnerEventSourcesRequest.builder()
- Parameters:
listPartnerEventSourcesRequest
- AConsumer
that will call methods onListPartnerEventSourcesRequest.Builder
to create a request.- Returns:
- Result of the ListPartnerEventSources operation returned by the service.
- See Also:
-
listReplays
default ListReplaysResponse listReplays(ListReplaysRequest listReplaysRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException 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.
- Parameters:
listReplaysRequest
-- Returns:
- Result of the ListReplays operation returned by the service.
- See Also:
-
listReplays
default ListReplaysResponse listReplays(Consumer<ListReplaysRequest.Builder> listReplaysRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 viaListReplaysRequest.builder()
- Parameters:
listReplaysRequest
- AConsumer
that will call methods onListReplaysRequest.Builder
to create a request.- Returns:
- Result of the ListReplays operation returned by the service.
- See Also:
-
listRuleNamesByTarget
default ListRuleNamesByTargetResponse listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest) throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.
The maximum number of results per page for requests is 100.
- Parameters:
listRuleNamesByTargetRequest
-- Returns:
- Result of the ListRuleNamesByTarget operation returned by the service.
- See Also:
-
listRuleNamesByTarget
default ListRuleNamesByTargetResponse listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> listRuleNamesByTargetRequest) throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException Lists the rules for the specified target. You can see which of the rules in Amazon EventBridge can invoke a specific target in your account.
The maximum number of results per page for requests is 100.
This is a convenience which creates an instance of the
ListRuleNamesByTargetRequest.Builder
avoiding the need to create one manually viaListRuleNamesByTargetRequest.builder()
- Parameters:
listRuleNamesByTargetRequest
- AConsumer
that will call methods onListRuleNamesByTargetRequest.Builder
to create a request.- Returns:
- Result of the ListRuleNamesByTarget operation returned by the service.
- See Also:
-
listRules
default ListRulesResponse listRules(ListRulesRequest listRulesRequest) throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.
The maximum number of results per page for requests is 100.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
- Parameters:
listRulesRequest
-- Returns:
- Result of the ListRules operation returned by the service.
- See Also:
-
listRules
default ListRulesResponse listRules(Consumer<ListRulesRequest.Builder> listRulesRequest) throws InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.
The maximum number of results per page for requests is 100.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
This is a convenience which creates an instance of the
ListRulesRequest.Builder
avoiding the need to create one manually viaListRulesRequest.builder()
- Parameters:
listRulesRequest
- AConsumer
that will call methods onListRulesRequest.Builder
to create a request.- Returns:
- Result of the ListRules operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTargetsByRule
default ListTargetsByRuleResponse listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Lists the targets assigned to the specified rule.
The maximum number of results per page for requests is 100.
- Parameters:
listTargetsByRuleRequest
-- Returns:
- Result of the ListTargetsByRule operation returned by the service.
- See Also:
-
listTargetsByRule
default ListTargetsByRuleResponse listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Lists the targets assigned to the specified rule.
The maximum number of results per page for requests is 100.
This is a convenience which creates an instance of the
ListTargetsByRuleRequest.Builder
avoiding the need to create one manually viaListTargetsByRuleRequest.builder()
- Parameters:
listTargetsByRuleRequest
- AConsumer
that will call methods onListTargetsByRuleRequest.Builder
to create a request.- Returns:
- Result of the ListTargetsByRule operation returned by the service.
- See Also:
-
putEvents
default PutEventsResponse putEvents(PutEventsRequest putEventsRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException Sends custom events to Amazon EventBridge so that they can be matched to rules.
The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event. To learn more, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide
PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.
PutEvents will only process nested JSON up to 1100 levels deep.
- Parameters:
putEventsRequest
-- Returns:
- Result of the PutEvents operation returned by the service.
- See Also:
-
putEvents
default PutEventsResponse putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest) throws InternalException, AwsServiceException, SdkClientException, EventBridgeException Sends custom events to Amazon EventBridge so that they can be matched to rules.
The maximum size for a PutEvents event entry is 256 KB. Entry size is calculated including the event and any necessary characters and keys of the JSON representation of the event. To learn more, see Calculating PutEvents event entry size in the Amazon EventBridge User Guide
PutEvents accepts the data in JSON format. For the JSON number (integer) data type, the constraints are: a minimum value of -9,223,372,036,854,775,808 and a maximum value of 9,223,372,036,854,775,807.
PutEvents will only process nested JSON up to 1100 levels deep.
This is a convenience which creates an instance of the
PutEventsRequest.Builder
avoiding the need to create one manually viaPutEventsRequest.builder()
- Parameters:
putEventsRequest
- AConsumer
that will call methods onPutEventsRequest.Builder
to create a request.- Returns:
- Result of the PutEvents operation returned by the service.
- See Also:
-
putPartnerEvents
default PutPartnerEventsResponse putPartnerEvents(PutPartnerEventsRequest putPartnerEventsRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
For information on calculating event batch size, see Calculating EventBridge PutEvents event entry size in the EventBridge User Guide.
- Parameters:
putPartnerEventsRequest
-- Returns:
- Result of the PutPartnerEvents operation returned by the service.
- See Also:
-
putPartnerEvents
default PutPartnerEventsResponse putPartnerEvents(Consumer<PutPartnerEventsRequest.Builder> putPartnerEventsRequest) throws InternalException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException This is used by SaaS partners to write events to a customer's partner event bus. Amazon Web Services customers do not use this operation.
For information on calculating event batch size, see Calculating EventBridge PutEvents event entry size in the EventBridge User Guide.
This is a convenience which creates an instance of the
PutPartnerEventsRequest.Builder
avoiding the need to create one manually viaPutPartnerEventsRequest.builder()
- Parameters:
putPartnerEventsRequest
- AConsumer
that will call methods onPutPartnerEventsRequest.Builder
to create a request.- Returns:
- Result of the PutPartnerEvents operation returned by the service.
- See Also:
-
putPermission
default PutPermissionResponse putPermission(PutPermissionRequest putPermissionRequest) throws ResourceNotFoundException, PolicyLengthExceededException, InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException Running
PutPermission
permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
To enable multiple Amazon Web Services accounts to put events to your event bus, run
PutPermission
once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can runPutPermission
once specifyingPrincipal
as "*" and specifying the Amazon Web Services organization ID inCondition
, 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 usePutTarget
to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.The permission policy on the event bus cannot exceed 10 KB in size.
- Parameters:
putPermissionRequest
-- Returns:
- Result of the PutPermission operation returned by the service.
- See Also:
-
putPermission
default PutPermissionResponse putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest) throws ResourceNotFoundException, PolicyLengthExceededException, InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException Running
PutPermission
permits the specified Amazon Web Services account or Amazon Web Services organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
To enable multiple Amazon Web Services accounts to put events to your event bus, run
PutPermission
once for each of these accounts. Or, if all the accounts are members of the same Amazon Web Services organization, you can runPutPermission
once specifyingPrincipal
as "*" and specifying the Amazon Web Services organization ID inCondition
, 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 usePutTarget
to add your account's event bus as a target. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.The permission policy on the event bus cannot exceed 10 KB in size.
This is a convenience which creates an instance of the
PutPermissionRequest.Builder
avoiding the need to create one manually viaPutPermissionRequest.builder()
- Parameters:
putPermissionRequest
- AConsumer
that will call methods onPutPermissionRequest.Builder
to create a request.- Returns:
- Result of the PutPermission operation returned by the service.
- See Also:
-
putRule
default PutRuleResponse putRule(PutRuleRequest putRuleRequest) throws InvalidEventPatternException, LimitExceededException, ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.
A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.
If you are updating an existing rule, the rule is replaced with what you specify in this
PutRule
command. If you omit arguments inPutRule
, 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 theevents:PutRule
andevents:TagResource
permissions.If you are updating an existing rule, any tags you specify in the
PutRule
operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
- Parameters:
putRuleRequest
-- Returns:
- Result of the PutRule operation returned by the service.
- See Also:
-
putRule
default PutRuleResponse putRule(Consumer<PutRuleRequest.Builder> putRuleRequest) throws InvalidEventPatternException, LimitExceededException, ConcurrentModificationException, ManagedRuleException, InternalException, ResourceNotFoundException, AwsServiceException, SdkClientException, EventBridgeException Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.
A single rule watches for events from a single event bus. Events generated by Amazon Web Services services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.
If you are updating an existing rule, the rule is replaced with what you specify in this
PutRule
command. If you omit arguments inPutRule
, 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 theevents:PutRule
andevents:TagResource
permissions.If you are updating an existing rule, any tags you specify in the
PutRule
operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
This is a convenience which creates an instance of the
PutRuleRequest.Builder
avoiding the need to create one manually viaPutRuleRequest.builder()
- Parameters:
putRuleRequest
- AConsumer
that will call methods onPutRuleRequest.Builder
to create a request.- Returns:
- Result of the PutRule operation returned by the service.
- See Also:
-
putTargets
default PutTargetsResponse putTargets(PutTargetsRequest putTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, LimitExceededException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
The maximum number of entries per request is 10.
Each rule can have up to five (5) targets associated with it at one time.
For a list of services you can configure as targets for events, see EventBridge targets in the Amazon EventBridge User Guide.
Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are:
-
Amazon EBS CreateSnapshot API call
-
Amazon EC2 RebootInstances API call
-
Amazon EC2 StopInstances API call
-
Amazon EC2 TerminateInstances API call
For some target types,
PutTargets
provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using theKinesisParameters
argument. To invoke a command on multiple EC2 instances with one rule, you can use theRunCommandParameters
field.To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:
-
For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
-
For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the
RoleARN
argument inPutTargets
.
For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.
If another Amazon Web Services account is in the same region and has granted you permission (using
PutPermission
), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as theArn
value when you runPutTargets
. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing.Input
,InputPath
, andInputTransformer
are not available withPutTarget
if the target is an event bus of a different Amazon Web Services account.If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a
RoleArn
with proper permissions in theTarget
structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.If you have an IAM role on a cross-account event bus target, a
PutTargets
call without a role on the same target (sameId
andArn
) will not remove the role.For more information about enabling cross-account events, see PutPermission.
Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
-
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
-
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
-
If InputPath is specified in the form of JSONPath (for example,
invalid input: '$'.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
orInputTransformer
, 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 inFailedEntries
provides the ID of the failed target and the error code.- Parameters:
putTargetsRequest
-- Returns:
- Result of the PutTargets operation returned by the service.
- See Also:
-
-
putTargets
default PutTargetsResponse putTargets(Consumer<PutTargetsRequest.Builder> putTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, LimitExceededException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
The maximum number of entries per request is 10.
Each rule can have up to five (5) targets associated with it at one time.
For a list of services you can configure as targets for events, see EventBridge targets in the Amazon EventBridge User Guide.
Creating rules with built-in targets is supported only in the Amazon Web Services Management Console. The built-in targets are:
-
Amazon EBS CreateSnapshot API call
-
Amazon EC2 RebootInstances API call
-
Amazon EC2 StopInstances API call
-
Amazon EC2 TerminateInstances API call
For some target types,
PutTargets
provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using theKinesisParameters
argument. To invoke a command on multiple EC2 instances with one rule, you can use theRunCommandParameters
field.To be able to make API calls against the resources that you own, Amazon EventBridge needs the appropriate permissions:
-
For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies.
-
For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway APIs, EventBridge relies on IAM roles that you specify in the
RoleARN
argument inPutTargets
.
For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.
If another Amazon Web Services account is in the same region and has granted you permission (using
PutPermission
), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as theArn
value when you runPutTargets
. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge Pricing.Input
,InputPath
, andInputTransformer
are not available withPutTarget
if the target is an event bus of a different Amazon Web Services account.If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a
RoleArn
with proper permissions in theTarget
structure. For more information, see Sending and Receiving Events Between Amazon Web Services Accounts in the Amazon EventBridge User Guide.If you have an IAM role on a cross-account event bus target, a
PutTargets
call without a role on the same target (sameId
andArn
) will not remove the role.For more information about enabling cross-account events, see PutPermission.
Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
-
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
-
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
-
If InputPath is specified in the form of JSONPath (for example,
invalid input: '$'.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
orInputTransformer
, 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 inFailedEntries
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 viaPutTargetsRequest.builder()
- Parameters:
putTargetsRequest
- AConsumer
that will call methods onPutTargetsRequest.Builder
to create a request.- Returns:
- Result of the PutTargets operation returned by the service.
- See Also:
-
-
removePermission
default RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the
StatementId
value that you associated with the account when you granted it permission withPutPermission
. You can find theStatementId
by using DescribeEventBus .- Parameters:
removePermissionRequest
-- Returns:
- Result of the RemovePermission operation returned by the service.
- See Also:
-
removePermission
default RemovePermissionResponse removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, OperationDisabledException, AwsServiceException, SdkClientException, EventBridgeException Revokes the permission of another Amazon Web Services account to be able to put events to the specified event bus. Specify the account to revoke by the
StatementId
value that you associated with the account when you granted it permission withPutPermission
. You can find theStatementId
by using DescribeEventBus .
This is a convenience which creates an instance of the
RemovePermissionRequest.Builder
avoiding the need to create one manually viaRemovePermissionRequest.builder()
- Parameters:
removePermissionRequest
- AConsumer
that will call methods onRemovePermissionRequest.Builder
to create a request.- Returns:
- Result of the RemovePermission operation returned by the service.
- See Also:
-
removeTargets
default RemoveTargetsResponse removeTargets(RemoveTargetsRequest removeTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
A successful execution of
RemoveTargets
doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.
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 inFailedEntries
provides the ID of the failed target and the error code.The maximum number of entries per request is 10.
- Parameters:
removeTargetsRequest
-- Returns:
- Result of the RemoveTargets operation returned by the service.
- See Also:
-
removeTargets
default RemoveTargetsResponse removeTargets(Consumer<RemoveTargetsRequest.Builder> removeTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, ManagedRuleException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
A successful execution of
RemoveTargets
doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.
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 inFailedEntries
provides the ID of the failed target and the error code.The maximum number of entries per request is 10.
This is a convenience which creates an instance of the
RemoveTargetsRequest.Builder
avoiding the need to create one manually viaRemoveTargetsRequest.builder()
- Parameters:
removeTargetsRequest
- AConsumer
that will call methods onRemoveTargetsRequest.Builder
to create a request.- Returns:
- Result of the RemoveTargets operation returned by the service.
- See Also:
-
startReplay
default StartReplayResponse startReplay(StartReplayRequest startReplayRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, InvalidEventPatternException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 anEventEndTime
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 useDescribeReplay
to determine the progress of a replay. The value returned forEventLastReplayedTime
indicates the time within the specified time range associated with the last event replayed.- Parameters:
startReplayRequest
-- Returns:
- Result of the StartReplay operation returned by the service.
- See Also:
-
startReplay
default StartReplayResponse startReplay(Consumer<StartReplayRequest.Builder> startReplayRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, InvalidEventPatternException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, EventBridgeException 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 anEventEndTime
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 useDescribeReplay
to determine the progress of a replay. The value returned forEventLastReplayedTime
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 viaStartReplayRequest.builder()
- Parameters:
startReplayRequest
- AConsumer
that will call methods onStartReplayRequest.Builder
to create a request.- Returns:
- Result of the StartReplay operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, ManagedRuleException, AwsServiceException, SdkClientException, EventBridgeException Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the
TagResource
action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, ManagedRuleException, AwsServiceException, SdkClientException, EventBridgeException Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.
Tags don't have any semantic meaning to Amazon Web Services and are interpreted strictly as strings of characters.
You can use the
TagResource
action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.You can associate as many as 50 tags with a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
testEventPattern
default TestEventPatternResponse testEventPattern(TestEventPatternRequest testEventPatternRequest) throws InvalidEventPatternException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Tests whether the specified event pattern matches the provided event.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
- Parameters:
testEventPatternRequest
-- Returns:
- Result of the TestEventPattern operation returned by the service.
- See Also:
-
testEventPattern
default TestEventPatternResponse testEventPattern(Consumer<TestEventPatternRequest.Builder> testEventPatternRequest) throws InvalidEventPatternException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Tests whether the specified event pattern matches the provided event.
Most services in Amazon Web Services treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
This is a convenience which creates an instance of the
TestEventPatternRequest.Builder
avoiding the need to create one manually viaTestEventPatternRequest.builder()
- Parameters:
testEventPatternRequest
- AConsumer
that will call methods onTestEventPatternRequest.Builder
to create a request.- Returns:
- Result of the TestEventPattern operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, ManagedRuleException, AwsServiceException, SdkClientException, EventBridgeException Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events), rules and event buses can be tagged.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, ManagedRuleException, AwsServiceException, SdkClientException, EventBridgeException 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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateApiDestination
default UpdateApiDestinationResponse updateApiDestination(UpdateApiDestinationRequest updateApiDestinationRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException, AwsServiceException, SdkClientException, EventBridgeException Updates an API destination.
- Parameters:
updateApiDestinationRequest
-- Returns:
- Result of the UpdateApiDestination operation returned by the service.
- See Also:
-
updateApiDestination
default UpdateApiDestinationResponse updateApiDestination(Consumer<UpdateApiDestinationRequest.Builder> updateApiDestinationRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException, AwsServiceException, SdkClientException, EventBridgeException Updates an API destination.
This is a convenience which creates an instance of the
UpdateApiDestinationRequest.Builder
avoiding the need to create one manually viaUpdateApiDestinationRequest.builder()
- Parameters:
updateApiDestinationRequest
- AConsumer
that will call methods onUpdateApiDestinationRequest.Builder
to create a request.- Returns:
- Result of the UpdateApiDestination operation returned by the service.
- See Also:
-
updateArchive
default UpdateArchiveResponse updateArchive(UpdateArchiveRequest updateArchiveRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, EventBridgeException Updates the specified archive.
- Parameters:
updateArchiveRequest
-- Returns:
- Result of the UpdateArchive operation returned by the service.
- See Also:
-
updateArchive
default UpdateArchiveResponse updateArchive(Consumer<UpdateArchiveRequest.Builder> updateArchiveRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException, InvalidEventPatternException, AwsServiceException, SdkClientException, EventBridgeException Updates the specified archive.
This is a convenience which creates an instance of the
UpdateArchiveRequest.Builder
avoiding the need to create one manually viaUpdateArchiveRequest.builder()
- Parameters:
updateArchiveRequest
- AConsumer
that will call methods onUpdateArchiveRequest.Builder
to create a request.- Returns:
- Result of the UpdateArchive operation returned by the service.
- See Also:
-
updateConnection
default UpdateConnectionResponse updateConnection(UpdateConnectionRequest updateConnectionRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException, AwsServiceException, SdkClientException, EventBridgeException Updates settings for a connection.
- Parameters:
updateConnectionRequest
-- Returns:
- Result of the UpdateConnection operation returned by the service.
- See Also:
-
updateConnection
default UpdateConnectionResponse updateConnection(Consumer<UpdateConnectionRequest.Builder> updateConnectionRequest) throws ConcurrentModificationException, ResourceNotFoundException, InternalException, LimitExceededException, AwsServiceException, SdkClientException, EventBridgeException Updates settings for a connection.
This is a convenience which creates an instance of the
UpdateConnectionRequest.Builder
avoiding the need to create one manually viaUpdateConnectionRequest.builder()
- Parameters:
updateConnectionRequest
- AConsumer
that will call methods onUpdateConnectionRequest.Builder
to create a request.- Returns:
- Result of the UpdateConnection operation returned by the service.
- See Also:
-
updateEndpoint
default UpdateEndpointResponse updateEndpoint(UpdateEndpointRequest updateEndpointRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
- Parameters:
updateEndpointRequest
-- Returns:
- Result of the UpdateEndpoint operation returned by the service.
- See Also:
-
updateEndpoint
default UpdateEndpointResponse updateEndpoint(Consumer<UpdateEndpointRequest.Builder> updateEndpointRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, EventBridgeException Update an existing endpoint. For more information about global endpoints, see Making applications Regional-fault tolerant with global endpoints and event replication in the Amazon EventBridge User Guide.
This is a convenience which creates an instance of the
UpdateEndpointRequest.Builder
avoiding the need to create one manually viaUpdateEndpointRequest.builder()
- Parameters:
updateEndpointRequest
- AConsumer
that will call methods onUpdateEndpointRequest.Builder
to create a request.- Returns:
- Result of the UpdateEndpoint operation returned by the service.
- See Also:
-
create
Create aEventBridgeClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aEventBridgeClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-