Remove Targets
cloudwatchevents_remove_targets | R Documentation |
Removes the specified targets from the specified rule¶
Description¶
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. 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.
Usage¶
Arguments¶
Rule
[required] The name of the rule.
EventBusName
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
Ids
[required] The IDs of the targets to remove from the rule.
Force
If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify
Force
asTrue
to remove targets. This parameter is ignored for rules that are not managed rules. You can check whether a rule is a managed rule by usingdescribe_rule
orlist_rules
and checking theManagedBy
field of the response.
Value¶
A list with the following syntax:
list(
FailedEntryCount = 123,
FailedEntries = list(
list(
TargetId = "string",
ErrorCode = "string",
ErrorMessage = "string"
)
)
)