Package software.amazon.awssdk.services.cloudwatchevents

Interface CloudWatchEventsClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface CloudWatchEventsClient
extends AutoCloseable

Service client for accessing null. This can be created using the static builder() method.

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	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static CloudWatchEventsClientBuilder	builder()	Create a builder that can be used to configure and create a CloudWatchEventsClient.
static CloudWatchEventsClient	create()	Create a CloudWatchEventsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default DeleteRuleResponse	deleteRule(DeleteRuleRequest deleteRuleRequest)	Deletes the specified rule.
default DescribeRuleResponse	describeRule(DescribeRuleRequest describeRuleRequest)	Describes the specified rule.
default DisableRuleResponse	disableRule(DisableRuleRequest disableRuleRequest)	Disables the specified rule.
default EnableRuleResponse	enableRule(EnableRuleRequest enableRuleRequest)	Enables the specified rule.
default ListRuleNamesByTargetResponse	listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)	Lists the rules for the specified target.
default ListRulesResponse	listRules(ListRulesRequest listRulesRequest)	Lists your Amazon CloudWatch Events rules.
default ListTargetsByRuleResponse	listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)	Lists the targets assigned to the specified rule.
default PutEventsResponse	putEvents(PutEventsRequest putEventsRequest)	Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
default PutRuleResponse	putRule(PutRuleRequest putRuleRequest)	Creates or updates the specified 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 RemoveTargetsResponse	removeTargets(RemoveTargetsRequest removeTargetsRequest)	Removes the specified targets from the specified rule.
static ServiceMetadata	serviceMetadata()
default TestEventPatternResponse	testEventPattern(TestEventPatternRequest testEventPatternRequest)	Tests whether the specified event pattern matches the provided event.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static CloudWatchEventsClient create()

Create a CloudWatchEventsClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CloudWatchEventsClientBuilder builder()

Create a builder that can be used to configure and create a CloudWatchEventsClient.

deleteRule

default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest)
                               throws ConcurrentModificationException,
                                      InternalException,
                                      SdkBaseException,
                                      SdkClientException,
                                      CloudWatchEventsException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeRule

default DescribeRuleResponse describeRule(DescribeRuleRequest describeRuleRequest)
                                   throws ResourceNotFoundException,
                                          InternalException,
                                          SdkBaseException,
                                          SdkClientException,
                                          CloudWatchEventsException

Describes the specified rule.

Parameters:

describeRuleRequest -

Returns:

Result of the DescribeRule operation returned by the service.

Throws:

ResourceNotFoundException - The rule does not exist.

InternalException - This exception occurs due to unexpected causes.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

disableRule

default DisableRuleResponse disableRule(DisableRuleRequest disableRuleRequest)
                                 throws ResourceNotFoundException,
                                        ConcurrentModificationException,
                                        InternalException,
                                        SdkBaseException,
                                        SdkClientException,
                                        CloudWatchEventsException

Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.

When you disable a rule, incoming events might continue to match to the disabled rule. 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 - The rule does not exist.

ConcurrentModificationException - There is concurrent modification on a rule or target.

InternalException - This exception occurs due to unexpected causes.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

enableRule

default EnableRuleResponse enableRule(EnableRuleRequest enableRuleRequest)
                               throws ResourceNotFoundException,
                                      ConcurrentModificationException,
                                      InternalException,
                                      SdkBaseException,
                                      SdkClientException,
                                      CloudWatchEventsException

Enables the specified rule. If the rule does not exist, the operation fails.

When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. 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 - The rule does not exist.

ConcurrentModificationException - There is concurrent modification on a rule or target.

InternalException - This exception occurs due to unexpected causes.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listRuleNamesByTarget

default ListRuleNamesByTargetResponse listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)
                                                     throws InternalException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            CloudWatchEventsException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listRules

default ListRulesResponse listRules(ListRulesRequest listRulesRequest)
                             throws InternalException,
                                    SdkBaseException,
                                    SdkClientException,
                                    CloudWatchEventsException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listTargetsByRule

default ListTargetsByRuleResponse listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)
                                             throws ResourceNotFoundException,
                                                    InternalException,
                                                    SdkBaseException,
                                                    SdkClientException,
                                                    CloudWatchEventsException

Lists the targets assigned to the specified rule.

Parameters:

listTargetsByRuleRequest -

Returns:

Result of the ListTargetsByRule operation returned by the service.

Throws:

ResourceNotFoundException - The rule does not exist.

InternalException - This exception occurs due to unexpected causes.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

putEvents

default PutEventsResponse putEvents(PutEventsRequest putEventsRequest)
                             throws InternalException,
                                    SdkBaseException,
                                    SdkClientException,
                                    CloudWatchEventsException

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

putRule

default PutRuleResponse putRule(PutRuleRequest putRuleRequest)
                         throws InvalidEventPatternException,
                                LimitExceededException,
                                ConcurrentModificationException,
                                InternalException,
                                SdkBaseException,
                                SdkClientException,
                                CloudWatchEventsException

Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.

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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

putTargets

default PutTargetsResponse putTargets(PutTargetsRequest putTargetsRequest)
                               throws ResourceNotFoundException,
                                      ConcurrentModificationException,
                                      LimitExceededException,
                                      InternalException,
                                      SdkBaseException,
                                      SdkClientException,
                                      CloudWatchEventsException

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered. Example targets include EC2 instances, AWS Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, and built-in targets. 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 PutTarget. For more information, see Authentication and Access Control in the Amazon CloudWatch Events User Guide.

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 - The rule 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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

removeTargets

default RemoveTargetsResponse removeTargets(RemoveTargetsRequest removeTargetsRequest)
                                     throws ResourceNotFoundException,
                                            ConcurrentModificationException,
                                            InternalException,
                                            SdkBaseException,
                                            SdkClientException,
                                            CloudWatchEventsException

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. 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 - The rule does not exist.

ConcurrentModificationException - There is concurrent modification on a rule or target.

InternalException - This exception occurs due to unexpected causes.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

testEventPattern

default TestEventPatternResponse testEventPattern(TestEventPatternRequest testEventPatternRequest)
                                           throws InvalidEventPatternException,
                                                  InternalException,
                                                  SdkBaseException,
                                                  SdkClientException,
                                                  CloudWatchEventsException

Tests whether the specified event pattern matches the provided event.

Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, 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.

SdkBaseException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.

SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc)

CloudWatchEventsException - Base exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()