Amazon EventBridge
API Reference (API Version 2015-10-07)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you're 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, 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.



The Amazon Resource Name (ARN) of the target.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: Yes


If the event target is an AWS Batch job, this contains the job definition, job name, and other parameters. For more information, see Jobs in the AWS Batch User Guide.

Type: BatchParameters object

Required: No


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.

Type: EcsParameters object

Required: No


A name for the target. Use a string that will help you identify the target. Each target associated with a rule must have an Id unique for that rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [\.\-_A-Za-z0-9]+

Required: Yes


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.

Type: String

Length Constraints: Maximum length of 8192.

Required: No


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.

Type: String

Length Constraints: Maximum length of 256.

Required: No


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.

Type: InputTransformer object

Required: No


The custom parameter that you can use to control the shard assignment when the target is a Kinesis data stream. If you don't include this parameter, the default is to use the eventId as the partition key.

Type: KinesisParameters object

Required: No


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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Required: No


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

Type: RunCommandParameters object

Required: No


Contains the message group ID to use when the target is a FIFO queue.

If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

Type: SqsParameters object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: