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
deleteRule, describeRule, disableRule, enableRule, getCachedResponseMetadata, listRuleNamesByTarget, listRules, listTargetsByRule, putEvents, putRule, putTargets, removeTargets, setEndpoint, setRegion, shutdown, testEventPattern
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
deleteRule, describeRule, disableRule, enableRule, getCachedResponseMetadata, listRuleNamesByTarget, listRules, listTargetsByRule, putEvents, putRule, putTargets, removeTargets, setEndpoint, setRegion, shutdown, testEventPattern
public Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request)
AmazonCloudWatchEventsAsync
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.
deleteRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the DeleteRule operation.public Future<DeleteRuleResult> deleteRuleAsync(DeleteRuleRequest request, AsyncHandler<DeleteRuleRequest,DeleteRuleResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
deleteRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest request)
AmazonCloudWatchEventsAsync
Describes the details of the specified rule.
describeRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the DescribeRule operation.public Future<DescribeRuleResult> describeRuleAsync(DescribeRuleRequest request, AsyncHandler<DescribeRuleRequest,DescribeRuleResult> asyncHandler)
AmazonCloudWatchEventsAsync
Describes the details of the specified rule.
describeRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<DisableRuleResult> disableRuleAsync(DisableRuleRequest request)
AmazonCloudWatchEventsAsync
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.
disableRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the DisableRule operation.public Future<DisableRuleResult> disableRuleAsync(DisableRuleRequest request, AsyncHandler<DisableRuleRequest,DisableRuleResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
disableRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<EnableRuleResult> enableRuleAsync(EnableRuleRequest request)
AmazonCloudWatchEventsAsync
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.
enableRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the EnableRule operation.public Future<EnableRuleResult> enableRuleAsync(EnableRuleRequest request, AsyncHandler<EnableRuleRequest,EnableRuleResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
enableRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<ListRuleNamesByTargetResult> listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest request)
AmazonCloudWatchEventsAsync
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.
listRuleNamesByTargetAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the ListRuleNamesByTarget operation.public Future<ListRuleNamesByTargetResult> listRuleNamesByTargetAsync(ListRuleNamesByTargetRequest request, AsyncHandler<ListRuleNamesByTargetRequest,ListRuleNamesByTargetResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
listRuleNamesByTargetAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<ListRulesResult> listRulesAsync(ListRulesRequest request)
AmazonCloudWatchEventsAsync
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.
listRulesAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the ListRules operation.public Future<ListRulesResult> listRulesAsync(ListRulesRequest request, AsyncHandler<ListRulesRequest,ListRulesResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
listRulesAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<ListTargetsByRuleResult> listTargetsByRuleAsync(ListTargetsByRuleRequest request)
AmazonCloudWatchEventsAsync
Lists of targets assigned to the rule.
listTargetsByRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the ListTargetsByRule operation.public Future<ListTargetsByRuleResult> listTargetsByRuleAsync(ListTargetsByRuleRequest request, AsyncHandler<ListTargetsByRuleRequest,ListTargetsByRuleResult> asyncHandler)
AmazonCloudWatchEventsAsync
Lists of targets assigned to the rule.
listTargetsByRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<PutEventsResult> putEventsAsync(PutEventsRequest request)
AmazonCloudWatchEventsAsync
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
putEventsAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the PutEvents operation.public Future<PutEventsResult> putEventsAsync(PutEventsRequest request, AsyncHandler<PutEventsRequest,PutEventsResult> asyncHandler)
AmazonCloudWatchEventsAsync
Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
putEventsAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<PutRuleResult> putRuleAsync(PutRuleRequest request)
AmazonCloudWatchEventsAsync
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.
putRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the PutRule operation.public Future<PutRuleResult> putRuleAsync(PutRuleRequest request, AsyncHandler<PutRuleRequest,PutRuleResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
putRuleAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<PutTargetsResult> putTargetsAsync(PutTargetsRequest request)
AmazonCloudWatchEventsAsync
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:
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.
putTargetsAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the PutTargets operation.public Future<PutTargetsResult> putTargetsAsync(PutTargetsRequest request, AsyncHandler<PutTargetsRequest,PutTargetsResult> asyncHandler)
AmazonCloudWatchEventsAsync
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:
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.
putTargetsAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<RemoveTargetsResult> removeTargetsAsync(RemoveTargetsRequest request)
AmazonCloudWatchEventsAsync
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.
removeTargetsAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the RemoveTargets operation.public Future<RemoveTargetsResult> removeTargetsAsync(RemoveTargetsRequest request, AsyncHandler<RemoveTargetsRequest,RemoveTargetsResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
removeTargetsAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.public Future<TestEventPatternResult> testEventPatternAsync(TestEventPatternRequest request)
AmazonCloudWatchEventsAsync
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.
testEventPatternAsync
in interface AmazonCloudWatchEventsAsync
request
- Container for the parameters to the TestEventPattern operation.public Future<TestEventPatternResult> testEventPatternAsync(TestEventPatternRequest request, AsyncHandler<TestEventPatternRequest,TestEventPatternResult> asyncHandler)
AmazonCloudWatchEventsAsync
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.
testEventPatternAsync
in interface AmazonCloudWatchEventsAsync
request
- 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.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.