@Generated(value="software.amazon.awssdk:codegen") public interface CloudWatchEventsClient extends SdkClient
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_NAME |
| Modifier and Type | Method and 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(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
Deletes the specified rule.
|
default DeleteRuleResponse |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the specified rule.
|
default DescribeEventBusResponse |
describeEventBus()
Displays the external AWS accounts that are permitted to write events to your account using your account's event
bus, and the associated policy.
|
default DescribeEventBusResponse |
describeEventBus(Consumer<DescribeEventBusRequest.Builder> 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.
|
default DescribeEventBusResponse |
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.
|
default DescribeRuleResponse |
describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest)
Describes the specified rule.
|
default DescribeRuleResponse |
describeRule(DescribeRuleRequest describeRuleRequest)
Describes the specified rule.
|
default DisableRuleResponse |
disableRule(Consumer<DisableRuleRequest.Builder> disableRuleRequest)
Disables the specified rule.
|
default DisableRuleResponse |
disableRule(DisableRuleRequest disableRuleRequest)
Disables the specified rule.
|
default EnableRuleResponse |
enableRule(Consumer<EnableRuleRequest.Builder> enableRuleRequest)
Enables the specified rule.
|
default EnableRuleResponse |
enableRule(EnableRuleRequest enableRuleRequest)
Enables the specified rule.
|
default ListRuleNamesByTargetResponse |
listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> listRuleNamesByTargetRequest)
Lists the rules for the specified target.
|
default ListRuleNamesByTargetResponse |
listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)
Lists the rules for the specified target.
|
default ListRulesResponse |
listRules()
Lists your Amazon CloudWatch Events rules.
|
default ListRulesResponse |
listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)
Lists your Amazon CloudWatch Events rules.
|
default ListRulesResponse |
listRules(ListRulesRequest listRulesRequest)
Lists your Amazon CloudWatch Events rules.
|
default ListTargetsByRuleResponse |
listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
|
default ListTargetsByRuleResponse |
listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
|
default PutEventsResponse |
putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
|
default PutEventsResponse |
putEvents(PutEventsRequest putEventsRequest)
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
|
default PutPermissionResponse |
putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest)
Running
PutPermission permits the specified AWS account to put events to your account's default
event bus. |
default PutPermissionResponse |
putPermission(PutPermissionRequest putPermissionRequest)
Running
PutPermission permits the specified AWS account to put events to your account's default
event bus. |
default PutRuleResponse |
putRule(Consumer<PutRuleRequest.Builder> putRuleRequest)
Creates or updates the specified rule.
|
default PutRuleResponse |
putRule(PutRuleRequest putRuleRequest)
Creates or updates the specified rule.
|
default PutTargetsResponse |
putTargets(Consumer<PutTargetsRequest.Builder> putTargetsRequest)
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the
rule.
|
default PutTargetsResponse |
putTargets(PutTargetsRequest putTargetsRequest)
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the
rule.
|
default RemovePermissionResponse |
removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest)
Revokes the permission of another AWS account to be able to put events to your default event bus.
|
default RemovePermissionResponse |
removePermission(RemovePermissionRequest removePermissionRequest)
Revokes the permission of another AWS account to be able to put events to your default event bus.
|
default RemoveTargetsResponse |
removeTargets(Consumer<RemoveTargetsRequest.Builder> removeTargetsRequest)
Removes the specified targets from the specified rule.
|
default RemoveTargetsResponse |
removeTargets(RemoveTargetsRequest removeTargetsRequest)
Removes the specified targets from the specified rule.
|
static ServiceMetadata |
serviceMetadata() |
default TestEventPatternResponse |
testEventPattern(Consumer<TestEventPatternRequest.Builder> testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
|
default TestEventPatternResponse |
testEventPattern(TestEventPatternRequest testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
|
serviceNameclosestatic final String SERVICE_NAME
static CloudWatchEventsClient create()
CloudWatchEventsClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudWatchEventsClientBuilder builder()
CloudWatchEventsClient.default DeleteRuleResponse deleteRule(DeleteRuleRequest deleteRuleRequest) throws ConcurrentModificationException, InternalException, AwsServiceException, 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.
deleteRuleRequest - ConcurrentModificationException - There is concurrent modification on a rule or target.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteRuleResponse deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest) throws ConcurrentModificationException, InternalException, AwsServiceException, 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.
This is a convenience which creates an instance of the DeleteRuleRequest.Builder avoiding the need to
create one manually via DeleteRuleRequest.builder()
deleteRuleRequest - A Consumer that will call methods on DeleteRuleRequest.Builder to create a request.ConcurrentModificationException - There is concurrent modification on a rule or target.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventBusResponse describeEventBus() throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Displays 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.
ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondescribeEventBus(DescribeEventBusRequest),
AWS API
Documentationdefault DescribeEventBusResponse describeEventBus(DescribeEventBusRequest describeEventBusRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Displays 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.
describeEventBusRequest - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeEventBusResponse describeEventBus(Consumer<DescribeEventBusRequest.Builder> describeEventBusRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Displays 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.
This is a convenience which creates an instance of the DescribeEventBusRequest.Builder avoiding the need
to create one manually via DescribeEventBusRequest.builder()
describeEventBusRequest - A Consumer that will call methods on DescribeEventBusRequest.Builder to create a request.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRuleResponse describeRule(DescribeRuleRequest describeRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Describes the specified rule.
describeRuleRequest - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeRuleResponse describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Describes the specified rule.
This is a convenience which creates an instance of the DescribeRuleRequest.Builder avoiding the need to
create one manually via DescribeRuleRequest.builder()
describeRuleRequest - A Consumer that will call methods on DescribeRuleRequest.Builder to create a request.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableRuleResponse disableRule(DisableRuleRequest disableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.
When you disable a rule, incoming events might continue to match to the disabled rule. Please allow a short period of time for changes to take effect.
disableRuleRequest - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule or target.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DisableRuleResponse disableRule(Consumer<DisableRuleRequest.Builder> disableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.
When you disable a rule, incoming events might continue to match to the disabled rule. Please allow a short period of time for changes to take effect.
This is a convenience which creates an instance of the DisableRuleRequest.Builder avoiding the need to
create one manually via DisableRuleRequest.builder()
disableRuleRequest - A Consumer that will call methods on DisableRuleRequest.Builder to create a request.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule or target.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableRuleResponse enableRule(EnableRuleRequest enableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Enables the specified rule. If the rule does not exist, the operation fails.
When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.
enableRuleRequest - ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule or target.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault EnableRuleResponse enableRule(Consumer<EnableRuleRequest.Builder> enableRuleRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Enables the specified rule. If the rule does not exist, the operation fails.
When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.
This is a convenience which creates an instance of the EnableRuleRequest.Builder avoiding the need to
create one manually via EnableRuleRequest.builder()
enableRuleRequest - A Consumer that will call methods on EnableRuleRequest.Builder to create a request.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule or target.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRuleNamesByTargetResponse listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest) throws InternalException, AwsServiceException, 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.
listRuleNamesByTargetRequest - InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRuleNamesByTargetResponse listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> listRuleNamesByTargetRequest) throws InternalException, AwsServiceException, 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.
This is a convenience which creates an instance of the ListRuleNamesByTargetRequest.Builder avoiding the
need to create one manually via ListRuleNamesByTargetRequest.builder()
listRuleNamesByTargetRequest - A Consumer that will call methods on ListRuleNamesByTargetRequest.Builder to create a
request.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRulesResponse listRules() throws InternalException, AwsServiceException, 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.
InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionlistRules(ListRulesRequest),
AWS API
Documentationdefault ListRulesResponse listRules(ListRulesRequest listRulesRequest) throws InternalException, AwsServiceException, 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.
listRulesRequest - InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListRulesResponse listRules(Consumer<ListRulesRequest.Builder> listRulesRequest) throws InternalException, AwsServiceException, 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.
This is a convenience which creates an instance of the ListRulesRequest.Builder avoiding the need to
create one manually via ListRulesRequest.builder()
listRulesRequest - A Consumer that will call methods on ListRulesRequest.Builder to create a request.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTargetsByRuleResponse listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Lists the targets assigned to the specified rule.
listTargetsByRuleRequest - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListTargetsByRuleResponse listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest) throws ResourceNotFoundException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Lists the targets assigned to the specified rule.
This is a convenience which creates an instance of the ListTargetsByRuleRequest.Builder avoiding the need
to create one manually via ListTargetsByRuleRequest.builder()
listTargetsByRuleRequest - A Consumer that will call methods on ListTargetsByRuleRequest.Builder to create a request.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEventsResponse putEvents(PutEventsRequest putEventsRequest) throws InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
putEventsRequest - InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutEventsResponse putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest) throws InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
This is a convenience which creates an instance of the PutEventsRequest.Builder avoiding the need to
create one manually via PutEventsRequest.builder()
putEventsRequest - A Consumer that will call methods on PutEventsRequest.Builder to create a request.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPermissionResponse putPermission(PutPermissionRequest putPermissionRequest) throws ResourceNotFoundException, PolicyLengthExceededException, InternalException, ConcurrentModificationException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.
putPermissionRequest - ResourceNotFoundException - An entity that you specified does not exist.PolicyLengthExceededException - The event bus policy is too long. For more information, see the limits.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule or target.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutPermissionResponse putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest) throws ResourceNotFoundException, PolicyLengthExceededException, InternalException, ConcurrentModificationException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.
This is a convenience which creates an instance of the PutPermissionRequest.Builder avoiding the need to
create one manually via PutPermissionRequest.builder()
putPermissionRequest - A Consumer that will call methods on PutPermissionRequest.Builder to create a request.ResourceNotFoundException - An entity that you specified does not exist.PolicyLengthExceededException - The event bus policy is too long. For more information, see the limits.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule or target.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRuleResponse putRule(PutRuleRequest putRuleRequest) throws InvalidEventPatternException, LimitExceededException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.
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.
putRuleRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutRuleResponse putRule(Consumer<PutRuleRequest.Builder> putRuleRequest) throws InvalidEventPatternException, LimitExceededException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can disable a rule using DisableRule.
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.
This is a convenience which creates an instance of the PutRuleRequest.Builder avoiding the need to create
one manually via PutRuleRequest.builder()
putRuleRequest - A Consumer that will call methods on PutRuleRequest.Builder to create a request.InvalidEventPatternException - The event pattern is not valid.LimitExceededException - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutTargetsResponse putTargets(PutTargetsRequest putTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for 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.
putTargetsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutTargetsResponse putTargets(Consumer<PutTargetsRequest.Builder> putTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, LimitExceededException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for 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.
This is a convenience which creates an instance of the PutTargetsRequest.Builder avoiding the need to
create one manually via PutTargetsRequest.builder()
putTargetsRequest - A Consumer that will call methods on PutTargetsRequest.Builder to create a request.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemovePermissionResponse removePermission(RemovePermissionRequest removePermissionRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.
removePermissionRequest - ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule or target.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemovePermissionResponse removePermission(Consumer<RemovePermissionRequest.Builder> removePermissionRequest) throws ResourceNotFoundException, InternalException, ConcurrentModificationException, AwsServiceException, SdkClientException, CloudWatchEventsException
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.
This is a convenience which creates an instance of the RemovePermissionRequest.Builder avoiding the need
to create one manually via RemovePermissionRequest.builder()
removePermissionRequest - A Consumer that will call methods on RemovePermissionRequest.Builder to create a request.ResourceNotFoundException - An entity that you specified does not exist.InternalException - This exception occurs due to unexpected causes.ConcurrentModificationException - There is concurrent modification on a rule or target.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTargetsResponse removeTargets(RemoveTargetsRequest removeTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. 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.
removeTargetsRequest - 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.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault RemoveTargetsResponse removeTargets(Consumer<RemoveTargetsRequest.Builder> removeTargetsRequest) throws ResourceNotFoundException, ConcurrentModificationException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.
When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. 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.
This is a convenience which creates an instance of the RemoveTargetsRequest.Builder avoiding the need to
create one manually via RemoveTargetsRequest.builder()
removeTargetsRequest - A Consumer that will call methods on RemoveTargetsRequest.Builder to create a request.ResourceNotFoundException - An entity that you specified does not exist.ConcurrentModificationException - There is concurrent modification on a rule or target.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestEventPatternResponse testEventPattern(TestEventPatternRequest testEventPatternRequest) throws InvalidEventPatternException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Tests whether the specified event pattern matches the provided event.
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, 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.
testEventPatternRequest - InvalidEventPatternException - The event pattern is not valid.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault TestEventPatternResponse testEventPattern(Consumer<TestEventPatternRequest.Builder> testEventPatternRequest) throws InvalidEventPatternException, InternalException, AwsServiceException, SdkClientException, CloudWatchEventsException
Tests whether the specified event pattern matches the provided event.
Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, 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.
This is a convenience which creates an instance of the TestEventPatternRequest.Builder avoiding the need
to create one manually via TestEventPatternRequest.builder()
testEventPatternRequest - A Consumer that will call methods on TestEventPatternRequest.Builder to create a request.InvalidEventPatternException - The event pattern is not valid.InternalException - This exception occurs due to unexpected causes.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudWatchEventsException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.