/*
* Copyright 2012-2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.cloudwatchevents;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.cloudwatchevents.model.*;
/**
* Interface for accessing Amazon CloudWatch Events.
* <p>
* <b>Note:</b> Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.cloudwatchevents.AbstractAmazonCloudWatchEvents} instead.
* </p>
* <p>
* <p>
* 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:
* </p>
* <ul>
* <li>
* <p>
* Automatically invoke an AWS Lambda function to update DNS entries when an event notifies you that Amazon EC2 instance
* enters the running state.
* </p>
* </li>
* <li>
* <p>
* Direct specific API records from CloudTrail to an Amazon Kinesis stream for detailed analysis of potential security
* or availability risks.
* </p>
* </li>
* <li>
* <p>
* Periodically invoke a built-in target to create a snapshot of an Amazon EBS volume.
* </p>
* </li>
* </ul>
* <p>
* For more information about the features of Amazon CloudWatch Events, see the <a
* href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/events">Amazon CloudWatch Events User Guide</a>.
* </p>
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudWatchEvents {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "events";
/**
* Overrides the default endpoint for this client ("events.us-east-1.amazonaws.com"). Callers can use this method to
* control which AWS region they want to work with.
* <p>
* 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 {@link ClientConfiguration} will be used, which by default is HTTPS.
* <p>
* 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: <a
* href="http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912">
* http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912</a>
* <p>
* <b>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.</b>
*
* @param endpoint
* 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.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonCloudWatchEvents#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.
* <p>
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
* <p>
* <b>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.</b>
*
* @param region
* The region this client will communicate with. See {@link 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.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
* <p>
* Deletes the specified rule.
* </p>
* <p>
* You must remove all targets from a rule using <a>RemoveTargets</a> before you can delete the rule.
* </p>
* <p>
* When you delete a rule, incoming events might continue to match to the deleted rule. Please allow a short period
* of time for changes to take effect.
* </p>
*
* @param deleteRuleRequest
* @return Result of the DeleteRule operation returned by the service.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule or target.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.DeleteRule
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DeleteRule" target="_top">AWS API
* Documentation</a>
*/
DeleteRuleResult deleteRule(DeleteRuleRequest deleteRuleRequest);
/**
* <p>
* Describes the specified rule.
* </p>
*
* @param describeRuleRequest
* @return Result of the DescribeRule operation returned by the service.
* @throws ResourceNotFoundException
* The rule does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.DescribeRule
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DescribeRule" target="_top">AWS API
* Documentation</a>
*/
DescribeRuleResult describeRule(DescribeRuleRequest describeRuleRequest);
/**
* <p>
* Disables the specified rule. A disabled rule won't match any events, and won't self-trigger if it has a schedule
* expression.
* </p>
* <p>
* When you disable a rule, incoming events might continue to match to the disabled rule. Please allow a short
* period of time for changes to take effect.
* </p>
*
* @param disableRuleRequest
* @return Result of the DisableRule operation returned by the service.
* @throws ResourceNotFoundException
* The rule does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule or target.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.DisableRule
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/DisableRule" target="_top">AWS API
* Documentation</a>
*/
DisableRuleResult disableRule(DisableRuleRequest disableRuleRequest);
/**
* <p>
* Enables the specified rule. If the rule does not exist, the operation fails.
* </p>
* <p>
* 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.
* </p>
*
* @param enableRuleRequest
* @return Result of the EnableRule operation returned by the service.
* @throws ResourceNotFoundException
* The rule does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule or target.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.EnableRule
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/EnableRule" target="_top">AWS API
* Documentation</a>
*/
EnableRuleResult enableRule(EnableRuleRequest enableRuleRequest);
/**
* <p>
* Lists the rules for the specified target. You can see which of the rules in Amazon CloudWatch Events can invoke a
* specific target in your account.
* </p>
*
* @param listRuleNamesByTargetRequest
* @return Result of the ListRuleNamesByTarget operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.ListRuleNamesByTarget
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListRuleNamesByTarget" target="_top">AWS
* API Documentation</a>
*/
ListRuleNamesByTargetResult listRuleNamesByTarget(ListRuleNamesByTargetRequest listRuleNamesByTargetRequest);
/**
* <p>
* Lists your Amazon CloudWatch Events rules. You can either list all the rules or you can provide a prefix to match
* to the rule names.
* </p>
*
* @param listRulesRequest
* @return Result of the ListRules operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.ListRules
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListRules" target="_top">AWS API
* Documentation</a>
*/
ListRulesResult listRules(ListRulesRequest listRulesRequest);
/**
* <p>
* Lists the targets assigned to the specified rule.
* </p>
*
* @param listTargetsByRuleRequest
* @return Result of the ListTargetsByRule operation returned by the service.
* @throws ResourceNotFoundException
* The rule does not exist.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.ListTargetsByRule
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/ListTargetsByRule" target="_top">AWS API
* Documentation</a>
*/
ListTargetsByRuleResult listTargetsByRule(ListTargetsByRuleRequest listTargetsByRuleRequest);
/**
* <p>
* Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
* </p>
*
* @param putEventsRequest
* @return Result of the PutEvents operation returned by the service.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.PutEvents
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutEvents" target="_top">AWS API
* Documentation</a>
*/
PutEventsResult putEvents(PutEventsRequest putEventsRequest);
/**
* <p>
* Creates or updates the specified rule. Rules are enabled by default, or based on value of the state. You can
* disable a rule using <a>DisableRule</a>.
* </p>
* <p>
* 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.
* </p>
* <p>
* 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.
* </p>
* <p>
* 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.
* </p>
*
* @param putRuleRequest
* @return Result of the PutRule operation returned by the service.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws LimitExceededException
* You tried to create more rules or add more targets to a rule than is allowed.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule or target.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.PutRule
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutRule" target="_top">AWS API
* Documentation</a>
*/
PutRuleResult putRule(PutRuleRequest putRuleRequest);
/**
* <p>
* Adds the specified targets to the specified rule, or updates the targets if they are already associated with the
* rule.
* </p>
* <p>
* Targets are the resources that are invoked when a rule is triggered. Example targets include EC2 instances, AWS
* Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, and built-in
* targets. Note that creating rules with built-in targets is supported only in the AWS Management Console.
* </p>
* <p>
* For some target types, <code>PutTargets</code> provides target-specific parameters. If the target is an Amazon
* Kinesis stream, you can optionally specify which shard the event goes to by using the
* <code>KinesisParameters</code> argument. To invoke a command on multiple EC2 instances with one rule, you can use
* the <code>RunCommandParameters</code> field.
* </p>
* <p>
* 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, Amazon Kinesis streams, and AWS Step Functions state machines, CloudWatch Events relies on IAM
* roles that you specify in the <code>RoleARN</code> argument in <code>PutTarget</code>. For more information, see
* <a href="http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/auth-and-access-control-cwe.html">
* Authentication and Access Control</a> in the <i>Amazon CloudWatch Events User Guide</i>.
* </p>
* <p>
* <b>Input</b>, <b>InputPath</b> and <b>InputTransformer</b> are mutually exclusive and optional parameters of a
* target. When a rule is triggered due to a matched event:
* </p>
* <ul>
* <li>
* <p>
* If none of the following arguments are specified for a target, then the entire event is passed to the target in
* JSON form (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event
* is passed to the target).
* </p>
* </li>
* <li>
* <p>
* If <b>Input</b> is specified in the form of valid JSON, then the matched event is overridden with this constant.
* </p>
* </li>
* <li>
* <p>
* If <b>InputPath</b> is specified in the form of JSONPath (for example, <code>$.detail</code>), 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).
* </p>
* </li>
* <li>
* <p>
* If <b>InputTransformer</b> 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.
* </p>
* </li>
* </ul>
* <p>
* When you specify <code>Input</code>, <code>InputPath</code>, or <code>InputTransformer</code>, you must use JSON
* dot notation, not bracket notation.
* </p>
* <p>
* When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be
* immediately invoked. Please allow a short period of time for changes to take effect.
* </p>
* <p>
* This action can partially fail if too many requests are made at the same time. If that happens,
* <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides
* the ID of the failed target and the error code.
* </p>
*
* @param putTargetsRequest
* @return Result of the PutTargets operation returned by the service.
* @throws ResourceNotFoundException
* The rule does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule or target.
* @throws LimitExceededException
* You tried to create more rules or add more targets to a rule than is allowed.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.PutTargets
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/PutTargets" target="_top">AWS API
* Documentation</a>
*/
PutTargetsResult putTargets(PutTargetsRequest putTargetsRequest);
/**
* <p>
* Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be
* invoked.
* </p>
* <p>
* When you remove a target, when the associated rule triggers, removed targets might continue to be invoked. Please
* allow a short period of time for changes to take effect.
* </p>
* <p>
* This action can partially fail if too many requests are made at the same time. If that happens,
* <code>FailedEntryCount</code> is non-zero in the response and each entry in <code>FailedEntries</code> provides
* the ID of the failed target and the error code.
* </p>
*
* @param removeTargetsRequest
* @return Result of the RemoveTargets operation returned by the service.
* @throws ResourceNotFoundException
* The rule does not exist.
* @throws ConcurrentModificationException
* There is concurrent modification on a rule or target.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.RemoveTargets
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/RemoveTargets" target="_top">AWS API
* Documentation</a>
*/
RemoveTargetsResult removeTargets(RemoveTargetsRequest removeTargetsRequest);
/**
* <p>
* Tests whether the specified event pattern matches the provided event.
* </p>
* <p>
* 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.
* </p>
*
* @param testEventPatternRequest
* @return Result of the TestEventPattern operation returned by the service.
* @throws InvalidEventPatternException
* The event pattern is not valid.
* @throws InternalException
* This exception occurs due to unexpected causes.
* @sample AmazonCloudWatchEvents.TestEventPattern
* @see <a href="http://docs.aws.amazon.com/goto/WebAPI/events-2015-10-07/TestEventPattern" target="_top">AWS API
* Documentation</a>
*/
TestEventPatternResult testEventPattern(TestEventPatternRequest testEventPatternRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
* <p>
* Response 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}