@Generated(value="software.amazon.awssdk:codegen") public interface CloudWatchEventsAsyncClient 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 predetermined 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 AWS CloudTrail to an Amazon Kinesis data stream for detailed analysis of potential security or availability risks.
Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.
For more information about the features of Amazon 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 CloudWatchEventsAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudWatchEventsAsyncClient. |
static CloudWatchEventsAsyncClient |
create()
Create a
CloudWatchEventsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<DeleteRuleResponse> |
deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
Deletes the specified rule.
|
default CompletableFuture<DeleteRuleResponse> |
deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the specified rule.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<DescribeRuleResponse> |
describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest)
Describes the specified rule.
|
default CompletableFuture<DescribeRuleResponse> |
describeRule(DescribeRuleRequest describeRuleRequest)
Describes the specified rule.
|
default CompletableFuture<DisableRuleResponse> |
disableRule(Consumer<DisableRuleRequest.Builder> disableRuleRequest)
Disables the specified rule.
|
default CompletableFuture<DisableRuleResponse> |
disableRule(DisableRuleRequest disableRuleRequest)
Disables the specified rule.
|
default CompletableFuture<EnableRuleResponse> |
enableRule(Consumer<EnableRuleRequest.Builder> enableRuleRequest)
Enables the specified rule.
|
default CompletableFuture<EnableRuleResponse> |
enableRule(EnableRuleRequest enableRuleRequest)
Enables the specified rule.
|
default CompletableFuture<ListRuleNamesByTargetResponse> |
listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> listRuleNamesByTargetRequest)
Lists the rules for the specified target.
|
default CompletableFuture<ListRuleNamesByTargetResponse> |
listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest)
Lists the rules for the specified target.
|
default CompletableFuture<ListRulesResponse> |
listRules()
Lists your Amazon CloudWatch Events rules.
|
default CompletableFuture<ListRulesResponse> |
listRules(Consumer<ListRulesRequest.Builder> listRulesRequest)
Lists your Amazon CloudWatch Events rules.
|
default CompletableFuture<ListRulesResponse> |
listRules(ListRulesRequest listRulesRequest)
Lists your Amazon CloudWatch Events rules.
|
default CompletableFuture<ListTargetsByRuleResponse> |
listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
|
default CompletableFuture<ListTargetsByRuleResponse> |
listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
|
default CompletableFuture<PutEventsResponse> |
putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
|
default CompletableFuture<PutEventsResponse> |
putEvents(PutEventsRequest putEventsRequest)
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
|
default CompletableFuture<PutPermissionResponse> |
putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest)
Running
PutPermission permits the specified AWS account or AWS organization to put events to your
account's default event bus. |
default CompletableFuture<PutPermissionResponse> |
putPermission(PutPermissionRequest putPermissionRequest)
Running
PutPermission permits the specified AWS account or AWS organization to put events to your
account's default event bus. |
default CompletableFuture<PutRuleResponse> |
putRule(Consumer<PutRuleRequest.Builder> putRuleRequest)
Creates or updates the specified rule.
|
default CompletableFuture<PutRuleResponse> |
putRule(PutRuleRequest putRuleRequest)
Creates or updates the specified rule.
|
default CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<RemovePermissionResponse> |
removePermission(RemovePermissionRequest removePermissionRequest)
Revokes the permission of another AWS account to be able to put events to your default event bus.
|
default CompletableFuture<RemoveTargetsResponse> |
removeTargets(Consumer<RemoveTargetsRequest.Builder> removeTargetsRequest)
Removes the specified targets from the specified rule.
|
default CompletableFuture<RemoveTargetsResponse> |
removeTargets(RemoveTargetsRequest removeTargetsRequest)
Removes the specified targets from the specified rule.
|
default CompletableFuture<TestEventPatternResponse> |
testEventPattern(Consumer<TestEventPatternRequest.Builder> testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
|
default CompletableFuture<TestEventPatternResponse> |
testEventPattern(TestEventPatternRequest testEventPatternRequest)
Tests whether the specified event pattern matches the provided event.
|
serviceNameclosestatic final String SERVICE_NAME
static CloudWatchEventsAsyncClient create()
CloudWatchEventsAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static CloudWatchEventsAsyncClientBuilder builder()
CloudWatchEventsAsyncClient.default CompletableFuture<DeleteRuleResponse> deleteRule(DeleteRuleRequest deleteRuleRequest)
Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by
those other AWS services to support functionality in those services. You can delete these rules using the
Force option, but you should do so only if you are sure the other service is not still using that
rule.
deleteRuleRequest - DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<DeleteRuleResponse> deleteRule(Consumer<DeleteRuleRequest.Builder> deleteRuleRequest)
Deletes the specified rule.
Before you can delete the rule, you must remove all targets, using RemoveTargets.
When you delete a rule, incoming events might continue to match to the deleted rule. Allow a short period of time for changes to take effect.
Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by
those other AWS services to support functionality in those services. You can delete these rules using the
Force option, but you should do so only if you are sure the other service is not still using that
rule.
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.DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<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. To enable your account to receive events from other accounts, use PutPermission.
describeEventBusRequest - default CompletableFuture<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. 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.default CompletableFuture<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. To enable your account to receive events from other accounts, use PutPermission.
default CompletableFuture<DescribeRuleResponse> describeRule(DescribeRuleRequest describeRuleRequest)
Describes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
describeRuleRequest - default CompletableFuture<DescribeRuleResponse> describeRule(Consumer<DescribeRuleRequest.Builder> describeRuleRequest)
Describes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
This is a convenience which creates an instance of the DescribeRuleRequest.Builder avoiding the need to
create one manually via DescribeRuleRequest.builder()
describeRuleRequest - A Consumer that will call methods on DescribeRuleRequest.Builder to create a request.default CompletableFuture<DisableRuleResponse> 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. Allow a short period of time for changes to take effect.
disableRuleRequest - DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<DisableRuleResponse> disableRule(Consumer<DisableRuleRequest.Builder> 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. 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.DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<EnableRuleResponse> 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. Allow a short period of time for changes to take effect.
enableRuleRequest - DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<EnableRuleResponse> enableRule(Consumer<EnableRuleRequest.Builder> 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. 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.DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<ListRuleNamesByTargetResponse> 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.
listRuleNamesByTargetRequest - default CompletableFuture<ListRuleNamesByTargetResponse> listRuleNamesByTarget(Consumer<ListRuleNamesByTargetRequest.Builder> 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.
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.default CompletableFuture<ListRulesResponse> 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.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
listRulesRequest - default CompletableFuture<ListRulesResponse> listRules(Consumer<ListRulesRequest.Builder> 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.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
This is a convenience which creates an instance of the ListRulesRequest.Builder avoiding the need to
create one manually via ListRulesRequest.builder()
listRulesRequest - A Consumer that will call methods on ListRulesRequest.Builder to create a request.default CompletableFuture<ListRulesResponse> listRules()
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.
ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
default CompletableFuture<ListTargetsByRuleResponse> listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest)
Lists the targets assigned to the specified rule.
listTargetsByRuleRequest - default CompletableFuture<ListTargetsByRuleResponse> listTargetsByRule(Consumer<ListTargetsByRuleRequest.Builder> listTargetsByRuleRequest)
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.default CompletableFuture<PutEventsResponse> putEvents(PutEventsRequest putEventsRequest)
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
putEventsRequest - default CompletableFuture<PutEventsResponse> putEvents(Consumer<PutEventsRequest.Builder> putEventsRequest)
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.default CompletableFuture<PutPermissionResponse> putPermission(PutPermissionRequest putPermissionRequest)
Running PutPermission permits the specified AWS account or AWS organization 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. Or, if all the accounts are members of the same AWS organization, you can run
PutPermission once specifying Principal as "*" and specifying the AWS organization ID
in Condition, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must specify a
RoleArn with proper permissions when they use PutTarget to add your account's event bus
as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide.
The permission policy on the default event bus cannot exceed 10 KB in size.
putPermissionRequest - default CompletableFuture<PutPermissionResponse> putPermission(Consumer<PutPermissionRequest.Builder> putPermissionRequest)
Running PutPermission permits the specified AWS account or AWS organization 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. Or, if all the accounts are members of the same AWS organization, you can run
PutPermission once specifying Principal as "*" and specifying the AWS organization ID
in Condition, to grant permissions to all accounts in that organization.
If you grant permissions using an organization, then accounts in that organization must specify a
RoleArn with proper permissions when they use PutTarget to add your account's event bus
as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide.
The permission policy on the default event bus cannot exceed 10 KB in size.
This is a convenience which creates an instance of the PutPermissionRequest.Builder avoiding the need to
create one manually via PutPermissionRequest.builder()
putPermissionRequest - A Consumer that will call methods on PutPermissionRequest.Builder to create a request.default CompletableFuture<PutRuleResponse> 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.
If you are updating an existing rule, the rule is replaced with what you specify in this PutRule
command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead,
they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
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.
In CloudWatch Events, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
putRuleRequest - DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<PutRuleResponse> putRule(Consumer<PutRuleRequest.Builder> 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.
If you are updating an existing rule, the rule is replaced with what you specify in this PutRule
command. If you omit arguments in PutRule, the old values for those arguments are not kept. Instead,
they are replaced with null values.
When you create or update a rule, incoming events might not immediately start matching to new or updated rules. Allow a short period of time for changes to take effect.
A rule must contain at least an EventPattern or ScheduleExpression. Rules with EventPatterns are triggered when a matching event is observed. Rules with ScheduleExpressions self-trigger based on the given schedule. A rule can have both an EventPattern and a ScheduleExpression, in which case the rule triggers on matching events as well as on a schedule.
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.
In CloudWatch Events, it is possible to create rules that lead to infinite loops, where a rule is fired repeatedly. For example, a rule might detect that ACLs have changed on an S3 bucket, and trigger software to change them to the desired state. If the rule is not written carefully, the subsequent change to the ACLs fires the rule again, creating an infinite loop.
To prevent this, write the rules so that the triggered actions do not re-fire the same rule. For example, your rule could fire only if ACLs are found to be in a bad state, instead of after any change.
An infinite loop can quickly cause higher than expected charges. We recommend that you use budgeting, which alerts you when charges exceed your specified limit. For more information, see Managing Your Costs with Budgets.
This is a convenience which creates an instance of the PutRuleRequest.Builder avoiding the need to create
one manually via PutRuleRequest.builder()
putRuleRequest - A Consumer that will call methods on PutRuleRequest.Builder to create a request.DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<PutTargetsResponse> 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
SSM Run Command
SSM Automation
AWS Lambda functions
Data streams in Amazon Kinesis Data Streams
Data delivery streams in Amazon Kinesis Data Firehose
Amazon ECS tasks
AWS Step Functions state machines
AWS Batch jobs
AWS CodeBuild projects
Pipelines in AWS CodePipeline
Amazon Inspector assessment templates
Amazon SNS topics
Amazon SQS queues, including FIFO queues
The default event bus of another AWS account
Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are
EC2 CreateSnapshot API call, EC2 RebootInstances API call,
EC2 StopInstances API call, and EC2 TerminateInstances API call.
For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis
data stream, you can optionally specify which shard the event goes to by using the KinesisParameters
argument. To invoke a command on multiple EC2 instances with one rule, you can use the
RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate
permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For
EC2 instances, Kinesis data 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. Set that account's event bus as a target of the rules in your account. To
send the matched events to the other account, specify that account's event bus as the Arn value when
you run PutTargets. If your account sends events to another account, your account is charged for
each sent event. Each event sent to another account is charged as a custom event. The account receiving the event
is not charged. For more information, see Amazon CloudWatch
Pricing.
If you are setting the event bus of another account as the target, and that account granted permission to your
account through an organization instead of directly by the account ID, then you must specify a
RoleArn with proper permissions in the Target structure. For more information, see
Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide.
For more information about enabling cross-account events, see PutPermission.
Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.detail), then only the
part of the event specified in the path is passed to the target (for example, only the detail part of the event
is passed).
If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
When you specify InputPath or InputTransformer, you must use JSON dot notation, not
bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens,
FailedEntryCount is non-zero in the response and each entry in FailedEntries provides
the ID of the failed target and the error code.
putTargetsRequest - DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<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.
Targets are the resources that are invoked when a rule is triggered.
You can configure the following as targets for CloudWatch Events:
EC2 instances
SSM Run Command
SSM Automation
AWS Lambda functions
Data streams in Amazon Kinesis Data Streams
Data delivery streams in Amazon Kinesis Data Firehose
Amazon ECS tasks
AWS Step Functions state machines
AWS Batch jobs
AWS CodeBuild projects
Pipelines in AWS CodePipeline
Amazon Inspector assessment templates
Amazon SNS topics
Amazon SQS queues, including FIFO queues
The default event bus of another AWS account
Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are
EC2 CreateSnapshot API call, EC2 RebootInstances API call,
EC2 StopInstances API call, and EC2 TerminateInstances API call.
For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis
data stream, you can optionally specify which shard the event goes to by using the KinesisParameters
argument. To invoke a command on multiple EC2 instances with one rule, you can use the
RunCommandParameters field.
To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate
permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For
EC2 instances, Kinesis data 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. Set that account's event bus as a target of the rules in your account. To
send the matched events to the other account, specify that account's event bus as the Arn value when
you run PutTargets. If your account sends events to another account, your account is charged for
each sent event. Each event sent to another account is charged as a custom event. The account receiving the event
is not charged. For more information, see Amazon CloudWatch
Pricing.
If you are setting the event bus of another account as the target, and that account granted permission to your
account through an organization instead of directly by the account ID, then you must specify a
RoleArn with proper permissions in the Target structure. For more information, see
Sending and Receiving Events Between AWS Accounts in the Amazon CloudWatch Events User Guide.
For more information about enabling cross-account events, see PutPermission.
Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:
If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).
If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.
If InputPath is specified in the form of JSONPath (for example, $.detail), then only the
part of the event specified in the path is passed to the target (for example, only the detail part of the event
is passed).
If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.
When you specify InputPath or InputTransformer, you must use JSON dot notation, not
bracket notation.
When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.
This action can partially fail if too many requests are made at the same time. If that happens,
FailedEntryCount is non-zero in the response and each entry in FailedEntries provides
the ID of the failed target and the error code.
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.DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<RemovePermissionResponse> 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.
removePermissionRequest - default CompletableFuture<RemovePermissionResponse> removePermission(Consumer<RemovePermissionRequest.Builder> 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.
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.default CompletableFuture<RemoveTargetsResponse> 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. 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 - DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<RemoveTargetsResponse> removeTargets(Consumer<RemoveTargetsRequest.Builder> 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. 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.DeleteRule or
RemoveTargets, you can use the Force parameter in those calls to delete the
rule or remove targets from the rule. You cannot modify these managed rules by using
DisableRule, EnableRule, PutTargets, or PutRule.default CompletableFuture<TestEventPatternResponse> 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.
testEventPatternRequest - default CompletableFuture<TestEventPatternResponse> testEventPattern(Consumer<TestEventPatternRequest.Builder> 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.
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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.