Serialized Form (AWS Java SDK for Amazon CloudWatch Events 1.11.301 API)

Package com.amazonaws.services.cloudwatchevents.model
- Class com.amazonaws.services.cloudwatchevents.model.AmazonCloudWatchEventsException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.BatchArrayProperties extends Object implements Serializable
  - Serialized Fields
    - size
```
Integer size
```
      The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
- Class com.amazonaws.services.cloudwatchevents.model.BatchParameters extends Object implements Serializable
  - Serialized Fields
    - jobDefinition
```
String jobDefinition
```
      The ARN or name of the job definition to use if the event target is an AWS Batch job. This job definition must already exist.
    - jobName
```
String jobName
```
      The name to use for this execution of the job, if the target is an AWS Batch job.
    - arrayProperties
```
BatchArrayProperties arrayProperties
```
      The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. This parameter is used only if the target is an AWS Batch job.
    - retryStrategy
```
BatchRetryStrategy retryStrategy
```
      The retry strategy to use for failed jobs, if the target is an AWS Batch job. The retry strategy is the number of times to retry the failed job execution. Valid values are 1 to 10. When you specify a retry strategy here, it overrides the retry strategy defined in the job definition.
- Class com.amazonaws.services.cloudwatchevents.model.BatchRetryStrategy extends Object implements Serializable
  - Serialized Fields
    - attempts
```
Integer attempts
```
      The number of times to attempt to retry, if the job fails. Valid values are 1 to 10.
- Class com.amazonaws.services.cloudwatchevents.model.ConcurrentModificationException extends AmazonCloudWatchEventsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.DeleteRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule.
- Class com.amazonaws.services.cloudwatchevents.model.DeleteRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchevents.model.DescribeEventBusRequest extends AmazonWebServiceRequest implements Serializable
- Class com.amazonaws.services.cloudwatchevents.model.DescribeEventBusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the event bus. Currently, this is always default.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the account permitted to write events to the current account.
    - policy
```
String policy
```
      The policy that enables the external account to send events to your account.
- Class com.amazonaws.services.cloudwatchevents.model.DescribeRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule.
- Class com.amazonaws.services.cloudwatchevents.model.DescribeRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the rule.
    - eventPattern
```
String eventPattern
```
      The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.
    - scheduleExpression
```
String scheduleExpression
```
      The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
    - state
```
String state
```
      Specifies whether the rule is enabled or disabled.
    - description
```
String description
```
      The description of the rule.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the IAM role associated with the rule.
- Class com.amazonaws.services.cloudwatchevents.model.DisableRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule.
- Class com.amazonaws.services.cloudwatchevents.model.DisableRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchevents.model.EcsParameters extends Object implements Serializable
  - Serialized Fields
    - taskDefinitionArn
```
String taskDefinitionArn
```
      The ARN of the task definition to use if the event target is an Amazon ECS cluster.
    - taskCount
```
Integer taskCount
```
      The number of tasks to create based on the TaskDefinition. The default is one.
- Class com.amazonaws.services.cloudwatchevents.model.EnableRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule.
- Class com.amazonaws.services.cloudwatchevents.model.EnableRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchevents.model.InputTransformer extends Object implements Serializable
  - Serialized Fields
    - inputPathsMap
```
Map<K,V> inputPathsMap
```
      Map of JSON paths to be extracted from the event. These are key-value pairs, where each value is a JSON path. You must use JSON dot notation, not bracket notation.
    - inputTemplate
```
String inputTemplate
```
      Input template where you can use the values of the keys from InputPathsMap to customize the data sent to the target.
- Class com.amazonaws.services.cloudwatchevents.model.InternalException extends AmazonCloudWatchEventsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.InvalidEventPatternException extends AmazonCloudWatchEventsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.KinesisParameters extends Object implements Serializable
  - Serialized Fields
    - partitionKeyPath
```
String partitionKeyPath
```
      The JSON path to be extracted from the event and used as the partition key. For more information, see Amazon Kinesis Streams Key Concepts in the Amazon Kinesis Streams Developer Guide.
- Class com.amazonaws.services.cloudwatchevents.model.LimitExceededException extends AmazonCloudWatchEventsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - targetArn
```
String targetArn
```
      The Amazon Resource Name (ARN) of the target resource.
    - nextToken
```
String nextToken
```
      The token returned by a previous call to retrieve the next set of results.
    - limit
```
Integer limit
```
      The maximum number of results to return.
- Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - ruleNames
```
List<E> ruleNames
```
      The names of the rules that can invoke the given target.
    - nextToken
```
String nextToken
```
      Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
- Class com.amazonaws.services.cloudwatchevents.model.ListRulesRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - namePrefix
```
String namePrefix
```
      The prefix matching the rule name.
    - nextToken
```
String nextToken
```
      The token returned by a previous call to retrieve the next set of results.
    - limit
```
Integer limit
```
      The maximum number of results to return.
- Class com.amazonaws.services.cloudwatchevents.model.ListRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - rules
```
List<E> rules
```
      The rules that match the specified criteria.
    - nextToken
```
String nextToken
```
      Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
- Class com.amazonaws.services.cloudwatchevents.model.ListTargetsByRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rule
```
String rule
```
      The name of the rule.
    - nextToken
```
String nextToken
```
      The token returned by a previous call to retrieve the next set of results.
    - limit
```
Integer limit
```
      The maximum number of results to return.
- Class com.amazonaws.services.cloudwatchevents.model.ListTargetsByRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - targets
```
List<E> targets
```
      The targets assigned to the rule.
    - nextToken
```
String nextToken
```
      Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
- Class com.amazonaws.services.cloudwatchevents.model.PolicyLengthExceededException extends AmazonCloudWatchEventsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.PutEventsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - entries
```
List<E> entries
```
      The entry that defines an event in your system. You can specify several parameters for the entry such as the source and type of the event, resources associated with the event, and so on.
- Class com.amazonaws.services.cloudwatchevents.model.PutEventsRequestEntry extends Object implements Serializable
  - Serialized Fields
    - time
```
Date time
```
      The timestamp of the event, per RFC3339. If no timestamp is provided, the timestamp of the PutEvents call is used.
    - source
```
String source
```
      The source of the event.
    - resources
```
List<E> resources
```
      AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.
    - detailType
```
String detailType
```
      Free-form string used to decide what fields to expect in the event detail.
    - detail
```
String detail
```
      A valid JSON string. There is no other schema imposed. The JSON string may contain fields and nested subobjects.
- Class com.amazonaws.services.cloudwatchevents.model.PutEventsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - failedEntryCount
```
Integer failedEntryCount
```
      The number of failed entries.
    - entries
```
List<E> entries
```
      The successfully and unsuccessfully ingested events results. If the ingestion was successful, the entry has the event ID in it. Otherwise, you can use the error code and error message to identify the problem with the entry.
- Class com.amazonaws.services.cloudwatchevents.model.PutEventsResultEntry extends Object implements Serializable
  - Serialized Fields
    - eventId
```
String eventId
```
      The ID of the event.
    - errorCode
```
String errorCode
```
      The error code that indicates why the event submission failed.
    - errorMessage
```
String errorMessage
```
      The error message that explains why the event submission failed.
- Class com.amazonaws.services.cloudwatchevents.model.PutPermissionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - action
```
String action
```
      The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.
    - principal
```
String principal
```
      The 12-digit AWS account ID that you are permitting to put events to your default event bus. Specify "*" to permit any account to put events to your default event bus.
      
      If you specify "*", avoid creating rules that may match undesirable events. To create more secure rules, make sure that the event pattern for each rule contains an account field with a specific account ID from which to receive events. Rules with an account field do not match any events sent from other accounts.
    - statementId
```
String statementId
```
      An identifier string for the external account that you are granting permissions to. If you later want to revoke the permission for this external account, specify this StatementId when you run RemovePermission.
- Class com.amazonaws.services.cloudwatchevents.model.PutPermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchevents.model.PutRuleRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule that you are creating or updating.
    - scheduleExpression
```
String scheduleExpression
```
      The scheduling expression. For example, "cron(0 20 * * ? *)" or "rate(5 minutes)".
    - eventPattern
```
String eventPattern
```
      The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.
    - state
```
String state
```
      Indicates whether the rule is enabled or disabled.
    - description
```
String description
```
      A description of the rule.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the IAM role associated with the rule.
- Class com.amazonaws.services.cloudwatchevents.model.PutRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - ruleArn
```
String ruleArn
```
      The Amazon Resource Name (ARN) of the rule.
- Class com.amazonaws.services.cloudwatchevents.model.PutTargetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rule
```
String rule
```
      The name of the rule.
    - targets
```
List<E> targets
```
      The targets to update or add to the rule.
- Class com.amazonaws.services.cloudwatchevents.model.PutTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - failedEntryCount
```
Integer failedEntryCount
```
      The number of failed entries.
    - failedEntries
```
List<E> failedEntries
```
      The failed target entries.
- Class com.amazonaws.services.cloudwatchevents.model.PutTargetsResultEntry extends Object implements Serializable
  - Serialized Fields
    - targetId
```
String targetId
```
      The ID of the target.
    - errorCode
```
String errorCode
```
      The error code that indicates why the target addition failed. If the value is ConcurrentModificationException, too many requests were made at the same time.
    - errorMessage
```
String errorMessage
```
      The error message that explains why the target addition failed.
- Class com.amazonaws.services.cloudwatchevents.model.RemovePermissionRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - statementId
```
String statementId
```
      The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.
- Class com.amazonaws.services.cloudwatchevents.model.RemovePermissionResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
- Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - rule
```
String rule
```
      The name of the rule.
    - ids
```
List<E> ids
```
      The IDs of the targets to remove from the rule.
- Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - failedEntryCount
```
Integer failedEntryCount
```
      The number of failed entries.
    - failedEntries
```
List<E> failedEntries
```
      The failed target entries.
- Class com.amazonaws.services.cloudwatchevents.model.RemoveTargetsResultEntry extends Object implements Serializable
  - Serialized Fields
    - targetId
```
String targetId
```
      The ID of the target.
    - errorCode
```
String errorCode
```
      The error code that indicates why the target removal failed. If the value is ConcurrentModificationException, too many requests were made at the same time.
    - errorMessage
```
String errorMessage
```
      The error message that explains why the target removal failed.
- Class com.amazonaws.services.cloudwatchevents.model.ResourceNotFoundException extends AmazonCloudWatchEventsException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.cloudwatchevents.model.Rule extends Object implements Serializable
  - Serialized Fields
    - name
```
String name
```
      The name of the rule.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the rule.
    - eventPattern
```
String eventPattern
```
      The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.
    - state
```
String state
```
      The state of the rule.
    - description
```
String description
```
      The description of the rule.
    - scheduleExpression
```
String scheduleExpression
```
      The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the role that is used for target invocation.
- Class com.amazonaws.services.cloudwatchevents.model.RunCommandParameters extends Object implements Serializable
  - Serialized Fields
    - runCommandTargets
```
List<E> runCommandTargets
```
      Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
- Class com.amazonaws.services.cloudwatchevents.model.RunCommandTarget extends Object implements Serializable
  - Serialized Fields
    - key
```
String key
```
      Can be either tag: tag-key or InstanceIds.
    - values
```
List<E> values
```
      If Key is tag: tag-key, Values is a list of tag values. If Key is InstanceIds, Values is a list of Amazon EC2 instance IDs.
- Class com.amazonaws.services.cloudwatchevents.model.SqsParameters extends Object implements Serializable
  - Serialized Fields
    - messageGroupId
```
String messageGroupId
```
      The FIFO message group ID to use as the target.
- Class com.amazonaws.services.cloudwatchevents.model.Target extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The ID of the target.
    - arn
```
String arn
```
      The Amazon Resource Name (ARN) of the target.
    - roleArn
```
String roleArn
```
      The Amazon Resource Name (ARN) of the IAM role to be used for this target when the rule is triggered. If one rule triggers multiple targets, you can use a different IAM role for each target.
    - input
```
String input
```
      Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.
    - inputPath
```
String inputPath
```
      The value of the JSONPath that is used for extracting part of the matched event when passing it to the target. You must use JSON dot notation, not bracket notation. For more information about JSON paths, see JSONPath.
    - inputTransformer
```
InputTransformer inputTransformer
```
      Settings to enable you to provide custom input to a target based on certain event data. You can extract one or more key-value pairs from the event and then use that data to send customized input to the target.
    - kinesisParameters
```
KinesisParameters kinesisParameters
```
      The custom parameter you can use to control shard assignment, when the target is an Amazon Kinesis stream. If you do not include this parameter, the default is to use the eventId as the partition key.
    - runCommandParameters
```
RunCommandParameters runCommandParameters
```
      Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
    - ecsParameters
```
EcsParameters ecsParameters
```
      Contains the Amazon ECS task definition and task count to be used, if the event target is an Amazon ECS task. For more information about Amazon ECS tasks, see Task Definitions in the Amazon EC2 Container Service Developer Guide.
    - batchParameters
```
BatchParameters batchParameters
```
      Contains the job definition, job name, and other parameters if the event target is an AWS Batch job. For more information about AWS Batch, see Jobs in the AWS Batch User Guide.
    - sqsParameters
```
SqsParameters sqsParameters
```
      Contains the message group ID to use when the target is a FIFO queue.
- Class com.amazonaws.services.cloudwatchevents.model.TestEventPatternRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - eventPattern
```
String eventPattern
```
      The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.
    - event
```
String event
```
      The event, in JSON format, to test against the event pattern.
- Class com.amazonaws.services.cloudwatchevents.model.TestEventPatternResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - result
```
Boolean result
```
      Indicates whether the event matches the event pattern.

Serialized Form

Package com.amazonaws.services.cloudwatchevents.model

Class com.amazonaws.services.cloudwatchevents.model.AmazonCloudWatchEventsException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.BatchArrayProperties extends Object implements Serializable

Serialized Fields

size

Class com.amazonaws.services.cloudwatchevents.model.BatchParameters extends Object implements Serializable

Serialized Fields

jobDefinition

jobName

arrayProperties

retryStrategy

Class com.amazonaws.services.cloudwatchevents.model.BatchRetryStrategy extends Object implements Serializable

Serialized Fields

attempts

Class com.amazonaws.services.cloudwatchevents.model.ConcurrentModificationException extends AmazonCloudWatchEventsException implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.DeleteRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

Class com.amazonaws.services.cloudwatchevents.model.DeleteRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.DescribeEventBusRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.DescribeEventBusResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

name

arn

policy

Class com.amazonaws.services.cloudwatchevents.model.DescribeRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

Class com.amazonaws.services.cloudwatchevents.model.DescribeRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

name

arn

eventPattern

scheduleExpression

state

description

roleArn

Class com.amazonaws.services.cloudwatchevents.model.DisableRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

Class com.amazonaws.services.cloudwatchevents.model.DisableRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.EcsParameters extends Object implements Serializable

Serialized Fields

taskDefinitionArn

taskCount

Class com.amazonaws.services.cloudwatchevents.model.EnableRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

Class com.amazonaws.services.cloudwatchevents.model.EnableRuleResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.InputTransformer extends Object implements Serializable

Serialized Fields

inputPathsMap

inputTemplate

Class com.amazonaws.services.cloudwatchevents.model.InternalException extends AmazonCloudWatchEventsException implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.InvalidEventPatternException extends AmazonCloudWatchEventsException implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.KinesisParameters extends Object implements Serializable

Serialized Fields

partitionKeyPath

Class com.amazonaws.services.cloudwatchevents.model.LimitExceededException extends AmazonCloudWatchEventsException implements Serializable

Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

targetArn

nextToken

limit

Class com.amazonaws.services.cloudwatchevents.model.ListRuleNamesByTargetResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

ruleNames

nextToken

Class com.amazonaws.services.cloudwatchevents.model.ListRulesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

namePrefix

nextToken

limit

Class com.amazonaws.services.cloudwatchevents.model.ListRulesResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

rules

nextToken

Class com.amazonaws.services.cloudwatchevents.model.ListTargetsByRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields