AmazonCloudWatchEvents (AWS SDK for Java

All Known Subinterfaces:

AmazonCloudWatchEventsAsync

All Known Implementing Classes:

AbstractAmazonCloudWatchEvents, AbstractAmazonCloudWatchEventsAsync, AmazonCloudWatchEventsAsyncClient, AmazonCloudWatchEventsClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudWatchEvents
```
Interface for accessing Amazon CloudWatch Events.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonCloudWatchEvents instead.

Amazon CloudWatch Events helps you to respond to state changes in your AWS resources. When your resources change state, they automatically send events into an event stream. You can create rules that match selected events in the stream and route them to targets to take action. You can also use rules to take action on a pre-determined schedule. For example, you can configure rules to:
- Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance enters the running state.
- Direct specific API records from CloudTrail to an Amazon Kinesis 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 CloudWatch Events, see the Amazon CloudWatch Events User Guide.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`DeleteRuleResult`	`deleteRule(DeleteRuleRequest deleteRuleRequest)` Deletes the specified rule.
`DescribeEventBusResult`	`describeEventBus(DescribeEventBusRequest describeEventBusRequest)` Displays the external AWS accounts that are permitted to write events to your account using your account's event bus, and the associated policy.
`DescribeRuleResult`	`describeRule(DescribeRuleRequest describeRuleRequest)` Describes the specified rule.
`DisableRuleResult`	`disableRule(DisableRuleRequest disableRuleRequest)` Disables the specified rule.
`EnableRuleResult`	`enableRule(EnableRuleRequest enableRuleRequest)` 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.
`ListRuleNamesByTargetResult`	`listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)` Lists the rules for the specified target.
`ListRulesResult`	`listRules(ListRulesRequest listRulesRequest)` Lists your Amazon CloudWatch Events rules.
`ListTargetsByRuleResult`	`listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)` Lists the targets assigned to the specified rule.
`PutEventsResult`	`putEvents(PutEventsRequest putEventsRequest)` Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
`PutPermissionResult`	`putPermission(PutPermissionRequest putPermissionRequest)` Running `PutPermission` permits the specified AWS account to put events to your account's default event bus.
`PutRuleResult`	`putRule(PutRuleRequest putRuleRequest)` Creates or updates the specified rule.
`PutTargetsResult`	`putTargets(PutTargetsRequest putTargetsRequest)` Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
`RemovePermissionResult`	`removePermission(RemovePermissionRequest removePermissionRequest)` Revokes the permission of another AWS account to be able to put events to your default event bus.
`RemoveTargetsResult`	`removeTargets(RemoveTargetsRequest removeTargetsRequest)` Removes the specified targets from the specified rule.
`void`	`setEndpoint(String endpoint)` Deprecated. use `AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)` for example: `builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));`
`void`	`setRegion(Region region)` Deprecated. use `AwsClientBuilder#setRegion(String)`
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TestEventPatternResult`	`testEventPattern(TestEventPatternRequest testEventPatternRequest)` Tests whether the specified event pattern matches the provided event.

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.
    
    See Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - setEndpoint
```
@Deprecated
void setEndpoint(String endpoint)
```
    Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
    
    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: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912
    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.
    
    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
```
@Deprecated
void setRegion(Region region)
```
    Deprecated. use AwsClientBuilder#setRegion(String)
    
    An alternative to 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.
    
    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)
  - deleteRule
```
DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest)
```
    Deletes the specified rule.
    
    You must remove all targets from a rule using RemoveTargets before you can delete the rule.
    
    When you delete a rule, incoming events might continue to match to the deleted rule. Please allow a short period of time for changes to take effect.
    
    Parameters:
    
    deleteRuleRequest -
    
    Returns:
    
    Result of the DeleteRule operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - describeEventBus
```
DescribeEventBusResult describeEventBus(DescribeEventBusRequest describeEventBusRequest)
```
    Displays the external AWS accounts that are permitted to write events to your account using your account's event bus, and the associated policy. To enable your account to receive events from other accounts, use PutPermission.
    
    Parameters:
    
    describeEventBusRequest -
    
    Returns:
    
    Result of the DescribeEventBus operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - describeRule
```
DescribeRuleResult describeRule(DescribeRuleRequest describeRuleRequest)
```
    Describes the specified rule.
    
    Parameters:
    
    describeRuleRequest -
    
    Returns:
    
    Result of the DescribeRule operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - disableRule
```
DisableRuleResult disableRule(DisableRuleRequest disableRuleRequest)
```
    Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.
    
    When you disable a rule, incoming events might continue to match to the disabled rule. Please allow a short period of time for changes to take effect.
    
    Parameters:
    
    disableRuleRequest -
    
    Returns:
    
    Result of the DisableRule operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - enableRule
```
EnableRuleResult enableRule(EnableRuleRequest enableRuleRequest)
```
    Enables the specified rule. If the rule does not exist, the operation fails.
    
    When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.
    
    Parameters:
    
    enableRuleRequest -
    
    Returns:
    
    Result of the EnableRule operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - listRuleNamesByTarget
```
ListRuleNamesByTargetResult listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)
```
    Lists the rules for the specified target. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account.
    
    Parameters:
    
    listRuleNamesByTargetRequest -
    
    Returns:
    
    Result of the ListRuleNamesByTarget operation returned by the service.
    
    Throws:
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - listRules
```
ListRulesResult listRules(ListRulesRequest listRulesRequest)
```
    Lists your Amazon CloudWatch Events rules. You can either list all the rules or you can provide a prefix to match to the rule names.
    
    Parameters:
    
    listRulesRequest -
    
    Returns:
    
    Result of the ListRules operation returned by the service.
    
    Throws:
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - listTargetsByRule
```
ListTargetsByRuleResult listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)
```
    Lists the targets assigned to the specified rule.
    
    Parameters:
    
    listTargetsByRuleRequest -
    
    Returns:
    
    Result of the ListTargetsByRule operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - putEvents
```
PutEventsResult putEvents(PutEventsRequest putEventsRequest)
```
    Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
    
    Parameters:
    
    putEventsRequest -
    
    Returns:
    
    Result of the PutEvents operation returned by the service.
    
    Throws:
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - putPermission
```
PutPermissionResult putPermission(PutPermissionRequest putPermissionRequest)
```
    Running PutPermission permits the specified AWS account to put events to your account's default event bus. CloudWatch Events rules in your account are triggered by these events arriving to your default event bus.
    
    For another account to send events to your account, that external account must have a CloudWatch Events rule with your account's default event bus as a target.
    
    To enable multiple AWS accounts to put events to your default event bus, run PutPermission once for each of these accounts.
    
    The permission policy on the default event bus cannot exceed 10KB in size.
    
    Parameters:
    
    putPermissionRequest -
    
    Returns:
    
    Result of the PutPermission operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    PolicyLengthExceededException - The event bus policy is too long. For more information, see the limits.
    
    InternalException - This exception occurs due to unexpected causes.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    See Also:
    
    AWS API Documentation
  - putRule
```
PutRuleResult putRule(PutRuleRequest putRuleRequest)
```
    Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.
    
    When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Please 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.
    
    Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events 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:
    
    putRuleRequest -
    
    Returns:
    
    Result of the PutRule operation returned by the service.
    
    Throws:
    
    InvalidEventPatternException - The event pattern is not valid.
    
    LimitExceededException - You tried to create more rules or add more targets to a rule than is allowed.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - putTargets
```
PutTargetsResult putTargets(PutTargetsRequest putTargetsRequest)
```
    Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
    
    Targets are the resources that are invoked when a rule is triggered.
    
    You can configure the following as targets for CloudWatch Events:
    - EC2 instances
    - AWS Lambda functions
    - Streams in Amazon Kinesis Streams
    - Delivery streams in Amazon Kinesis Firehose
    - Amazon ECS tasks
    - AWS Step Functions state machines
    - Pipelines in Amazon Code Pipeline
    - Amazon Inspector assessment templates
    - Amazon SNS topics
    - Amazon SQS queues
    - The default event bus of another AWS account
    Note that creating rules with built-in targets is supported only in the AWS Management Console.
    
    For some target types, PutTargets provides target-specific parameters. If the target is an Amazon Kinesis 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 CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For EC2 instances, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon CloudWatch Events 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 by setting 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 when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to antoher account is charged as a custom event. The account receiving the event is not charged. For more information on pricing, see Amazon CloudWatch Pricing.
    
    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 form (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 Input, 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. Please 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.
    Parameters:
    
    putTargetsRequest -
    
    Returns:
    
    Result of the PutTargets operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    LimitExceededException - You tried to create more rules or add more targets to a rule than is allowed.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - removePermission
```
RemovePermissionResult removePermission(RemovePermissionRequest removePermissionRequest)
```
    Revokes the permission of another AWS account to be able to put events to your default 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.
    
    Parameters:
    
    removePermissionRequest -
    
    Returns:
    
    Result of the RemovePermission operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    InternalException - This exception occurs due to unexpected causes.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    See Also:
    
    AWS API Documentation
  - removeTargets
```
RemoveTargetsResult removeTargets(RemoveTargetsRequest removeTargetsRequest)
```
    Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
    
    When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Please 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.
    
    Parameters:
    
    removeTargetsRequest -
    
    Returns:
    
    Result of the RemoveTargets operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - testEventPattern
```
TestEventPatternResult testEventPattern(TestEventPatternRequest testEventPatternRequest)
```
    Tests whether the specified event pattern matches the provided event.
    
    Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events 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.
    
    Throws:
    
    InvalidEventPatternException - The event pattern is not valid.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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. 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.
    
    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?

Interface AmazonCloudWatchEvents

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

setEndpoint

setRegion

deleteRule

describeEventBus

describeRule

disableRule

enableRule

listRuleNamesByTarget

listRules

listTargetsByRule

putEvents

putPermission

putRule

putTargets

removePermission

removeTargets

testEventPattern

shutdown

getCachedResponseMetadata