Skip to content

RemoveTargetsRequest

Source code in docs_src/capo_eventbridge/types/remove_targets_request.py
class RemoveTargetsRequest(TypedDict, closed=True):
    rule: "capo_eventbridge.types.rule_name.RuleName"
    """<p>The name of the rule.</p>"""
    event_bus_name: NotRequired[
        "capo_eventbridge.types.event_bus_name_or_arn.EventBusNameOrArn"
    ]
    """<p>The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.</p>"""
    ids: "capo_eventbridge.types.target_id_list.TargetIdList"
    """<p>The IDs of the targets to remove from the rule.</p>"""
    force: "capo_eventbridge.types.boolean.Boolean"
    """<p>If this is a managed rule, created by an Amazon Web Services service on your behalf, you must specify <code>Force</code> as <code>True</code> 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 <code>DescribeRule</code> or <code>ListRules</code> and checking the <code>ManagedBy</code> field of the response.</p>"""

event_bus_name instance-attribute

event_bus_name: NotRequired[EventBusNameOrArn]

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

force instance-attribute

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.

ids instance-attribute

The IDs of the targets to remove from the rule.

rule instance-attribute

rule: RuleName

The name of the rule.