@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonCloudWatchEventsAsync extends AbstractAmazonCloudWatchEvents implements AmazonCloudWatchEventsAsync
AmazonCloudWatchEventsAsync. Convenient method forms pass through to the
corresponding overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<DeleteRuleResult> |
deleteRuleAsync(DeleteRuleRequest request)
Deletes the specified rule.
|
Future<DeleteRuleResult> |
deleteRuleAsync(DeleteRuleRequest request,
AsyncHandler<DeleteRuleRequest,DeleteRuleResult> asyncHandler)
Deletes the specified rule.
|
Future<DescribeEventBusResult> |
describeEventBusAsync(DescribeEventBusRequest request)
Displays the external AWS accounts that are permitted to write events to your account using your account's event
bus, and the associated policy.
|
Future<DescribeEventBusResult> |
describeEventBusAsync(DescribeEventBusRequest request,
AsyncHandler<DescribeEventBusRequest,DescribeEventBusResult> asyncHandler)
Displays the external AWS accounts that are permitted to write events to your account using your account's event
bus, and the associated policy.
|
Future<DescribeRuleResult> |
describeRuleAsync(DescribeRuleRequest request)
Describes the specified rule.
|
Future<DescribeRuleResult> |
describeRuleAsync(DescribeRuleRequest request,
AsyncHandler<DescribeRuleRequest,DescribeRuleResult> asyncHandler)
Describes the specified rule.
|
Future<DisableRuleResult> |
disableRuleAsync(DisableRuleRequest request)
Disables the specified rule.
|
Future<DisableRuleResult> |
disableRuleAsync(DisableRuleRequest request,
AsyncHandler<DisableRuleRequest,DisableRuleResult> asyncHandler)
Disables the specified rule.
|
Future<EnableRuleResult> |
enableRuleAsync(EnableRuleRequest request)
Enables the specified rule.
|
Future<EnableRuleResult> |
enableRuleAsync(EnableRuleRequest request,
AsyncHandler<EnableRuleRequest,EnableRuleResult> asyncHandler)
Enables the specified rule.
|
Future<ListRuleNamesByTargetResult> |
listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest request)
Lists the rules for the specified target.
|
Future<ListRuleNamesByTargetResult> |
listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest request,
AsyncHandler<ListRuleNamesByTargetRequest,ListRuleNamesByTargetResult> asyncHandler)
Lists the rules for the specified target.
|
Future<ListRulesResult> |
listRulesAsync(ListRulesRequest request)
Lists your Amazon CloudWatch Events rules.
|
Future<ListRulesResult> |
listRulesAsync(ListRulesRequest request,
AsyncHandler<ListRulesRequest,ListRulesResult> asyncHandler)
Lists your Amazon CloudWatch Events rules.
|
Future<ListTargetsByRuleResult> |
listTargetsByRuleAsync(ListTargetsByRuleRequest request)
Lists the targets assigned to the specified rule.
|
Future<ListTargetsByRuleResult> |
listTargetsByRuleAsync(ListTargetsByRuleRequest request,
AsyncHandler<ListTargetsByRuleRequest,ListTargetsByRuleResult> asyncHandler)
Lists the targets assigned to the specified rule.
|
Future<PutEventsResult> |
putEventsAsync(PutEventsRequest request)
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
|
Future<PutEventsResult> |
putEventsAsync(PutEventsRequest request,
AsyncHandler<PutEventsRequest,PutEventsResult> asyncHandler)
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
|
Future<PutPermissionResult> |
putPermissionAsync(PutPermissionRequest request)
Running
PutPermission permits the specified AWS account or AWS organization to put events to your
account's default event bus. |
Future<PutPermissionResult> |
putPermissionAsync(PutPermissionRequest request,
AsyncHandler<PutPermissionRequest,PutPermissionResult> asyncHandler)
Running
PutPermission permits the specified AWS account or AWS organization to put events to your
account's default event bus. |
Future<PutRuleResult> |
putRuleAsync(PutRuleRequest request)
Creates or updates the specified rule.
|
Future<PutRuleResult> |
putRuleAsync(PutRuleRequest request,
AsyncHandler<PutRuleRequest,PutRuleResult> asyncHandler)
Creates or updates the specified rule.
|
Future<PutTargetsResult> |
putTargetsAsync(PutTargetsRequest request)
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the
rule.
|
Future<PutTargetsResult> |
putTargetsAsync(PutTargetsRequest request,
AsyncHandler<PutTargetsRequest,PutTargetsResult> asyncHandler)
Adds the specified targets to the specified rule, or updates the targets if they are already associated with the
rule.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest request)
Revokes the permission of another AWS account to be able to put events to your default event bus.
|
Future<RemovePermissionResult> |
removePermissionAsync(RemovePermissionRequest request,
AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
Revokes the permission of another AWS account to be able to put events to your default event bus.
|
Future<RemoveTargetsResult> |
removeTargetsAsync(RemoveTargetsRequest request)
Removes the specified targets from the specified rule.
|
Future<RemoveTargetsResult> |
removeTargetsAsync(RemoveTargetsRequest request,
AsyncHandler<RemoveTargetsRequest,RemoveTargetsResult> asyncHandler)
Removes the specified targets from the specified rule.
|
Future<TestEventPatternResult> |
testEventPatternAsync(TestEventPatternRequest request)
Tests whether the specified event pattern matches the provided event.
|
Future<TestEventPatternResult> |
testEventPatternAsync(TestEventPatternRequest request,
AsyncHandler<TestEventPatternRequest,TestEventPatternResult> asyncHandler)
Tests whether the specified event pattern matches the provided event.
|
deleteRule, describeEventBus, describeRule, disableRule, enableRule, getCachedResponseMetadata, listRuleNamesByTarget, listRules, listTargetsByRule, putEvents, putPermission, putRule, putTargets, removePermission, removeTargets, setEndpoint, setRegion, shutdown, testEventPatternequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdeleteRule, describeEventBus, describeRule, disableRule, enableRule, getCachedResponseMetadata, listRuleNamesByTarget, listRules, listTargetsByRule, putEvents, putPermission, putRule, putTargets, removePermission, removeTargets, setEndpoint, setRegion, shutdown, testEventPatternpublic Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request)
AmazonCloudWatchEventsAsyncDeletes 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.
deleteRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request, AsyncHandler<DeleteRuleRequest,DeleteRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncDeletes 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.
deleteRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEventBusResult> describeEventBusAsync(DescribeEventBusRequest request)
AmazonCloudWatchEventsAsyncDisplays 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.
describeEventBusAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribeEventBusResult> describeEventBusAsync(DescribeEventBusRequest request, AsyncHandler<DescribeEventBusRequest,DescribeEventBusResult> asyncHandler)
AmazonCloudWatchEventsAsyncDisplays 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.
describeEventBusAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest request)
AmazonCloudWatchEventsAsyncDescribes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
describeRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest request, AsyncHandler<DescribeRuleRequest,DescribeRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncDescribes the specified rule.
DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
describeRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DisableRuleResult> disableRuleAsync(DisableRuleRequest request)
AmazonCloudWatchEventsAsyncDisables 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.
disableRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<DisableRuleResult> disableRuleAsync(DisableRuleRequest request, AsyncHandler<DisableRuleRequest,DisableRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncDisables 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.
disableRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EnableRuleResult> enableRuleAsync(EnableRuleRequest request)
AmazonCloudWatchEventsAsyncEnables 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.
enableRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<EnableRuleResult> enableRuleAsync(EnableRuleRequest request, AsyncHandler<EnableRuleRequest,EnableRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncEnables 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.
enableRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRuleNamesByTargetResult> listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest request)
AmazonCloudWatchEventsAsyncLists 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.
listRuleNamesByTargetAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListRuleNamesByTargetResult> listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest request, AsyncHandler<ListRuleNamesByTargetRequest,ListRuleNamesByTargetResult> asyncHandler)
AmazonCloudWatchEventsAsyncLists 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.
listRuleNamesByTargetAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListRulesResult> listRulesAsync(ListRulesRequest request)
AmazonCloudWatchEventsAsyncLists 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.
listRulesAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListRulesResult> listRulesAsync(ListRulesRequest request, AsyncHandler<ListRulesRequest,ListRulesResult> asyncHandler)
AmazonCloudWatchEventsAsyncLists 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.
listRulesAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ListTargetsByRuleResult> listTargetsByRuleAsync(ListTargetsByRuleRequest request)
AmazonCloudWatchEventsAsyncLists the targets assigned to the specified rule.
listTargetsByRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<ListTargetsByRuleResult> listTargetsByRuleAsync(ListTargetsByRuleRequest request, AsyncHandler<ListTargetsByRuleRequest,ListTargetsByRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncLists the targets assigned to the specified rule.
listTargetsByRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutEventsResult> putEventsAsync(PutEventsRequest request)
AmazonCloudWatchEventsAsyncSends custom events to Amazon CloudWatch Events so that they can be matched to rules.
putEventsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<PutEventsResult> putEventsAsync(PutEventsRequest request, AsyncHandler<PutEventsRequest,PutEventsResult> asyncHandler)
AmazonCloudWatchEventsAsyncSends custom events to Amazon CloudWatch Events so that they can be matched to rules.
putEventsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutPermissionResult> putPermissionAsync(PutPermissionRequest request)
AmazonCloudWatchEventsAsync
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.
putPermissionAsync in interface AmazonCloudWatchEventsAsyncpublic Future<PutPermissionResult> putPermissionAsync(PutPermissionRequest request, AsyncHandler<PutPermissionRequest,PutPermissionResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
putPermissionAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutRuleResult> putRuleAsync(PutRuleRequest request)
AmazonCloudWatchEventsAsyncCreates 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.
putRuleAsync in interface AmazonCloudWatchEventsAsyncpublic Future<PutRuleResult> putRuleAsync(PutRuleRequest request, AsyncHandler<PutRuleRequest,PutRuleResult> asyncHandler)
AmazonCloudWatchEventsAsyncCreates 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.
putRuleAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<PutTargetsResult> putTargetsAsync(PutTargetsRequest request)
AmazonCloudWatchEventsAsyncAdds 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.
putTargetsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<PutTargetsResult> putTargetsAsync(PutTargetsRequest request, AsyncHandler<PutTargetsRequest,PutTargetsResult> asyncHandler)
AmazonCloudWatchEventsAsyncAdds 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.
putTargetsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest request)
AmazonCloudWatchEventsAsync
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.
removePermissionAsync in interface AmazonCloudWatchEventsAsyncpublic Future<RemovePermissionResult> removePermissionAsync(RemovePermissionRequest request, AsyncHandler<RemovePermissionRequest,RemovePermissionResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
removePermissionAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<RemoveTargetsResult> removeTargetsAsync(RemoveTargetsRequest request)
AmazonCloudWatchEventsAsyncRemoves 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.
removeTargetsAsync in interface AmazonCloudWatchEventsAsyncpublic Future<RemoveTargetsResult> removeTargetsAsync(RemoveTargetsRequest request, AsyncHandler<RemoveTargetsRequest,RemoveTargetsResult> asyncHandler)
AmazonCloudWatchEventsAsyncRemoves 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.
removeTargetsAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<TestEventPatternResult> testEventPatternAsync(TestEventPatternRequest request)
AmazonCloudWatchEventsAsyncTests 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.
testEventPatternAsync in interface AmazonCloudWatchEventsAsyncpublic Future<TestEventPatternResult> testEventPatternAsync(TestEventPatternRequest request, AsyncHandler<TestEventPatternRequest,TestEventPatternResult> asyncHandler)
AmazonCloudWatchEventsAsyncTests 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.
testEventPatternAsync in interface AmazonCloudWatchEventsAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.