{ "version":"2.0", "metadata":{ "apiVersion":"2015-10-07", "endpointPrefix":"events", "jsonVersion":"1.1", "protocol":"json", "serviceFullName":"Amazon CloudWatch Events", "signatureVersion":"v4", "targetPrefix":"AWSEvents", "uid":"events-2015-10-07" }, "operations":{ "DeleteRule":{ "name":"DeleteRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteRuleRequest"}, "errors":[ {"shape":"ConcurrentModificationException"}, {"shape":"InternalException"} ], "documentation":"

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.

" }, "DescribeEventBus":{ "name":"DescribeEventBus", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeEventBusRequest"}, "output":{"shape":"DescribeEventBusResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalException"} ], "documentation":"

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.

" }, "DescribeRule":{ "name":"DescribeRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DescribeRuleRequest"}, "output":{"shape":"DescribeRuleResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalException"} ], "documentation":"

Describes the specified rule.

" }, "DisableRule":{ "name":"DisableRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DisableRuleRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InternalException"} ], "documentation":"

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.

" }, "EnableRule":{ "name":"EnableRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"EnableRuleRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InternalException"} ], "documentation":"

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.

" }, "ListRuleNamesByTarget":{ "name":"ListRuleNamesByTarget", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRuleNamesByTargetRequest"}, "output":{"shape":"ListRuleNamesByTargetResponse"}, "errors":[ {"shape":"InternalException"} ], "documentation":"

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.

" }, "ListRules":{ "name":"ListRules", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListRulesRequest"}, "output":{"shape":"ListRulesResponse"}, "errors":[ {"shape":"InternalException"} ], "documentation":"

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.

" }, "ListTargetsByRule":{ "name":"ListTargetsByRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListTargetsByRuleRequest"}, "output":{"shape":"ListTargetsByRuleResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalException"} ], "documentation":"

Lists the targets assigned to the specified rule.

" }, "PutEvents":{ "name":"PutEvents", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutEventsRequest"}, "output":{"shape":"PutEventsResponse"}, "errors":[ {"shape":"InternalException"} ], "documentation":"

Sends custom events to Amazon CloudWatch Events so that they can be matched to rules.

" }, "PutPermission":{ "name":"PutPermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutPermissionRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"PolicyLengthExceededException"}, {"shape":"InternalException"} ], "documentation":"

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.

" }, "PutRule":{ "name":"PutRule", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutRuleRequest"}, "output":{"shape":"PutRuleResponse"}, "errors":[ {"shape":"InvalidEventPatternException"}, {"shape":"LimitExceededException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InternalException"} ], "documentation":"

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.

" }, "PutTargets":{ "name":"PutTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"PutTargetsRequest"}, "output":{"shape":"PutTargetsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, {"shape":"LimitExceededException"}, {"shape":"InternalException"} ], "documentation":"

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:

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 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 when you run PutTargets. 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:

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.

" }, "RemovePermission":{ "name":"RemovePermission", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemovePermissionRequest"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalException"} ], "documentation":"

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.

" }, "RemoveTargets":{ "name":"RemoveTargets", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"RemoveTargetsRequest"}, "output":{"shape":"RemoveTargetsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InternalException"} ], "documentation":"

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.

" }, "TestEventPattern":{ "name":"TestEventPattern", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TestEventPatternRequest"}, "output":{"shape":"TestEventPatternResponse"}, "errors":[ {"shape":"InvalidEventPatternException"}, {"shape":"InternalException"} ], "documentation":"

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.

" } }, "shapes":{ "Action":{ "type":"string", "max":64, "min":1, "pattern":"events:[a-zA-Z]+" }, "Arn":{ "type":"string", "max":1600, "min":1 }, "Boolean":{"type":"boolean"}, "ConcurrentModificationException":{ "type":"structure", "members":{ }, "documentation":"

There is concurrent modification on a rule or target.

", "exception":true }, "DeleteRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule.

" } } }, "DescribeEventBusRequest":{ "type":"structure", "members":{ } }, "DescribeEventBusResponse":{ "type":"structure", "members":{ "Name":{ "shape":"String", "documentation":"

The name of the event bus. Currently, this is always default.

" }, "Arn":{ "shape":"String", "documentation":"

The Amazon Resource Name (ARN) of the account permitted to write events to the current account.

" }, "Policy":{ "shape":"String", "documentation":"

The policy that enables the external account to send events to your account.

" } } }, "DescribeRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule.

" } } }, "DescribeRuleResponse":{ "type":"structure", "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule.

" }, "Arn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) of the rule.

" }, "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" }, "State":{ "shape":"RuleState", "documentation":"

Specifies whether the rule is enabled or disabled.

" }, "Description":{ "shape":"RuleDescription", "documentation":"

The description of the rule.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" } } }, "DisableRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule.

" } } }, "EcsParameters":{ "type":"structure", "required":["TaskDefinitionArn"], "members":{ "TaskDefinitionArn":{ "shape":"Arn", "documentation":"

The ARN of the task definition to use if the event target is an Amazon ECS cluster.

" }, "TaskCount":{ "shape":"LimitMin1", "documentation":"

The number of tasks to create based on the TaskDefinition. The default is one.

" } }, "documentation":"

The custom parameters to be used when the target is an Amazon ECS cluster.

" }, "EnableRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule.

" } } }, "ErrorCode":{"type":"string"}, "ErrorMessage":{"type":"string"}, "EventId":{"type":"string"}, "EventPattern":{ "type":"string", "max":2048 }, "EventResource":{"type":"string"}, "EventResourceList":{ "type":"list", "member":{"shape":"EventResource"} }, "EventTime":{"type":"timestamp"}, "InputTransformer":{ "type":"structure", "required":["InputTemplate"], "members":{ "InputPathsMap":{ "shape":"TransformerPaths", "documentation":"

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":{ "shape":"TransformerInput", "documentation":"

Input template where you can use the values of the keys from InputPathsMap to customize the data sent to the target.

" } }, "documentation":"

Contains the parameters needed for you to provide custom input to a target based on one or more pieces of data extracted from the event.

" }, "InputTransformerPathKey":{ "type":"string", "max":256, "min":1, "pattern":"[A-Za-z0-9\\_\\-]+" }, "Integer":{"type":"integer"}, "InternalException":{ "type":"structure", "members":{ }, "documentation":"

This exception occurs due to unexpected causes.

", "exception":true, "fault":true }, "InvalidEventPatternException":{ "type":"structure", "members":{ }, "documentation":"

The event pattern is not valid.

", "exception":true }, "KinesisParameters":{ "type":"structure", "required":["PartitionKeyPath"], "members":{ "PartitionKeyPath":{ "shape":"TargetPartitionKeyPath", "documentation":"

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.

" } }, "documentation":"

This object enables you to specify a JSON path to extract from the event and use as the partition key for the Amazon Kinesis stream, so that you can control the shard to which the event goes. If you do not include this parameter, the default is to use the eventId as the partition key.

" }, "LimitExceededException":{ "type":"structure", "members":{ }, "documentation":"

You tried to create more rules or add more targets to a rule than is allowed.

", "exception":true }, "LimitMax100":{ "type":"integer", "max":100, "min":1 }, "LimitMin1":{ "type":"integer", "min":1 }, "ListRuleNamesByTargetRequest":{ "type":"structure", "required":["TargetArn"], "members":{ "TargetArn":{ "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) of the target resource.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token returned by a previous call to retrieve the next set of results.

" }, "Limit":{ "shape":"LimitMax100", "documentation":"

The maximum number of results to return.

" } } }, "ListRuleNamesByTargetResponse":{ "type":"structure", "members":{ "RuleNames":{ "shape":"RuleNameList", "documentation":"

The names of the rules that can invoke the given target.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

" } } }, "ListRulesRequest":{ "type":"structure", "members":{ "NamePrefix":{ "shape":"RuleName", "documentation":"

The prefix matching the rule name.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token returned by a previous call to retrieve the next set of results.

" }, "Limit":{ "shape":"LimitMax100", "documentation":"

The maximum number of results to return.

" } } }, "ListRulesResponse":{ "type":"structure", "members":{ "Rules":{ "shape":"RuleResponseList", "documentation":"

The rules that match the specified criteria.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

" } } }, "ListTargetsByRuleRequest":{ "type":"structure", "required":["Rule"], "members":{ "Rule":{ "shape":"RuleName", "documentation":"

The name of the rule.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

The token returned by a previous call to retrieve the next set of results.

" }, "Limit":{ "shape":"LimitMax100", "documentation":"

The maximum number of results to return.

" } } }, "ListTargetsByRuleResponse":{ "type":"structure", "members":{ "Targets":{ "shape":"TargetList", "documentation":"

The targets assigned to the rule.

" }, "NextToken":{ "shape":"NextToken", "documentation":"

Indicates whether there are additional results to retrieve. If there are no more results, the value is null.

" } } }, "NextToken":{ "type":"string", "max":2048, "min":1 }, "PolicyLengthExceededException":{ "type":"structure", "members":{ }, "documentation":"

The event bus policy is too long. For more information, see the limits.

", "exception":true }, "Principal":{ "type":"string", "max":12, "min":1, "pattern":"(\\d{12}|\\*)" }, "PutEventsRequest":{ "type":"structure", "required":["Entries"], "members":{ "Entries":{ "shape":"PutEventsRequestEntryList", "documentation":"

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.

" } } }, "PutEventsRequestEntry":{ "type":"structure", "members":{ "Time":{ "shape":"EventTime", "documentation":"

The timestamp of the event, per RFC3339. If no timestamp is provided, the timestamp of the PutEvents call is used.

" }, "Source":{ "shape":"String", "documentation":"

The source of the event.

" }, "Resources":{ "shape":"EventResourceList", "documentation":"

AWS resources, identified by Amazon Resource Name (ARN), which the event primarily concerns. Any number, including zero, may be present.

" }, "DetailType":{ "shape":"String", "documentation":"

Free-form string used to decide what fields to expect in the event detail.

" }, "Detail":{ "shape":"String", "documentation":"

In the JSON sense, an object containing fields, which may also contain nested subobjects. No constraints are imposed on its contents.

" } }, "documentation":"

Represents an event to be submitted.

" }, "PutEventsRequestEntryList":{ "type":"list", "member":{"shape":"PutEventsRequestEntry"}, "max":10, "min":1 }, "PutEventsResponse":{ "type":"structure", "members":{ "FailedEntryCount":{ "shape":"Integer", "documentation":"

The number of failed entries.

" }, "Entries":{ "shape":"PutEventsResultEntryList", "documentation":"

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.

" } } }, "PutEventsResultEntry":{ "type":"structure", "members":{ "EventId":{ "shape":"EventId", "documentation":"

The ID of the event.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

The error code that indicates why the event submission failed.

" }, "ErrorMessage":{ "shape":"ErrorMessage", "documentation":"

The error message that explains why the event submission failed.

" } }, "documentation":"

Represents an event that failed to be submitted.

" }, "PutEventsResultEntryList":{ "type":"list", "member":{"shape":"PutEventsResultEntry"} }, "PutPermissionRequest":{ "type":"structure", "required":[ "Action", "Principal", "StatementId" ], "members":{ "Action":{ "shape":"Action", "documentation":"

The action that you are enabling the other account to perform. Currently, this must be events:PutEvents.

" }, "Principal":{ "shape":"Principal", "documentation":"

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":{ "shape":"StatementId", "documentation":"

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.

" } } }, "PutRuleRequest":{ "type":"structure", "required":["Name"], "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule that you are creating or updating.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\" or \"rate(5 minutes)\".

" }, "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

" }, "State":{ "shape":"RuleState", "documentation":"

Indicates whether the rule is enabled or disabled.

" }, "Description":{ "shape":"RuleDescription", "documentation":"

A description of the rule.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

" } } }, "PutRuleResponse":{ "type":"structure", "members":{ "RuleArn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) of the rule.

" } } }, "PutTargetsRequest":{ "type":"structure", "required":[ "Rule", "Targets" ], "members":{ "Rule":{ "shape":"RuleName", "documentation":"

The name of the rule.

" }, "Targets":{ "shape":"TargetList", "documentation":"

The targets to update or add to the rule.

" } } }, "PutTargetsResponse":{ "type":"structure", "members":{ "FailedEntryCount":{ "shape":"Integer", "documentation":"

The number of failed entries.

" }, "FailedEntries":{ "shape":"PutTargetsResultEntryList", "documentation":"

The failed target entries.

" } } }, "PutTargetsResultEntry":{ "type":"structure", "members":{ "TargetId":{ "shape":"TargetId", "documentation":"

The ID of the target.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

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":{ "shape":"ErrorMessage", "documentation":"

The error message that explains why the target addition failed.

" } }, "documentation":"

Represents a target that failed to be added to a rule.

" }, "PutTargetsResultEntryList":{ "type":"list", "member":{"shape":"PutTargetsResultEntry"} }, "RemovePermissionRequest":{ "type":"structure", "required":["StatementId"], "members":{ "StatementId":{ "shape":"StatementId", "documentation":"

The statement ID corresponding to the account that is no longer allowed to put events to the default event bus.

" } } }, "RemoveTargetsRequest":{ "type":"structure", "required":[ "Rule", "Ids" ], "members":{ "Rule":{ "shape":"RuleName", "documentation":"

The name of the rule.

" }, "Ids":{ "shape":"TargetIdList", "documentation":"

The IDs of the targets to remove from the rule.

" } } }, "RemoveTargetsResponse":{ "type":"structure", "members":{ "FailedEntryCount":{ "shape":"Integer", "documentation":"

The number of failed entries.

" }, "FailedEntries":{ "shape":"RemoveTargetsResultEntryList", "documentation":"

The failed target entries.

" } } }, "RemoveTargetsResultEntry":{ "type":"structure", "members":{ "TargetId":{ "shape":"TargetId", "documentation":"

The ID of the target.

" }, "ErrorCode":{ "shape":"ErrorCode", "documentation":"

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":{ "shape":"ErrorMessage", "documentation":"

The error message that explains why the target removal failed.

" } }, "documentation":"

Represents a target that failed to be removed from a rule.

" }, "RemoveTargetsResultEntryList":{ "type":"list", "member":{"shape":"RemoveTargetsResultEntry"} }, "ResourceNotFoundException":{ "type":"structure", "members":{ }, "documentation":"

An entity that you specified does not exist.

", "exception":true }, "RoleArn":{ "type":"string", "max":1600, "min":1 }, "Rule":{ "type":"structure", "members":{ "Name":{ "shape":"RuleName", "documentation":"

The name of the rule.

" }, "Arn":{ "shape":"RuleArn", "documentation":"

The Amazon Resource Name (ARN) of the rule.

" }, "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

" }, "State":{ "shape":"RuleState", "documentation":"

The state of the rule.

" }, "Description":{ "shape":"RuleDescription", "documentation":"

The description of the rule.

" }, "ScheduleExpression":{ "shape":"ScheduleExpression", "documentation":"

The scheduling expression. For example, \"cron(0 20 * * ? *)\", \"rate(5 minutes)\".

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

The Amazon Resource Name (ARN) of the role that is used for target invocation.

" } }, "documentation":"

Contains information about a rule in Amazon CloudWatch Events.

" }, "RuleArn":{ "type":"string", "max":1600, "min":1 }, "RuleDescription":{ "type":"string", "max":512 }, "RuleName":{ "type":"string", "max":64, "min":1, "pattern":"[\\.\\-_A-Za-z0-9]+" }, "RuleNameList":{ "type":"list", "member":{"shape":"RuleName"} }, "RuleResponseList":{ "type":"list", "member":{"shape":"Rule"} }, "RuleState":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "RunCommandParameters":{ "type":"structure", "required":["RunCommandTargets"], "members":{ "RunCommandTargets":{ "shape":"RunCommandTargets", "documentation":"

Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.

" } }, "documentation":"

This parameter contains the criteria (either InstanceIds or a tag) used to specify which EC2 instances are to be sent the command.

" }, "RunCommandTarget":{ "type":"structure", "required":[ "Key", "Values" ], "members":{ "Key":{ "shape":"RunCommandTargetKey", "documentation":"

Can be either tag: tag-key or InstanceIds.

" }, "Values":{ "shape":"RunCommandTargetValues", "documentation":"

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.

" } }, "documentation":"

Information about the EC2 instances that are to be sent the command, specified as key-value pairs. Each RunCommandTarget block can include only one key, but this key may specify multiple values.

" }, "RunCommandTargetKey":{ "type":"string", "max":128, "min":1, "pattern":"^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*$" }, "RunCommandTargetValue":{ "type":"string", "max":256, "min":1 }, "RunCommandTargetValues":{ "type":"list", "member":{"shape":"RunCommandTargetValue"}, "max":50, "min":1 }, "RunCommandTargets":{ "type":"list", "member":{"shape":"RunCommandTarget"}, "max":5, "min":1 }, "ScheduleExpression":{ "type":"string", "max":256 }, "StatementId":{ "type":"string", "max":64, "min":1, "pattern":"[a-zA-Z0-9-_]+" }, "String":{"type":"string"}, "Target":{ "type":"structure", "required":[ "Id", "Arn" ], "members":{ "Id":{ "shape":"TargetId", "documentation":"

The ID of the target.

" }, "Arn":{ "shape":"TargetArn", "documentation":"

The Amazon Resource Name (ARN) of the target.

" }, "RoleArn":{ "shape":"RoleArn", "documentation":"

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":{ "shape":"TargetInput", "documentation":"

Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. You must use JSON dot notation, not bracket notation. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

" }, "InputPath":{ "shape":"TargetInputPath", "documentation":"

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":{ "shape":"InputTransformer", "documentation":"

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":{ "shape":"KinesisParameters", "documentation":"

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":{ "shape":"RunCommandParameters", "documentation":"

Parameters used when you are using the rule to invoke Amazon EC2 Run Command.

" }, "EcsParameters":{ "shape":"EcsParameters", "documentation":"

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.

" } }, "documentation":"

Targets are the resources to be invoked when a rule is triggered. Target types include EC2 instances, AWS Lambda functions, Amazon Kinesis streams, Amazon ECS tasks, AWS Step Functions state machines, Run Command, and built-in targets.

" }, "TargetArn":{ "type":"string", "max":1600, "min":1 }, "TargetId":{ "type":"string", "max":64, "min":1, "pattern":"[\\.\\-_A-Za-z0-9]+" }, "TargetIdList":{ "type":"list", "member":{"shape":"TargetId"}, "max":100, "min":1 }, "TargetInput":{ "type":"string", "max":8192 }, "TargetInputPath":{ "type":"string", "max":256 }, "TargetList":{ "type":"list", "member":{"shape":"Target"}, "max":100, "min":1 }, "TargetPartitionKeyPath":{ "type":"string", "max":256 }, "TestEventPatternRequest":{ "type":"structure", "required":[ "EventPattern", "Event" ], "members":{ "EventPattern":{ "shape":"EventPattern", "documentation":"

The event pattern. For more information, see Events and Event Patterns in the Amazon CloudWatch Events User Guide.

" }, "Event":{ "shape":"String", "documentation":"

The event, in JSON format, to test against the event pattern.

" } } }, "TestEventPatternResponse":{ "type":"structure", "members":{ "Result":{ "shape":"Boolean", "documentation":"

Indicates whether the event matches the event pattern.

" } } }, "TransformerInput":{ "type":"string", "max":8192, "min":1 }, "TransformerPaths":{ "type":"map", "key":{"shape":"InputTransformerPathKey"}, "value":{"shape":"TargetInputPath"}, "max":10 } }, "documentation":"

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:

For more information about the features of Amazon CloudWatch Events, see the Amazon CloudWatch Events User Guide.

" }