public class AbstractAmazonCloudWatchEvents extends Object implements AmazonCloudWatchEvents
AmazonCloudWatchEvents. Convenient method
forms pass through to the corresponding overload that takes a request object,
which throws an UnsupportedOperationException.| Modifier and Type | Method and Description |
|---|---|
void |
deleteRule(DeleteRuleRequest request)
Deletes a rule.
|
DescribeRuleResult |
describeRule(DescribeRuleRequest request)
Describes the details of the specified rule.
|
void |
disableRule(DisableRuleRequest request)
Disables a rule.
|
void |
enableRule(EnableRuleRequest request)
Enables a rule.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request,
typically used for debugging issues where a service isn't acting as
expected.
|
ListRuleNamesByTargetResult |
listRuleNamesByTarget(ListRuleNamesByTargetRequest request)
Lists the names of the rules that the given target is put to.
|
ListRulesResult |
listRules(ListRulesRequest request)
Lists the Amazon CloudWatch Events rules in your account.
|
ListTargetsByRuleResult |
listTargetsByRule(ListTargetsByRuleRequest request)
Lists of targets assigned to the rule.
|
PutEventsResult |
putEvents(PutEventsRequest request)
Sends custom events to Amazon CloudWatch Events so that they can be
matched to rules.
|
PutRuleResult |
putRule(PutRuleRequest request)
Creates or updates a rule.
|
PutTargetsResult |
putTargets(PutTargetsRequest request)
Adds target(s) to a rule.
|
RemoveTargetsResult |
removeTargets(RemoveTargetsRequest request)
Removes target(s) from a rule so that when the rule is triggered, those
targets will no longer be invoked.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client
("events.us-east-1.amazonaws.com").
|
void |
setRegion(Region region)
An alternative to
AmazonCloudWatchEvents.setEndpoint(String),
sets the regional endpoint for this client's service calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held
open.
|
TestEventPatternResult |
testEventPattern(TestEventPatternRequest request)
Tests whether an event pattern matches the provided event.
|
public void setEndpoint(String endpoint)
AmazonCloudWatchEvents
Callers can pass in just the endpoint (ex:
"events.us-east-1.amazonaws.com") or a full URL, including the protocol
(ex: "events.us-east-1.amazonaws.com"). If the protocol is not specified
here, the default protocol from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setEndpoint in interface AmazonCloudWatchEventsendpoint - The endpoint (ex: "events.us-east-1.amazonaws.com") or a full URL,
including the protocol (ex: "events.us-east-1.amazonaws.com") of
the region specific AWS endpoint this client will communicate
with.public void setRegion(Region region)
AmazonCloudWatchEventsAmazonCloudWatchEvents.setEndpoint(String),
sets the regional endpoint for this client's service calls. Callers can
use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol.
To use http instead, specify it in the ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
setRegion in interface AmazonCloudWatchEventsregion - The region this client will communicate with. See
Region.getRegion(com.amazonaws.regions.Regions) for
accessing a given region. Must not be null and must be a region
where the service is available.Region.getRegion(com.amazonaws.regions.Regions),
Region.createClient(Class,
com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration),
Region.isServiceSupported(String)public void deleteRule(DeleteRuleRequest request)
AmazonCloudWatchEventsDeletes a rule. You must remove all targets from a rule using RemoveTargets before you can delete the rule.
Note: When you make a change with this action, incoming events might still continue to match to the deleted rule. Please allow a short period of time for changes to take effect.
deleteRule in interface AmazonCloudWatchEventsrequest - Container for the parameters to the DeleteRule operation.public DescribeRuleResult describeRule(DescribeRuleRequest request)
AmazonCloudWatchEventsDescribes the details of the specified rule.
describeRule in interface AmazonCloudWatchEventsrequest - Container for the parameters to the DescribeRule operation.public void disableRule(DisableRuleRequest request)
AmazonCloudWatchEventsDisables a rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule expression.
Note: When you make a change with this action, incoming events might still continue to match to the disabled rule. Please allow a short period of time for changes to take effect.
disableRule in interface AmazonCloudWatchEventsrequest - Container for the parameters to the DisableRule operation.public void enableRule(EnableRuleRequest request)
AmazonCloudWatchEventsEnables a rule. If the rule does not exist, the operation fails.
Note: When you make a change with this action, incoming events might not immediately start matching to a newly enabled rule. Please allow a short period of time for changes to take effect.
enableRule in interface AmazonCloudWatchEventsrequest - Container for the parameters to the EnableRule operation.public ListRuleNamesByTargetResult listRuleNamesByTarget(ListRuleNamesByTargetRequest request)
AmazonCloudWatchEventsLists the names of the rules that the given target is put to. Using this action, you can find out 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 the ListRulesByTarget action until the NextToken in the response is returned as null.
listRuleNamesByTarget in interface AmazonCloudWatchEventsrequest - Container for the parameters to the ListRuleNamesByTarget
operation.public ListRulesResult listRules(ListRulesRequest request)
AmazonCloudWatchEventsLists 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 the ListRules action until the NextToken in the response is returned as null.
listRules in interface AmazonCloudWatchEventsrequest - Container for the parameters to the ListRules operation.public ListTargetsByRuleResult listTargetsByRule(ListTargetsByRuleRequest request)
AmazonCloudWatchEventsLists of targets assigned to the rule.
listTargetsByRule in interface AmazonCloudWatchEventsrequest - Container for the parameters to the ListTargetsByRule
operation.public PutEventsResult putEvents(PutEventsRequest request)
AmazonCloudWatchEventsSends custom events to Amazon CloudWatch Events so that they can be matched to rules.
putEvents in interface AmazonCloudWatchEventsrequest - Container for the parameters to the PutEvents operation.public PutRuleResult putRule(PutRuleRequest request)
AmazonCloudWatchEventsCreates 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 make a change with this action, 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.
putRule in interface AmazonCloudWatchEventsrequest - Container for the parameters to the PutRule operation.public PutTargetsResult putTargets(PutTargetsRequest request)
AmazonCloudWatchEventsAdds target(s) to a rule. 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.
Note: When you make a change with this action, 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.
putTargets in interface AmazonCloudWatchEventsrequest - Container for the parameters to the PutTargets operation.public RemoveTargetsResult removeTargets(RemoveTargetsRequest request)
AmazonCloudWatchEventsRemoves target(s) from a rule so that when the rule is triggered, those targets will no longer be invoked.
Note: When you make a change with this action, 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.
removeTargets in interface AmazonCloudWatchEventsrequest - Container for the parameters to the RemoveTargets
operation.public TestEventPatternResult testEventPattern(TestEventPatternRequest request)
AmazonCloudWatchEventsTests 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.
testEventPattern in interface AmazonCloudWatchEventsrequest - Container for the parameters to the TestEventPattern
operation.public void shutdown()
AmazonCloudWatchEventsshutdown in interface AmazonCloudWatchEventspublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonCloudWatchEventsResponse metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata in interface AmazonCloudWatchEventsrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.