AbstractAmazonCloudWatchEvents (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatchevents.AbstractAmazonCloudWatchEvents

All Implemented Interfaces:

AmazonCloudWatchEvents

Direct Known Subclasses:

AbstractAmazonCloudWatchEventsAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonCloudWatchEvents
extends Object
implements AmazonCloudWatchEvents
```
Abstract implementation of AmazonCloudWatchEvents. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.cloudwatchevents.AmazonCloudWatchEvents
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActivateEventSourceResult`	`activateEventSource(ActivateEventSourceRequest request)` Activates a partner event source that has been deactivated.
`CancelReplayResult`	`cancelReplay(CancelReplayRequest request)` Cancels the specified replay.
`CreateApiDestinationResult`	`createApiDestination(CreateApiDestinationRequest request)` Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
`CreateArchiveResult`	`createArchive(CreateArchiveRequest request)` Creates an archive of events with the specified settings.
`CreateConnectionResult`	`createConnection(CreateConnectionRequest request)` Creates a connection.
`CreateEventBusResult`	`createEventBus(CreateEventBusRequest request)` Creates a new event bus within your account.
`CreatePartnerEventSourceResult`	`createPartnerEventSource(CreatePartnerEventSourceRequest request)` Called by an SaaS partner to create a partner event source.
`DeactivateEventSourceResult`	`deactivateEventSource(DeactivateEventSourceRequest request)` You can use this operation to temporarily stop receiving events from the specified partner event source.
`DeauthorizeConnectionResult`	`deauthorizeConnection(DeauthorizeConnectionRequest request)` Removes all authorization parameters from the connection.
`DeleteApiDestinationResult`	`deleteApiDestination(DeleteApiDestinationRequest request)` Deletes the specified API destination.
`DeleteArchiveResult`	`deleteArchive(DeleteArchiveRequest request)` Deletes the specified archive.
`DeleteConnectionResult`	`deleteConnection(DeleteConnectionRequest request)` Deletes a connection.
`DeleteEventBusResult`	`deleteEventBus(DeleteEventBusRequest request)` Deletes the specified custom event bus or partner event bus.
`DeletePartnerEventSourceResult`	`deletePartnerEventSource(DeletePartnerEventSourceRequest request)` This operation is used by SaaS partners to delete a partner event source.
`DeleteRuleResult`	`deleteRule(DeleteRuleRequest request)` Deletes the specified rule.
`DescribeApiDestinationResult`	`describeApiDestination(DescribeApiDestinationRequest request)` Retrieves details about an API destination.
`DescribeArchiveResult`	`describeArchive(DescribeArchiveRequest request)` Retrieves details about an archive.
`DescribeConnectionResult`	`describeConnection(DescribeConnectionRequest request)` Retrieves details about a connection.
`DescribeEventBusResult`	`describeEventBus(DescribeEventBusRequest request)` Displays details about an event bus in your account.
`DescribeEventSourceResult`	`describeEventSource(DescribeEventSourceRequest request)` This operation lists details about a partner event source that is shared with your account.
`DescribePartnerEventSourceResult`	`describePartnerEventSource(DescribePartnerEventSourceRequest request)` An SaaS partner can use this operation to list details about a partner event source that they have created.
`DescribeReplayResult`	`describeReplay(DescribeReplayRequest request)` Retrieves details about a replay.
`DescribeRuleResult`	`describeRule(DescribeRuleRequest request)` Describes the specified rule.
`DisableRuleResult`	`disableRule(DisableRuleRequest request)` Disables the specified rule.
`EnableRuleResult`	`enableRule(EnableRuleRequest request)` Enables the specified rule.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListApiDestinationsResult`	`listApiDestinations(ListApiDestinationsRequest request)` Retrieves a list of API destination in the account in the current Region.
`ListArchivesResult`	`listArchives(ListArchivesRequest request)` Lists your archives.
`ListConnectionsResult`	`listConnections(ListConnectionsRequest request)` Retrieves a list of connections from the account.
`ListEventBusesResult`	`listEventBuses(ListEventBusesRequest request)` Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
`ListEventSourcesResult`	`listEventSources(ListEventSourcesRequest request)` You can use this to see all the partner event sources that have been shared with your AWS account.
`ListPartnerEventSourceAccountsResult`	`listPartnerEventSourceAccounts(ListPartnerEventSourceAccountsRequest request)` An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with.
`ListPartnerEventSourcesResult`	`listPartnerEventSources(ListPartnerEventSourcesRequest request)` An SaaS partner can use this operation to list all the partner event source names that they have created.
`ListReplaysResult`	`listReplays(ListReplaysRequest request)` Lists your replays.
`ListRuleNamesByTargetResult`	`listRuleNamesByTarget(ListRuleNamesByTargetRequest request)` Lists the rules for the specified target.
`ListRulesResult`	`listRules(ListRulesRequest request)` Lists your Amazon EventBridge rules.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Displays the tags associated with an EventBridge resource.
`ListTargetsByRuleResult`	`listTargetsByRule(ListTargetsByRuleRequest request)` Lists the targets assigned to the specified rule.
`PutEventsResult`	`putEvents(PutEventsRequest request)` Sends custom events to Amazon EventBridge so that they can be matched to rules.
`PutPartnerEventsResult`	`putPartnerEvents(PutPartnerEventsRequest request)` This is used by SaaS partners to write events to a customer's partner event bus.
`PutPermissionResult`	`putPermission(PutPermissionRequest request)` Running `PutPermission` permits the specified AWS account or AWS organization to put events to the specified event bus.
`PutRuleResult`	`putRule(PutRuleRequest request)` Creates or updates the specified rule.
`PutTargetsResult`	`putTargets(PutTargetsRequest request)` Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
`RemovePermissionResult`	`removePermission(RemovePermissionRequest request)` Revokes the permission of another AWS account to be able to put events to the specified event bus.
`RemoveTargetsResult`	`removeTargets(RemoveTargetsRequest request)` Removes the specified targets from the specified rule.
`void`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("events.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AmazonCloudWatchEvents.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`StartReplayResult`	`startReplay(StartReplayRequest request)` Starts the specified replay.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Assigns one or more tags (key-value pairs) to the specified EventBridge resource.
`TestEventPatternResult`	`testEventPattern(TestEventPatternRequest request)` Tests whether the specified event pattern matches the provided event.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes one or more tags from the specified EventBridge resource.
`UpdateApiDestinationResult`	`updateApiDestination(UpdateApiDestinationRequest request)` Updates an API destination.
`UpdateArchiveResult`	`updateArchive(UpdateArchiveRequest request)` Updates the specified archive.
`UpdateConnectionResult`	`updateConnection(UpdateConnectionRequest request)` Updates settings for a connection.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Overrides the default endpoint for this client ("events.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "events.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "events.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
    This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setEndpoint in interface AmazonCloudWatchEvents
    
    Parameters:
    
    endpoint - The endpoint (ex: "events.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "events.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    An alternative to AmazonCloudWatchEvents.setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.
    By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.
    This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
    
    Specified by:
    
    setRegion in interface AmazonCloudWatchEvents
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - activateEventSource
```
public ActivateEventSourceResult activateEventSource(ActivateEventSourceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.
    
    Specified by:
    
    activateEventSource in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ActivateEventSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - cancelReplay
```
public CancelReplayResult cancelReplay(CancelReplayRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Cancels the specified replay.
    
    Specified by:
    
    cancelReplay in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the CancelReplay operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createApiDestination
```
public CreateApiDestinationResult createApiDestination(CreateApiDestinationRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Creates an API destination, which is an HTTP invocation endpoint configured as a target for events.
    
    Specified by:
    
    createApiDestination in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the CreateApiDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createArchive
```
public CreateArchiveResult createArchive(CreateArchiveRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    createArchive in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the CreateArchive operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createConnection
```
public CreateConnectionResult createConnection(CreateConnectionRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Creates a connection. A connection defines the authorization type and credentials to use for authorization with an API destination HTTP endpoint.
    
    Specified by:
    
    createConnection in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the CreateConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createEventBus
```
public CreateEventBusResult createEventBus(CreateEventBusRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    createEventBus in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the CreateEventBus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPartnerEventSource
```
public CreatePartnerEventSourceResult createPartnerEventSource(CreatePartnerEventSourceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers.
    
    Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types.
    
    A partner event source creates events based on resources within the SaaS partner's service or application.
    
    An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets.
    
    Partner event source names follow this format:
    
    partner_name/event_namespace/event_name
    
    partner_name is determined during partner registration and identifies the partner to AWS customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help AWS customers decide whether to create an event bus to receive these events.
    
    Specified by:
    
    createPartnerEventSource in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the CreatePartnerEventSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deactivateEventSource
```
public DeactivateEventSourceResult deactivateEventSource(DeactivateEventSourceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    deactivateEventSource in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DeactivateEventSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deauthorizeConnection
```
public DeauthorizeConnectionResult deauthorizeConnection(DeauthorizeConnectionRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    deauthorizeConnection in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DeauthorizeConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteApiDestination
```
public DeleteApiDestinationResult deleteApiDestination(DeleteApiDestinationRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Deletes the specified API destination.
    
    Specified by:
    
    deleteApiDestination in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DeleteApiDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteArchive
```
public DeleteArchiveResult deleteArchive(DeleteArchiveRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Deletes the specified archive.
    
    Specified by:
    
    deleteArchive in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DeleteArchive operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteConnection
```
public DeleteConnectionResult deleteConnection(DeleteConnectionRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Deletes a connection.
    
    Specified by:
    
    deleteConnection in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DeleteConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEventBus
```
public DeleteEventBusResult deleteEventBus(DeleteEventBusRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    deleteEventBus in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DeleteEventBus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePartnerEventSource
```
public DeletePartnerEventSourceResult deletePartnerEventSource(DeletePartnerEventSourceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.
    
    When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.
    
    Specified by:
    
    deletePartnerEventSource in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DeletePartnerEventSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteRule
```
public DeleteRuleResult deleteRule(DeleteRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Deletes the specified rule.
    
    Before you can delete the rule, you must remove all targets, using RemoveTargets.
    
    When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
    
    Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.
    
    Specified by:
    
    deleteRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DeleteRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeApiDestination
```
public DescribeApiDestinationResult describeApiDestination(DescribeApiDestinationRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Retrieves details about an API destination.
    
    Specified by:
    
    describeApiDestination in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DescribeApiDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeArchive
```
public DescribeArchiveResult describeArchive(DescribeArchiveRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Retrieves details about an archive.
    
    Specified by:
    
    describeArchive in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DescribeArchive operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeConnection
```
public DescribeConnectionResult describeConnection(DescribeConnectionRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Retrieves details about a connection.
    
    Specified by:
    
    describeConnection in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DescribeConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventBus
```
public DescribeEventBusResult describeEventBus(DescribeEventBusRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Displays details about an event bus in your account. This can include the external AWS accounts that are permitted to write events to your default event bus, and the associated policy. For custom event buses and partner event buses, it displays the name, ARN, policy, state, and creation time.
    
    To enable your account to receive events from other accounts on its default event bus, use PutPermission.
    
    For more information about partner event buses, see CreateEventBus.
    
    Specified by:
    
    describeEventBus in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DescribeEventBus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventSource
```
public DescribeEventSourceResult describeEventSource(DescribeEventSourceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    This operation lists details about a partner event source that is shared with your account.
    
    Specified by:
    
    describeEventSource in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DescribeEventSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePartnerEventSource
```
public DescribePartnerEventSourceResult describePartnerEventSource(DescribePartnerEventSourceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.
    
    Specified by:
    
    describePartnerEventSource in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DescribePartnerEventSource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeReplay
```
public DescribeReplayResult describeReplay(DescribeReplayRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Retrieves details about a replay. Use DescribeReplay to determine the progress of a running replay. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you use StartReplay and specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.
    
    Specified by:
    
    describeReplay in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DescribeReplay operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRule
```
public DescribeRuleResult describeRule(DescribeRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Describes the specified rule.
    
    DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
    
    Specified by:
    
    describeRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DescribeRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disableRule
```
public DisableRuleResult disableRule(DisableRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    disableRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DisableRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableRule
```
public EnableRuleResult enableRule(EnableRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    enableRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the EnableRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listApiDestinations
```
public ListApiDestinationsResult listApiDestinations(ListApiDestinationsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Retrieves a list of API destination in the account in the current Region.
    
    Specified by:
    
    listApiDestinations in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListApiDestinations operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listArchives
```
public ListArchivesResult listArchives(ListArchivesRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    listArchives in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListArchives operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listConnections
```
public ListConnectionsResult listConnections(ListConnectionsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Retrieves a list of connections from the account.
    
    Specified by:
    
    listConnections in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListConnections operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEventBuses
```
public ListEventBusesResult listEventBuses(ListEventBusesRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Lists all the event buses in your account, including the default event bus, custom event buses, and partner event buses.
    
    Specified by:
    
    listEventBuses in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListEventBuses operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEventSources
```
public ListEventSourcesResult listEventSources(ListEventSourcesRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.
    
    Specified by:
    
    listEventSources in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListEventSources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPartnerEventSourceAccounts
```
public ListPartnerEventSourceAccountsResult listPartnerEventSourceAccounts(ListPartnerEventSourceAccountsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is not used by AWS customers.
    
    Specified by:
    
    listPartnerEventSourceAccounts in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListPartnerEventSourceAccounts operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPartnerEventSources
```
public ListPartnerEventSourcesResult listPartnerEventSources(ListPartnerEventSourcesRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by AWS customers.
    
    Specified by:
    
    listPartnerEventSources in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListPartnerEventSources operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listReplays
```
public ListReplaysResult listReplays(ListReplaysRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    listReplays in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListReplays operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRuleNamesByTarget
```
public ListRuleNamesByTargetResult listRuleNamesByTarget(ListRuleNamesByTargetRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    listRuleNamesByTarget in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListRuleNamesByTarget operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRules
```
public ListRulesResult listRules(ListRulesRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Lists your Amazon EventBridge rules. You can either list all the rules or you can provide a prefix to match to the rule names.
    
    ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
    
    Specified by:
    
    listRules in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListRules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Displays the tags associated with an EventBridge resource. In EventBridge, rules and event buses can be tagged.
    
    Specified by:
    
    listTagsForResource in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTargetsByRule
```
public ListTargetsByRuleResult listTargetsByRule(ListTargetsByRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Lists the targets assigned to the specified rule.
    
    Specified by:
    
    listTargetsByRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListTargetsByRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putEvents
```
public PutEventsResult putEvents(PutEventsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Sends custom events to Amazon EventBridge so that they can be matched to rules.
    
    Specified by:
    
    putEvents in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the PutEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putPartnerEvents
```
public PutPartnerEventsResult putPartnerEvents(PutPartnerEventsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.
    
    Specified by:
    
    putPartnerEvents in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the PutPartnerEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putPermission
```
public PutPermissionResult putPermission(PutPermissionRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.
    
    For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.
    
    To enable multiple AWS accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as "*" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.
    
    If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
    
    The permission policy on the default event bus cannot exceed 10 KB in size.
    
    Specified by:
    
    putPermission in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the PutPermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putRule
```
public PutRuleResult putRule(PutRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.
    
    A single rule watches for events from a single event bus. Events generated by AWS services go to your account's default event bus. Events generated by SaaS partner services or applications go to the matching partner event bus. If you have custom applications or services, you can specify whether their events go to your default event bus or a custom event bus that you have created. For more information, see CreateEventBus.
    
    If you are updating an existing rule, the rule is replaced with what you specify in this PutRule command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead, they are replaced with null values.
    
    When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
    
    A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
    
    When you initially create a rule, you can optionally assign one or more tags to the rule. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only rules with certain tag values. To use the PutRule operation and assign tags, you must have both the events:PutRule and events:TagResource permissions.
    
    If you are updating an existing rule, any tags you specify in the PutRule operation are ignored. To update the tags of an existing rule, use TagResource and UntagResource.
    
    Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
    
    In EventBridge, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
    
    To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
    
    An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
    
    Specified by:
    
    putRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the PutRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putTargets
```
public PutTargetsResult putTargets(PutTargetsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
    
    Targets are the resources that are invoked when a rule is triggered.
    
    You can configure the following as targets for Events:
    - EC2 instances
    - SSM Run Command
    - SSM Automation
    - AWS Lambda functions
    - Data streams in Amazon Kinesis Data Streams
    - Data delivery streams in Amazon Kinesis Data Firehose
    - Amazon ECS tasks
    - AWS Step Functions state machines
    - AWS Batch jobs
    - AWS CodeBuild projects
    - Pipelines in AWS CodePipeline
    - Amazon Inspector assessment templates
    - Amazon SNS topics
    - Amazon SQS queues, including FIFO queues
    - The default event bus of another AWS account
    - Amazon API Gateway REST APIs
    - Redshift Clusters to invoke Data API ExecuteStatement on
    - Custom/SaaS HTTPS APIs via EventBridge API Destinations
    Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.
    
    For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.
    
    To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.
    
    If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events) Pricing.
    
    Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.
    
    If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.
    
    For more information about enabling cross-account events, see PutPermission.
    
    Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
    - If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
    - If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
    - If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).
    - If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
    When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.
    
    When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
    
    This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
    Specified by:
    
    putTargets in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the PutTargets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removePermission
```
public RemovePermissionResult removePermission(RemovePermissionRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Revokes the permission of another AWS account to be able to put events to the specified event bus. Specify the account to revoke by the StatementId value that you associated with the account when you granted it permission with PutPermission. You can find the StatementId by using DescribeEventBus.
    
    Specified by:
    
    removePermission in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the RemovePermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeTargets
```
public RemoveTargetsResult removeTargets(RemoveTargetsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
    
    When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Allow a short period of time for changes to take effect.
    
    This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.
    
    Specified by:
    
    removeTargets in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the RemoveTargets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startReplay
```
public StartReplayResult startReplay(StartReplayRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Starts the specified replay. Events are not necessarily replayed in the exact same order that they were added to the archive. A replay processes events to replay based on the time in the event, and replays them using 1 minute intervals. If you specify an EventStartTime and an EventEndTime that covers a 20 minute time range, the events are replayed from the first minute of that 20 minute range first. Then the events from the second minute are replayed. You can use DescribeReplay to determine the progress of a replay. The value returned for EventLastReplayedTime indicates the time within the specified time range associated with the last event replayed.
    
    Specified by:
    
    startReplay in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the StartReplay operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Assigns one or more tags (key-value pairs) to the specified EventBridge resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values. In EventBridge, rules and event buses can be tagged.
    
    Tags don't have any semantic meaning to AWS and are interpreted strictly as strings of characters.
    
    You can use the TagResource action with a resource that already has tags. If you specify a new tag key, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
    
    You can associate as many as 50 tags with a resource.
    
    Specified by:
    
    tagResource in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testEventPattern
```
public TestEventPatternResult testEventPattern(TestEventPatternRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Tests whether the specified event pattern matches the provided event.
    
    Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, EventBridge uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
    
    Specified by:
    
    testEventPattern in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the TestEventPattern operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.
    
    Specified by:
    
    untagResource in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateApiDestination
```
public UpdateApiDestinationResult updateApiDestination(UpdateApiDestinationRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Updates an API destination.
    
    Specified by:
    
    updateApiDestination in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the UpdateApiDestination operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateArchive
```
public UpdateArchiveResult updateArchive(UpdateArchiveRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Updates the specified archive.
    
    Specified by:
    
    updateArchive in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the UpdateArchive operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateConnection
```
public UpdateConnectionResult updateConnection(UpdateConnectionRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Updates settings for a connection.
    
    Specified by:
    
    updateConnection in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the UpdateConnection operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonCloudWatchEvents
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonCloudWatchEvents
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Did this page help you?

Class AbstractAmazonCloudWatchEvents

Field Summary

Fields inherited from interface com.amazonaws.services.cloudwatchevents.AmazonCloudWatchEvents

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

activateEventSource

cancelReplay

createApiDestination

createArchive

createConnection

createEventBus

createPartnerEventSource

deactivateEventSource

deauthorizeConnection

deleteApiDestination

deleteArchive

deleteConnection

deleteEventBus

deletePartnerEventSource

deleteRule

describeApiDestination

describeArchive

describeConnection

describeEventBus

describeEventSource

describePartnerEventSource

describeReplay

describeRule

disableRule

enableRule

listApiDestinations

listArchives

listConnections

listEventBuses

listEventSources

listPartnerEventSourceAccounts

listPartnerEventSources

listReplays

listRuleNamesByTarget

listRules

listTagsForResource

listTargetsByRule

putEvents

putPartnerEvents

putPermission

putRule

putTargets

removePermission

removeTargets

startReplay

tagResource

testEventPattern

untagResource

updateApiDestination

updateArchive

updateConnection

shutdown

getCachedResponseMetadata