Remove Targets

eventbridge_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.

A successful execution of remove_targets doesn't guarantee all targets are removed from the rule, it means that the target(s) listed in the request are removed.

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.

The maximum number of entries per request is 10.

Usage

eventbridge_remove_targets(Rule, EventBusName, Ids, Force)

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 as True 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 using describe_rule or list_rules and checking the ManagedBy field of the response.

Value

A list with the following syntax:

list(
  FailedEntryCount = 123,
  FailedEntries = list(
    list(
      TargetId = "string",
      ErrorCode = "string",
      ErrorMessage = "string"
    )
  )
)

Request syntax

svc$remove_targets(
  Rule = "string",
  EventBusName = "string",
  Ids = list(
    "string"
  ),
  Force = TRUE|FALSE
)