EventBridge / Client / remove_targets

remove_targets#

EventBridge.Client.remove_targets(**kwargs)#

Removes the specified targets from the specified rule. When the rule is triggered, those targets are no longer be invoked.

Note

A successful execution of RemoveTargets 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.

See also: AWS API Documentation

Request Syntax

response = client.remove_targets(
    Rule='string',
    EventBusName='string',
    Ids=[
        'string',
    ],
    Force=True|False
)
Parameters:

  • Rule (string) –

    [REQUIRED]

    The name of the rule.

  • EventBusName (string) – The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

  • Ids (list) –

    [REQUIRED]

    The IDs of the targets to remove from the rule.

    • (string) –

  • Force (boolean) – 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 DescribeRule or ListRules and checking the ManagedBy field of the response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • FailedEntryCount (integer) –

      The number of failed entries.

    • FailedEntries (list) –

      The failed target entries.

      • (dict) –

        Represents a target that failed to be removed from a rule.

        • TargetId (string) –

          The ID of the target.

        • ErrorCode (string) –

          The error code that indicates why the target removal failed. If the value is ConcurrentModificationException, too many requests were made at the same time.

        • ErrorMessage (string) –

          The error message that explains why the target removal failed.

Exceptions

  • EventBridge.Client.exceptions.ResourceNotFoundException

  • EventBridge.Client.exceptions.ConcurrentModificationException

  • EventBridge.Client.exceptions.ManagedRuleException

  • EventBridge.Client.exceptions.InternalException