Smaws_Client_CloudWatchEvents.PutTargetsAdds 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:
CreateSnapshot API callRebootInstances API callStopInstances API callTerminateInstances API callEvent bus in a different Amazon Web Services account or Region.
You can use an event bus in the US East (N. Virginia) us-east-1, US West (Oregon) us-west-2, or Europe (Ireland) eu-west-1 Regions as a target for a rule.
Creating rules with built-in targets is supported only in the Amazon Web Services 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 EventBridge needs the appropriate permissions. For Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis Data Streams, Step Functions state machines and API Gateway REST APIs, 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 Amazon Web Services 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 EventBridge Pricing.
Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different Amazon Web Services 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 Amazon Web Services 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:
$.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).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.
val error_to_string :
[ Smaws_Lib.Protocols.AwsJson.error
| `ConcurrentModificationException of Types.concurrent_modification_exception
| `InternalException of Types.internal_exception
| `LimitExceededException of Types.limit_exceeded_exception
| `ManagedRuleException of Types.managed_rule_exception
| `ResourceNotFoundException of Types.resource_not_found_exception ] ->
stringval request :
'http_type Smaws_Lib.Context.t ->
Types.put_targets_request ->
(Types.put_targets_response,
[> Smaws_Lib.Protocols.AwsJson.error
| `ConcurrentModificationException of
Types.concurrent_modification_exception
| `InternalException of Types.internal_exception
| `LimitExceededException of Types.limit_exceeded_exception
| `ManagedRuleException of Types.managed_rule_exception
| `ResourceNotFoundException of Types.resource_not_found_exception ])
Stdlib.resultval request_with_metadata :
'http_type Smaws_Lib.Context.t ->
Types.put_targets_request ->
(Types.put_targets_response Smaws_Lib.Response.t,
[> Smaws_Lib.Protocols.AwsJson.error
| `ConcurrentModificationException of
Types.concurrent_modification_exception
| `InternalException of Types.internal_exception
| `LimitExceededException of Types.limit_exceeded_exception
| `ManagedRuleException of Types.managed_rule_exception
| `ResourceNotFoundException of Types.resource_not_found_exception ]
* Smaws_Lib.Response.metadata)
Stdlib.result