AmazonCloudWatchEventsClient (AWS Java SDK for Amazon CloudWatch Events 1.11.478 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceClient
- - com.amazonaws.services.cloudwatchevents.AmazonCloudWatchEventsClient

All Implemented Interfaces:

AmazonCloudWatchEvents

Direct Known Subclasses:

AmazonCloudWatchEventsAsyncClient
```
@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonCloudWatchEventsClient
extends AmazonWebServiceClient
implements AmazonCloudWatchEvents
```
Client for accessing Amazon CloudWatch Events. All service calls made using this client are blocking, and will not return until the service call 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 predetermined 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 AWS CloudTrail to an Amazon Kinesis data 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 the features of Amazon CloudWatch Events, see the Amazon CloudWatch Events User Guide.

Field Summary

Fields
Modifier and Type Field and Description

protected static ClientConfigurationFactory configFactory
Client configuration factory providing ClientConfigurations tailored to this client
- Fields inherited from class com.amazonaws.AmazonWebServiceClient
  client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
- Fields inherited from interface com.amazonaws.services.cloudwatchevents.AmazonCloudWatchEvents
  ENDPOINT_PREFIX

Fields
Modifier and Type	Field and Description
`protected static ClientConfigurationFactory`	`configFactory` Client configuration factory providing ClientConfigurations tailored to this client

Constructor Summary

Constructors
Constructor and Description
`AmazonCloudWatchEventsClient()` Deprecated. use `AmazonCloudWatchEventsClientBuilder.defaultClient()`
`AmazonCloudWatchEventsClient(AWSCredentials awsCredentials)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` for example: `AmazonCloudWatchEventsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();`
`AmazonCloudWatchEventsClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonCloudWatchEventsClient(AWSCredentialsProvider awsCredentialsProvider)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)`
`AmazonCloudWatchEventsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`
`AmazonCloudWatchEventsClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)` Deprecated. use `AwsClientBuilder.withCredentials(AWSCredentialsProvider)` and `AwsClientBuilder.withClientConfiguration(ClientConfiguration)` and `AwsClientBuilder.withMetricsCollector(RequestMetricCollector)`
`AmazonCloudWatchEventsClient(ClientConfiguration clientConfiguration)` Deprecated. use `AwsClientBuilder.withClientConfiguration(ClientConfiguration)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AmazonCloudWatchEventsClientBuilder`	`builder()`
`DeleteRuleResult`	`deleteRule(DeleteRuleRequest request)` Deletes the specified rule.
`DescribeEventBusResult`	`describeEventBus(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.
`DescribeRuleResult`	`describeRule(DescribeRuleRequest request)` Describes the specified rule.
`DisableRuleResult`	`disableRule(DisableRuleRequest request)` Disables the specified rule.
`EnableRuleResult`	`enableRule(EnableRuleRequest request)` Enables the specified 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 rules for the specified target.
`ListRulesResult`	`listRules(ListRulesRequest request)` Lists your Amazon CloudWatch Events rules.
`ListTargetsByRuleResult`	`listTargetsByRule(ListTargetsByRuleRequest request)` Lists the targets assigned to the specified rule.
`PutEventsResult`	`putEvents(PutEventsRequest request)` Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
`PutPermissionResult`	`putPermission(PutPermissionRequest request)` Running `PutPermission` permits the specified AWS account or AWS organization to put events to your account's default event bus.
`PutRuleResult`	`putRule(PutRuleRequest request)` Creates or updates the specified rule.
`PutTargetsResult`	`putTargets(PutTargetsRequest request)` Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.
`RemovePermissionResult`	`removePermission(RemovePermissionRequest request)` Revokes the permission of another AWS account to be able to put events to your default event bus.
`RemoveTargetsResult`	`removeTargets(RemoveTargetsRequest request)` Removes the specified targets from the specified rule.
`TestEventPatternResult`	`testEventPattern(TestEventPatternRequest request)` Tests whether the specified event pattern matches the provided event.

Methods inherited from class com.amazonaws.AmazonWebServiceClient
addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cloudwatchevents.AmazonCloudWatchEvents
setEndpoint, setRegion, shutdown

- Field Detail
  - configFactory
```
protected static final ClientConfigurationFactory configFactory
```
    Client configuration factory providing ClientConfigurations tailored to this client
- Constructor Detail
  - AmazonCloudWatchEventsClient
```
@Deprecated
public AmazonCloudWatchEventsClient()
```
    Deprecated. use AmazonCloudWatchEventsClientBuilder.defaultClient()
    Constructs a new client to invoke service methods on Amazon CloudWatch Events. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonCloudWatchEventsClient
```
@Deprecated
public AmazonCloudWatchEventsClient(ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    Constructs a new client to invoke service methods on Amazon CloudWatch Events. A credentials provider chain will be used that searches for credentials in this order:
    - Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
    - Java System Properties - aws.accessKeyId and aws.secretKey
    - Instance profile credentials delivered through the Amazon EC2 metadata service
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    Parameters:
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudWatch Events (ex: proxy settings, retry counts, etc.).
    
    See Also:
    
    DefaultAWSCredentialsProviderChain
  - AmazonCloudWatchEventsClient
```
@Deprecated
public AmazonCloudWatchEventsClient(AWSCredentials awsCredentials)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example: AmazonCloudWatchEventsClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
    
    Constructs a new client to invoke service methods on Amazon CloudWatch Events using the specified AWS account credentials.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
  - AmazonCloudWatchEventsClient
```
@Deprecated
public AmazonCloudWatchEventsClient(AWSCredentials awsCredentials,
                                                ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon CloudWatch Events using the specified AWS account credentials and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudWatch Events (ex: proxy settings, retry counts, etc.).
  - AmazonCloudWatchEventsClient
```
@Deprecated
public AmazonCloudWatchEventsClient(AWSCredentialsProvider awsCredentialsProvider)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider)
    
    Constructs a new client to invoke service methods on Amazon CloudWatch Events using the specified AWS account credentials provider.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
  - AmazonCloudWatchEventsClient
```
@Deprecated
public AmazonCloudWatchEventsClient(AWSCredentialsProvider awsCredentialsProvider,
                                                ClientConfiguration clientConfiguration)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration)
    
    Constructs a new client to invoke service methods on Amazon CloudWatch Events using the specified AWS account credentials provider and client configuration options.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudWatch Events (ex: proxy settings, retry counts, etc.).
  - AmazonCloudWatchEventsClient
```
@Deprecated
public AmazonCloudWatchEventsClient(AWSCredentialsProvider awsCredentialsProvider,
                                                ClientConfiguration clientConfiguration,
                                                RequestMetricCollector requestMetricCollector)
```
    Deprecated. use AwsClientBuilder.withCredentials(AWSCredentialsProvider) and AwsClientBuilder.withClientConfiguration(ClientConfiguration) and AwsClientBuilder.withMetricsCollector(RequestMetricCollector)
    
    Constructs a new client to invoke service methods on Amazon CloudWatch Events using the specified AWS account credentials provider, client configuration options, and request metric collector.
    All service calls made using this new client object are blocking, and will not return until the service call completes.
    
    Parameters:
    
    awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.
    
    clientConfiguration - The client configuration options controlling how this client connects to Amazon CloudWatch Events (ex: proxy settings, retry counts, etc.).
    
    requestMetricCollector - optional request metric collector
- Method Detail
  - builder
```
public static AmazonCloudWatchEventsClientBuilder builder()
```
  - deleteRule
```
public DeleteRuleResult deleteRule(DeleteRuleRequest request)
```
    Deletes 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.
    
    Managed rules are rules created and managed by another AWS service on your behalf. These rules are created by those other AWS services to support functionality in those services. You can delete these rules using the Force option, but you should do so only if you are sure the other service is not still using that rule.
    
    Specified by:
    
    deleteRule in interface AmazonCloudWatchEvents
    
    Parameters:
    
    deleteRuleRequest -
    
    Returns:
    
    Result of the DeleteRule operation returned by the service.
    
    Throws:
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, or PutRule.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - describeEventBus
```
public DescribeEventBusResult describeEventBus(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. To enable your account to receive events from other accounts, use PutPermission.
    
    Specified by:
    
    describeEventBus in interface AmazonCloudWatchEvents
    
    Parameters:
    
    describeEventBusRequest -
    
    Returns:
    
    Result of the DescribeEventBus operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - describeRule
```
public DescribeRuleResult describeRule(DescribeRuleRequest request)
```
    Describes the specified rule.
    
    DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
    
    Specified by:
    
    describeRule in interface AmazonCloudWatchEvents
    
    Parameters:
    
    describeRuleRequest -
    
    Returns:
    
    Result of the DescribeRule operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - disableRule
```
public DisableRuleResult disableRule(DisableRuleRequest request)
```
    Disables 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.
    
    Specified by:
    
    disableRule in interface AmazonCloudWatchEvents
    
    Parameters:
    
    disableRuleRequest -
    
    Returns:
    
    Result of the DisableRule operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, or PutRule.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - enableRule
```
public EnableRuleResult enableRule(EnableRuleRequest request)
```
    Enables 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.
    
    Specified by:
    
    enableRule in interface AmazonCloudWatchEvents
    
    Parameters:
    
    enableRuleRequest -
    
    Returns:
    
    Result of the EnableRule operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, or PutRule.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - listRuleNamesByTarget
```
public ListRuleNamesByTargetResult listRuleNamesByTarget(ListRuleNamesByTargetRequest request)
```
    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.
    
    Specified by:
    
    listRuleNamesByTarget in interface AmazonCloudWatchEvents
    
    Parameters:
    
    listRuleNamesByTargetRequest -
    
    Returns:
    
    Result of the ListRuleNamesByTarget operation returned by the service.
    
    Throws:
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - listRules
```
public ListRulesResult listRules(ListRulesRequest request)
```
    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.
    
    ListRules does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.
    
    Specified by:
    
    listRules in interface AmazonCloudWatchEvents
    
    Parameters:
    
    listRulesRequest -
    
    Returns:
    
    Result of the ListRules operation returned by the service.
    
    Throws:
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - listTargetsByRule
```
public ListTargetsByRuleResult listTargetsByRule(ListTargetsByRuleRequest request)
```
    Lists the targets assigned to the specified rule.
    
    Specified by:
    
    listTargetsByRule in interface AmazonCloudWatchEvents
    
    Parameters:
    
    listTargetsByRuleRequest -
    
    Returns:
    
    Result of the ListTargetsByRule operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - putEvents
```
public PutEventsResult putEvents(PutEventsRequest request)
```
    Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
    
    Specified by:
    
    putEvents in interface AmazonCloudWatchEvents
    
    Parameters:
    
    putEventsRequest -
    
    Returns:
    
    Result of the PutEvents operation returned by the service.
    
    Throws:
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - putPermission
```
public PutPermissionResult putPermission(PutPermissionRequest request)
```
    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.
    
    Specified by:
    
    putPermission in interface AmazonCloudWatchEvents
    
    Parameters:
    
    putPermissionRequest -
    
    Returns:
    
    Result of the PutPermission operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    PolicyLengthExceededException - The event bus policy is too long. For more information, see the limits.
    
    InternalException - This exception occurs due to unexpected causes.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    See Also:
    
    AWS API Documentation
  - putRule
```
public PutRuleResult putRule(PutRuleRequest request)
```
    Creates 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.
    
    Specified by:
    
    putRule in interface AmazonCloudWatchEvents
    
    Parameters:
    
    putRuleRequest -
    
    Returns:
    
    Result of the PutRule operation returned by the service.
    
    Throws:
    
    InvalidEventPatternException - The event pattern is not valid.
    
    LimitExceededException - You tried to create more rules or add more targets to a rule than is allowed.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, or PutRule.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - putTargets
```
public PutTargetsResult putTargets(PutTargetsRequest request)
```
    Adds 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.
    Specified by:
    
    putTargets in interface AmazonCloudWatchEvents
    
    Parameters:
    
    putTargetsRequest -
    
    Returns:
    
    Result of the PutTargets operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    LimitExceededException - You tried to create more rules or add more targets to a rule than is allowed.
    
    ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, or PutRule.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - removePermission
```
public RemovePermissionResult removePermission(RemovePermissionRequest request)
```
    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.
    
    Specified by:
    
    removePermission in interface AmazonCloudWatchEvents
    
    Parameters:
    
    removePermissionRequest -
    
    Returns:
    
    Result of the RemovePermission operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    InternalException - This exception occurs due to unexpected causes.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    See Also:
    
    AWS API Documentation
  - removeTargets
```
public RemoveTargetsResult removeTargets(RemoveTargetsRequest request)
```
    Removes 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.
    
    Specified by:
    
    removeTargets in interface AmazonCloudWatchEvents
    
    Parameters:
    
    removeTargetsRequest -
    
    Returns:
    
    Result of the RemoveTargets operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An entity that you specified does not exist.
    
    ConcurrentModificationException - There is concurrent modification on a rule or target.
    
    ManagedRuleException - This rule was created by an AWS service on behalf of your account. It is managed by that service. If you see this error in response to DeleteRule or RemoveTargets, you can use the Force parameter in those calls to delete the rule or remove targets from the rule. You cannot modify these managed rules by using DisableRule, EnableRule, PutTargets, or PutRule.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - testEventPattern
```
public TestEventPatternResult testEventPattern(TestEventPatternRequest request)
```
    Tests 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.
    
    Specified by:
    
    testEventPattern in interface AmazonCloudWatchEvents
    
    Parameters:
    
    testEventPatternRequest -
    
    Returns:
    
    Result of the TestEventPattern operation returned by the service.
    
    Throws:
    
    InvalidEventPatternException - The event pattern is not valid.
    
    InternalException - This exception occurs due to unexpected causes.
    
    See Also:
    
    AWS API Documentation
  - getCachedResponseMetadata
```
public 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. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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 the request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonCloudWatchEvents
    
    Parameters:
    
    request - The originally executed request
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AmazonCloudWatchEventsClient

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

Fields inherited from interface com.amazonaws.services.cloudwatchevents.AmazonCloudWatchEvents

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceClient

Methods inherited from class java.lang.Object

Methods inherited from interface com.amazonaws.services.cloudwatchevents.AmazonCloudWatchEvents

Field Detail

configFactory

Constructor Detail

AmazonCloudWatchEventsClient

AmazonCloudWatchEventsClient

AmazonCloudWatchEventsClient

AmazonCloudWatchEventsClient

AmazonCloudWatchEventsClient

AmazonCloudWatchEventsClient

AmazonCloudWatchEventsClient

Method Detail

builder

deleteRule

describeEventBus

describeRule

disableRule

enableRule

listRuleNamesByTarget

listRules

listTargetsByRule

putEvents

putPermission

putRule

putTargets

removePermission

removeTargets

testEventPattern

getCachedResponseMetadata