AbstractAmazonCloudWatchEvents (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatchevents.AbstractAmazonCloudWatchEvents

All Implemented Interfaces:

AmazonCloudWatchEvents

Direct Known Subclasses:

AbstractAmazonCloudWatchEventsAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonCloudWatchEvents
extends Object
implements AmazonCloudWatchEvents
```
Abstract implementation of AmazonCloudWatchEvents. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.cloudwatchevents.AmazonCloudWatchEvents
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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 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.
`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 the specified event pattern matches the provided event.

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

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    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.
    
    Specified by:
    
    setEndpoint in interface AmazonCloudWatchEvents
    
    Parameters:
    
    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.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    An alternative to 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.
    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.
    
    Specified by:
    
    setRegion in interface AmazonCloudWatchEvents
    
    Parameters:
    
    region - 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.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - deleteRule
```
public DeleteRuleResult deleteRule(DeleteRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Deletes the specified rule.
    
    You must remove all targets from a rule using RemoveTargets before you can delete the rule.
    
    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.
    
    Specified by:
    
    deleteRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DeleteRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventBus
```
public DescribeEventBusResult describeEventBus(DescribeEventBusRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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
    
    Returns:
    
    Result of the DescribeEventBus operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeRule
```
public DescribeRuleResult describeRule(DescribeRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Describes the specified rule.
    
    Specified by:
    
    describeRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DescribeRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disableRule
```
public DisableRuleResult disableRule(DisableRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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. Please allow a short period of time for changes to take effect.
    
    Specified by:
    
    disableRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the DisableRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - enableRule
```
public EnableRuleResult enableRule(EnableRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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. Please allow a short period of time for changes to take effect.
    
    Specified by:
    
    enableRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the EnableRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRuleNamesByTarget
```
public ListRuleNamesByTargetResult listRuleNamesByTarget(ListRuleNamesByTargetRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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
    
    Returns:
    
    Result of the ListRuleNamesByTarget operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listRules
```
public ListRulesResult listRules(ListRulesRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    listRules in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListRules operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTargetsByRule
```
public ListTargetsByRuleResult listTargetsByRule(ListTargetsByRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Lists the targets assigned to the specified rule.
    
    Specified by:
    
    listTargetsByRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the ListTargetsByRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putEvents
```
public PutEventsResult putEvents(PutEventsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.
    
    Specified by:
    
    putEvents in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the PutEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putPermission
```
public PutPermissionResult putPermission(PutPermissionRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    Running PutPermission permits the specified AWS account 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.
    
    The permission policy on the default event bus cannot exceed 10KB in size.
    
    Specified by:
    
    putPermission in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the PutPermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putRule
```
public PutRuleResult putRule(PutRuleRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    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 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.
    
    Specified by:
    
    putRule in interface AmazonCloudWatchEvents
    
    Returns:
    
    Result of the PutRule operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putTargets
```
public PutTargetsResult putTargets(PutTargetsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    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
    - AWS Lambda functions
    - Streams in Amazon Kinesis Streams
    - Delivery streams in Amazon Kinesis Firehose
    - Amazon ECS tasks
    - AWS Step Functions state machines
    - Pipelines in Amazon Code Pipeline
    - Amazon Inspector assessment templates
    - Amazon SNS topics
    - Amazon SQS queues
    - The default event bus of another AWS account
    Note that creating rules with built-in targets is supported only in the AWS Management Console.
    
    For some target types, PutTargets 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 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, Amazon Kinesis 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 by setting 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 when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to antoher account is charged as a custom event. The account receiving the event is not charged. For more information on pricing, see Amazon CloudWatch Pricing.
    
    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 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).
    - 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 Input, 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. Please 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
    
    Returns:
    
    Result of the PutTargets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removePermission
```
public RemovePermissionResult removePermission(RemovePermissionRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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
    
    Returns:
    
    Result of the RemovePermission operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeTargets
```
public RemoveTargetsResult removeTargets(RemoveTargetsRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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. Please 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
    
    Returns:
    
    Result of the RemoveTargets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - testEventPattern
```
public TestEventPatternResult testEventPattern(TestEventPatternRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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
    
    Returns:
    
    Result of the TestEventPattern operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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.
    
    Specified by:
    
    shutdown in interface AmazonCloudWatchEvents
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonCloudWatchEvents
    
    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 a 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.

Did this page help you?

Class AbstractAmazonCloudWatchEvents

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

deleteRule

describeEventBus

describeRule

disableRule

enableRule

listRuleNamesByTarget

listRules

listTargetsByRule

putEvents

putPermission

putRule

putTargets

removePermission

removeTargets

testEventPattern

shutdown

getCachedResponseMetadata