2018/03/01 - Amazon CloudWatch Events - 2 updated api methods
Changes Added BatchParameters to the PutTargets API
{'Targets': {'BatchParameters': {'ArrayProperties': {'Size': 'integer'},
'JobDefinition': 'string',
'JobName': 'string',
'RetryStrategy': {'Attempts': 'integer'}}}}
Lists the targets assigned to the specified rule.
See also: AWS API Documentation
Request Syntax
client.list_targets_by_rule(
Rule='string',
NextToken='string',
Limit=123
)
string
[REQUIRED]
The name of the rule.
string
The token returned by a previous call to retrieve the next set of results.
integer
The maximum number of results to return.
dict
Response Syntax
{
'Targets': [
{
'Id': 'string',
'Arn': 'string',
'RoleArn': 'string',
'Input': 'string',
'InputPath': 'string',
'InputTransformer': {
'InputPathsMap': {
'string': 'string'
},
'InputTemplate': 'string'
},
'KinesisParameters': {
'PartitionKeyPath': 'string'
},
'RunCommandParameters': {
'RunCommandTargets': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
'EcsParameters': {
'TaskDefinitionArn': 'string',
'TaskCount': 123
},
'BatchParameters': {
'JobDefinition': 'string',
'JobName': 'string',
'ArrayProperties': {
'Size': 123
},
'RetryStrategy': {
'Attempts': 123
}
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Targets (list) --
The targets assigned to the rule.
(dict) --
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.
Id (string) --
The ID of the target.
Arn (string) --
The Amazon Resource Name (ARN) of the target.
RoleArn (string) --
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) --
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) --
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 (dict) --
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.
InputPathsMap (dict) --
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.
(string) --
(string) --
InputTemplate (string) --
Input template where you can use the values of the keys from InputPathsMap to customize the data sent to the target.
KinesisParameters (dict) --
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.
PartitionKeyPath (string) --
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 .
RunCommandParameters (dict) --
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
RunCommandTargets (list) --
Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
(dict) --
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.
Key (string) --
Can be either tag: tag-key or InstanceIds .
Values (list) --
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.
(string) --
EcsParameters (dict) --
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 .
TaskDefinitionArn (string) --
The ARN of the task definition to use if the event target is an Amazon ECS cluster.
TaskCount (integer) --
The number of tasks to create based on the TaskDefinition . The default is one.
BatchParameters (dict) --
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 .
JobDefinition (string) --
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) --
The name to use for this execution of the job, if the target is an AWS Batch job.
ArrayProperties (dict) --
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.
Size (integer) --
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
RetryStrategy (dict) --
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.
Attempts (integer) --
The number of times to attempt to retry, if the job fails. Valid values are 1 to 10.
NextToken (string) --
Indicates whether there are additional results to retrieve. If there are no more results, the value is null.
{'Targets': {'BatchParameters': {'ArrayProperties': {'Size': 'integer'},
'JobDefinition': 'string',
'JobName': 'string',
'RetryStrategy': {'Attempts': 'integer'}}}}
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
AWS Batch jobs
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 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.
See also: AWS API Documentation
Request Syntax
client.put_targets(
Rule='string',
Targets=[
{
'Id': 'string',
'Arn': 'string',
'RoleArn': 'string',
'Input': 'string',
'InputPath': 'string',
'InputTransformer': {
'InputPathsMap': {
'string': 'string'
},
'InputTemplate': 'string'
},
'KinesisParameters': {
'PartitionKeyPath': 'string'
},
'RunCommandParameters': {
'RunCommandTargets': [
{
'Key': 'string',
'Values': [
'string',
]
},
]
},
'EcsParameters': {
'TaskDefinitionArn': 'string',
'TaskCount': 123
},
'BatchParameters': {
'JobDefinition': 'string',
'JobName': 'string',
'ArrayProperties': {
'Size': 123
},
'RetryStrategy': {
'Attempts': 123
}
}
},
]
)
string
[REQUIRED]
The name of the rule.
list
[REQUIRED]
The targets to update or add to the rule.
(dict) --
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.
Id (string) -- [REQUIRED]
The ID of the target.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the target.
RoleArn (string) --
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) --
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) --
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 (dict) --
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.
InputPathsMap (dict) --
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.
(string) --
(string) --
InputTemplate (string) -- [REQUIRED]
Input template where you can use the values of the keys from InputPathsMap to customize the data sent to the target.
KinesisParameters (dict) --
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.
PartitionKeyPath (string) -- [REQUIRED]
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 .
RunCommandParameters (dict) --
Parameters used when you are using the rule to invoke Amazon EC2 Run Command.
RunCommandTargets (list) -- [REQUIRED]
Currently, we support including only one RunCommandTarget block, which specifies either an array of InstanceIds or a tag.
(dict) --
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.
Key (string) -- [REQUIRED]
Can be either tag: tag-key or InstanceIds .
Values (list) -- [REQUIRED]
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.
(string) --
EcsParameters (dict) --
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 .
TaskDefinitionArn (string) -- [REQUIRED]
The ARN of the task definition to use if the event target is an Amazon ECS cluster.
TaskCount (integer) --
The number of tasks to create based on the TaskDefinition . The default is one.
BatchParameters (dict) --
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 .
JobDefinition (string) -- [REQUIRED]
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) -- [REQUIRED]
The name to use for this execution of the job, if the target is an AWS Batch job.
ArrayProperties (dict) --
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.
Size (integer) --
The size of the array, if this is an array batch job. Valid values are integers between 2 and 10,000.
RetryStrategy (dict) --
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.
Attempts (integer) --
The number of times to attempt to retry, if the job fails. Valid values are 1 to 10.
dict
Response Syntax
{
'FailedEntryCount': 123,
'FailedEntries': [
{
'TargetId': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
FailedEntryCount (integer) --
The number of failed entries.
FailedEntries (list) --
The failed target entries.
(dict) --
Represents a target that failed to be added to a rule.
TargetId (string) --
The ID of the target.
ErrorCode (string) --
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) --
The error message that explains why the target addition failed.