EventBridge Boto 3 Docs 1.12.7 documentation

May 2024 ยท 5 minute read

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 Events:

Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call , EC2 RebootInstances API call , EC2 StopInstances API call , and EC2 TerminateInstances API call .

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets . For more information, see Authentication and Access Control in the Amazon EventBridge User Guide .

If another AWS account is in the same region and has granted you permission (using PutPermission ), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets . If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon CloudWatch Pricing .

Note

Input , InputPath , and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide .

For more information about enabling cross-account events, see PutPermission .

Input , InputPath , and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

When you specify InputPath or InputTransformer , you must use JSON dot notation, not bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

See also: AWS API Documentation

Request Syntax

response = client.put_targets( Rule='string', EventBusName='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, 'LaunchType': 'EC2'|'FARGATE', 'NetworkConfiguration': { 'awsvpcConfiguration': { 'Subnets': [ 'string', ], 'SecurityGroups': [ 'string', ], 'AssignPublicIp': 'ENABLED'|'DISABLED' } }, 'PlatformVersion': 'string', 'Group': 'string' }, 'BatchParameters': { 'JobDefinition': 'string', 'JobName': 'string', 'ArrayProperties': { 'Size': 123 }, 'RetryStrategy': { 'Attempts': 123 } }, 'SqsParameters': { 'MessageGroupId': 'string' } }, ] ) 
Parameters Return type

dict

Returns

Response Syntax

{ 'FailedEntryCount': 123, 'FailedEntries': [ { 'TargetId': 'string', 'ErrorCode': 'string', 'ErrorMessage': 'string' }, ] } 

Response Structure

ncG1vNJzZmian6m8dHrAppizp56WxLR6wqikaK5hZLGwr9SmnKeskam2sLqOmqeiZ2FjfnN6lmipnp6Vp7Kvr8Roqp6qpp6wpr%2BOnq2epqSoe6nAzKU%3D