Skip to content

DescribeRuleResponse

Source code in docs_src/capo_eventbridge/types/describe_rule_response.py
class DescribeRuleResponse(TypedDict, closed=True):
    name: NotRequired["capo_eventbridge.types.rule_name.RuleName"]
    """<p>The name of the rule.</p>"""
    arn: NotRequired["capo_eventbridge.types.rule_arn.RuleArn"]
    """<p>The Amazon Resource Name (ARN) of the rule.</p>"""
    event_pattern: NotRequired["capo_eventbridge.types.event_pattern.EventPattern"]
    """<p>The event pattern. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html">Events and Event Patterns</a> in the <i> <i>Amazon EventBridge User Guide</i> </i>.</p>"""
    schedule_expression: NotRequired[
        "capo_eventbridge.types.schedule_expression.ScheduleExpression"
    ]
    """<p>The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".</p>"""
    state: NotRequired["capo_eventbridge.types.rule_state.RuleState"]
    """<p>Specifies whether the rule is enabled or disabled.</p>"""
    description: NotRequired["capo_eventbridge.types.rule_description.RuleDescription"]
    """<p>The description of the rule.</p>"""
    role_arn: NotRequired["capo_eventbridge.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role associated with the rule.</p>"""
    managed_by: NotRequired["capo_eventbridge.types.managed_by.ManagedBy"]
    """<p>If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.</p>"""
    event_bus_name: NotRequired["capo_eventbridge.types.event_bus_name.EventBusName"]
    """<p>The name of the event bus associated with the rule.</p>"""
    created_by: NotRequired["capo_eventbridge.types.created_by.CreatedBy"]
    """<p>The account ID of the user that created the rule. If you use <code>PutRule</code> to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for <code>CreatedBy</code> is the account ID as the account that created the rule in the other account.</p>"""

arn instance-attribute

arn: NotRequired[RuleArn]

The Amazon Resource Name (ARN) of the rule.

created_by instance-attribute

created_by: NotRequired[CreatedBy]

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

description instance-attribute

description: NotRequired[RuleDescription]

The description of the rule.

event_bus_name instance-attribute

event_bus_name: NotRequired[EventBusName]

The name of the event bus associated with the rule.

event_pattern instance-attribute

event_pattern: NotRequired[EventPattern]

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide .

managed_by instance-attribute

managed_by: NotRequired[ManagedBy]

If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

name instance-attribute

name: NotRequired[RuleName]

The name of the rule.

role_arn instance-attribute

role_arn: NotRequired[RoleArn]

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

schedule_expression instance-attribute

schedule_expression: NotRequired[ScheduleExpression]

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

state instance-attribute

state: NotRequired[RuleState]

Specifies whether the rule is enabled or disabled.