Interface AmazonCloudWatchEventsAsync
- All Superinterfaces:
AmazonCloudWatchEvents
- All Known Implementing Classes:
AbstractAmazonCloudWatchEventsAsync
,AmazonCloudWatchEventsAsyncClient
AsyncHandler
can be
used to receive notification when an asynchronous operation completes.
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 Amazon CloudWatch Events features, see the Amazon CloudWatch Developer Guide.
-
Method Summary
Modifier and TypeMethodDescriptiondeleteRuleAsync
(DeleteRuleRequest deleteRuleRequest) Deletes a rule.deleteRuleAsync
(DeleteRuleRequest deleteRuleRequest, AsyncHandler<DeleteRuleRequest, DeleteRuleResult> asyncHandler) Deletes a rule.describeRuleAsync
(DescribeRuleRequest describeRuleRequest) Describes the details of the specified rule.describeRuleAsync
(DescribeRuleRequest describeRuleRequest, AsyncHandler<DescribeRuleRequest, DescribeRuleResult> asyncHandler) Describes the details of the specified rule.disableRuleAsync
(DisableRuleRequest disableRuleRequest) Disables a rule.disableRuleAsync
(DisableRuleRequest disableRuleRequest, AsyncHandler<DisableRuleRequest, DisableRuleResult> asyncHandler) Disables a rule.enableRuleAsync
(EnableRuleRequest enableRuleRequest) Enables a rule.enableRuleAsync
(EnableRuleRequest enableRuleRequest, AsyncHandler<EnableRuleRequest, EnableRuleResult> asyncHandler) Enables a rule.listRuleNamesByTargetAsync
(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest) Lists the names of the rules that the given target is put to.listRuleNamesByTargetAsync
(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest, AsyncHandler<ListRuleNamesByTargetRequest, ListRuleNamesByTargetResult> asyncHandler) Lists the names of the rules that the given target is put to.listRulesAsync
(ListRulesRequest listRulesRequest) Lists the Amazon CloudWatch Events rules in your account.listRulesAsync
(ListRulesRequest listRulesRequest, AsyncHandler<ListRulesRequest, ListRulesResult> asyncHandler) Lists the Amazon CloudWatch Events rules in your account.listTargetsByRuleAsync
(ListTargetsByRuleRequest listTargetsByRuleRequest) Lists of targets assigned to the rule.listTargetsByRuleAsync
(ListTargetsByRuleRequest listTargetsByRuleRequest, AsyncHandler<ListTargetsByRuleRequest, ListTargetsByRuleResult> asyncHandler) Lists of targets assigned to the rule.putEventsAsync
(PutEventsRequest putEventsRequest) Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.putEventsAsync
(PutEventsRequest putEventsRequest, AsyncHandler<PutEventsRequest, PutEventsResult> asyncHandler) Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.putRuleAsync
(PutRuleRequest putRuleRequest) Creates or updates a rule.putRuleAsync
(PutRuleRequest putRuleRequest, AsyncHandler<PutRuleRequest, PutRuleResult> asyncHandler) Creates or updates a rule.putTargetsAsync
(PutTargetsRequest putTargetsRequest) Adds target(s) to a rule.putTargetsAsync
(PutTargetsRequest putTargetsRequest, AsyncHandler<PutTargetsRequest, PutTargetsResult> asyncHandler) Adds target(s) to a rule.removeTargetsAsync
(RemoveTargetsRequest removeTargetsRequest) Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked.removeTargetsAsync
(RemoveTargetsRequest removeTargetsRequest, AsyncHandler<RemoveTargetsRequest, RemoveTargetsResult> asyncHandler) Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked.testEventPatternAsync
(TestEventPatternRequest testEventPatternRequest) Tests whether an event pattern matches the provided event.testEventPatternAsync
(TestEventPatternRequest testEventPatternRequest, AsyncHandler<TestEventPatternRequest, TestEventPatternResult> asyncHandler) Tests whether an event pattern matches the provided event.Methods inherited from interface com.amazonaws.services.cloudwatchevents.AmazonCloudWatchEvents
deleteRule, describeRule, disableRule, enableRule, getCachedResponseMetadata, listRuleNamesByTarget, listRules, listTargetsByRule, putEvents, putRule, putTargets, removeTargets, setEndpoint, setRegion, shutdown, testEventPattern
-
Method Details
-
deleteRuleAsync
Deletes a rule. You must remove all targets from a rule using RemoveTargets before you can delete the rule.
Note: When you delete a rule, incoming events might still continue to match to the deleted rule. Please allow a short period of time for changes to take effect.
- Parameters:
deleteRuleRequest
- Container for the parameters to the DeleteRule operation.- Returns:
- A Java Future containing the result of the DeleteRule operation returned by the service.
-
deleteRuleAsync
Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest deleteRuleRequest, AsyncHandler<DeleteRuleRequest, DeleteRuleResult> asyncHandler) Deletes a rule. You must remove all targets from a rule using RemoveTargets before you can delete the rule.
Note: When you delete a rule, incoming events might still continue to match to the deleted rule. Please allow a short period of time for changes to take effect.
- Parameters:
deleteRuleRequest
- Container for the parameters to the DeleteRule operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the DeleteRule operation returned by the service.
-
describeRuleAsync
Describes the details of the specified rule.
- Parameters:
describeRuleRequest
- Container for the parameters to the DescribeRule operation.- Returns:
- A Java Future containing the result of the DescribeRule operation returned by the service.
-
describeRuleAsync
Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest describeRuleRequest, AsyncHandler<DescribeRuleRequest, DescribeRuleResult> asyncHandler) Describes the details of the specified rule.
- Parameters:
describeRuleRequest
- Container for the parameters to the DescribeRule operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the DescribeRule operation returned by the service.
-
disableRuleAsync
Disables a rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.
Note: When you disable a rule, incoming events might still continue to match to the disabled rule. Please allow a short period of time for changes to take effect.
- Parameters:
disableRuleRequest
- Container for the parameters to the DisableRule operation.- Returns:
- A Java Future containing the result of the DisableRule operation returned by the service.
-
disableRuleAsync
Future<DisableRuleResult> disableRuleAsync(DisableRuleRequest disableRuleRequest, AsyncHandler<DisableRuleRequest, DisableRuleResult> asyncHandler) Disables a rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.
Note: When you disable a rule, incoming events might still continue to match to the disabled rule. Please allow a short period of time for changes to take effect.
- Parameters:
disableRuleRequest
- Container for the parameters to the DisableRule operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the DisableRule operation returned by the service.
-
enableRuleAsync
Enables a rule. If the rule does not exist, the operation fails.
Note: When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.
- Parameters:
enableRuleRequest
- Container for the parameters to the EnableRule operation.- Returns:
- A Java Future containing the result of the EnableRule operation returned by the service.
-
enableRuleAsync
Future<EnableRuleResult> enableRuleAsync(EnableRuleRequest enableRuleRequest, AsyncHandler<EnableRuleRequest, EnableRuleResult> asyncHandler) Enables a rule. If the rule does not exist, the operation fails.
Note: When you enable a rule, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.
- Parameters:
enableRuleRequest
- Container for the parameters to the EnableRule operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the EnableRule operation returned by the service.
-
listRuleNamesByTargetAsync
Future<ListRuleNamesByTargetResult> listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest) Lists the names of the rules that the given target is put to. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRulesByTarget until the NextToken in the response is returned as null.
- Parameters:
listRuleNamesByTargetRequest
- Container for the parameters to the ListRuleNamesByTarget operation.- Returns:
- A Java Future containing the result of the ListRuleNamesByTarget operation returned by the service.
-
listRuleNamesByTargetAsync
Future<ListRuleNamesByTargetResult> listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest, AsyncHandler<ListRuleNamesByTargetRequest, ListRuleNamesByTargetResult> asyncHandler) Lists the names of the rules that the given target is put to. You can see which of the rules in Amazon CloudWatch Events can invoke a specific target in your account. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRulesByTarget until the NextToken in the response is returned as null.
- Parameters:
listRuleNamesByTargetRequest
- Container for the parameters to the ListRuleNamesByTarget operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the ListRuleNamesByTarget operation returned by the service.
-
listRulesAsync
Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRules until the NextToken in the response is returned as null.
- Parameters:
listRulesRequest
- Container for the parameters to the ListRules operation.- Returns:
- A Java Future containing the result of the ListRules operation returned by the service.
-
listRulesAsync
Future<ListRulesResult> listRulesAsync(ListRulesRequest listRulesRequest, AsyncHandler<ListRulesRequest, ListRulesResult> asyncHandler) Lists the Amazon CloudWatch Events rules in your account. You can either list all the rules or you can provide a prefix to match to the rule names. If you have more rules in your account than the given limit, the results will be paginated. In that case, use the next token returned in the response and repeat ListRules until the NextToken in the response is returned as null.
- Parameters:
listRulesRequest
- Container for the parameters to the ListRules operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the ListRules operation returned by the service.
-
listTargetsByRuleAsync
Future<ListTargetsByRuleResult> listTargetsByRuleAsync(ListTargetsByRuleRequest listTargetsByRuleRequest) Lists of targets assigned to the rule.
- Parameters:
listTargetsByRuleRequest
- Container for the parameters to the ListTargetsByRule operation.- Returns:
- A Java Future containing the result of the ListTargetsByRule operation returned by the service.
-
listTargetsByRuleAsync
Future<ListTargetsByRuleResult> listTargetsByRuleAsync(ListTargetsByRuleRequest listTargetsByRuleRequest, AsyncHandler<ListTargetsByRuleRequest, ListTargetsByRuleResult> asyncHandler) Lists of targets assigned to the rule.
- Parameters:
listTargetsByRuleRequest
- Container for the parameters to the ListTargetsByRule operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the ListTargetsByRule operation returned by the service.
-
putEventsAsync
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
- Parameters:
putEventsRequest
- Container for the parameters to the PutEvents operation.- Returns:
- A Java Future containing the result of the PutEvents operation returned by the service.
-
putEventsAsync
Future<PutEventsResult> putEventsAsync(PutEventsRequest putEventsRequest, AsyncHandler<PutEventsRequest, PutEventsResult> asyncHandler) Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
- Parameters:
putEventsRequest
- Container for the parameters to the PutEvents operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the PutEvents operation returned by the service.
-
putRuleAsync
Creates or updates a rule. Rules are enabled by default, or based on value of the State parameter. You can disable a rule using DisableRule.
Note: 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 will trigger on matching events as well as on a schedule.
Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
- Parameters:
putRuleRequest
- Container for the parameters to the PutRule operation.- Returns:
- A Java Future containing the result of the PutRule operation returned by the service.
-
putRuleAsync
Future<PutRuleResult> putRuleAsync(PutRuleRequest putRuleRequest, AsyncHandler<PutRuleRequest, PutRuleResult> asyncHandler) Creates or updates a rule. Rules are enabled by default, or based on value of the State parameter. You can disable a rule using DisableRule.
Note: 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 will trigger on matching events as well as on a schedule.
Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
- Parameters:
putRuleRequest
- Container for the parameters to the PutRule operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the PutRule operation returned by the service.
-
putTargetsAsync
Adds target(s) to a rule. Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets. Updates the target(s) if they are already associated with the role. In other words, if there is already a target with the given target ID, then the target associated with that ID is updated.
In order to be able to make API calls against the resources you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For Amazon Kinesis streams, CloudWatch Events relies on IAM roles. For more information, see Permissions for Sending Events to Targets in the Amazon CloudWatch Developer Guide.
Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target:
- Neither Input nor InputPath is specified, then the entire event is passed to the target in JSON form.
- InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed).
- Input is specified in the form of a valid JSON, then the matched event is overridden with this constant.
Note: When you add targets to a rule, when the associated rule triggers, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.
- Parameters:
putTargetsRequest
- Container for the parameters to the PutTargets operation.- Returns:
- A Java Future containing the result of the PutTargets operation returned by the service.
-
putTargetsAsync
Future<PutTargetsResult> putTargetsAsync(PutTargetsRequest putTargetsRequest, AsyncHandler<PutTargetsRequest, PutTargetsResult> asyncHandler) Adds target(s) to a rule. Targets are the resources that can be invoked when a rule is triggered. For example, AWS Lambda functions, Amazon Kinesis streams, and built-in targets. Updates the target(s) if they are already associated with the role. In other words, if there is already a target with the given target ID, then the target associated with that ID is updated.
In order to be able to make API calls against the resources you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, CloudWatch Events relies on resource-based policies. For Amazon Kinesis streams, CloudWatch Events relies on IAM roles. For more information, see Permissions for Sending Events to Targets in the Amazon CloudWatch Developer Guide.
Input and InputPath are mutually-exclusive and optional parameters of a target. When a rule is triggered due to a matched event, if for a target:
- Neither Input nor InputPath is specified, then the entire event is passed to the target in JSON form.
- InputPath is specified in the form of JSONPath (e.g. $.detail), then only the part of the event specified in the path is passed to the target (e.g. only the detail part of the event is passed).
- Input is specified in the form of a valid JSON, then the matched event is overridden with this constant.
Note: When you add targets to a rule, when the associated rule triggers, new or updated targets might not be immediately invoked. Please allow a short period of time for changes to take effect.
- Parameters:
putTargetsRequest
- Container for the parameters to the PutTargets operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the PutTargets operation returned by the service.
-
removeTargetsAsync
Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked.
Note: When you remove a target, when the associated rule triggers, removed targets might still continue to be invoked. Please allow a short period of time for changes to take effect.
- Parameters:
removeTargetsRequest
- Container for the parameters to the RemoveTargets operation.- Returns:
- A Java Future containing the result of the RemoveTargets operation returned by the service.
-
removeTargetsAsync
Future<RemoveTargetsResult> removeTargetsAsync(RemoveTargetsRequest removeTargetsRequest, AsyncHandler<RemoveTargetsRequest, RemoveTargetsResult> asyncHandler) Removes target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked.
Note: When you remove a target, when the associated rule triggers, removed targets might still continue to be invoked. Please allow a short period of time for changes to take effect.
- Parameters:
removeTargetsRequest
- Container for the parameters to the RemoveTargets operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the RemoveTargets operation returned by the service.
-
testEventPatternAsync
Future<TestEventPatternResult> testEventPatternAsync(TestEventPatternRequest testEventPatternRequest) Tests whether an event pattern matches the provided event.
Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
- Parameters:
testEventPatternRequest
- Container for the parameters to the TestEventPattern operation.- Returns:
- A Java Future containing the result of the TestEventPattern operation returned by the service.
-
testEventPatternAsync
Future<TestEventPatternResult> testEventPatternAsync(TestEventPatternRequest testEventPatternRequest, AsyncHandler<TestEventPatternRequest, TestEventPatternResult> asyncHandler) Tests whether an event pattern matches the provided event.
Note: Most services in AWS treat : or / as the same character in Amazon Resource Names (ARNs). However, CloudWatch Events uses an exact match in event patterns and rules. Be sure to use the correct ARN characters when creating event patterns so that they match the ARN syntax in the event you want to match.
- Parameters:
testEventPatternRequest
- Container for the parameters to the TestEventPattern operation.asyncHandler
- 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.- Returns:
- A Java Future containing the result of the TestEventPattern operation returned by the service.
-