EventBridge / Client / describe_rule

describe_rule#

EventBridge.Client.describe_rule(**kwargs)#

Describes the specified rule.

DescribeRule does not list the targets of a rule. To see the targets associated with a rule, use ListTargetsByRule.

See also: AWS API Documentation

Request Syntax

response = client.describe_rule(
    Name='string',
    EventBusName='string'
)
Parameters:

  • Name (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.

Return type:

dict

Returns:

Response Syntax

{
    'Name': 'string',
    'Arn': 'string',
    'EventPattern': 'string',
    'ScheduleExpression': 'string',
    'State': 'ENABLED'|'DISABLED',
    'Description': 'string',
    'RoleArn': 'string',
    'ManagedBy': 'string',
    'EventBusName': 'string',
    'CreatedBy': 'string'
}

Response Structure

  • (dict) –

    • Name (string) –

      The name of the rule.

    • Arn (string) –

      The Amazon Resource Name (ARN) of the rule.

    • EventPattern (string) –

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

    • ScheduleExpression (string) –

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

    • State (string) –

      Specifies whether the rule is enabled or disabled.

    • Description (string) –

      The description of the rule.

    • RoleArn (string) –

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

    • ManagedBy (string) –

      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.

    • EventBusName (string) –

      The name of the event bus associated with the rule.

    • CreatedBy (string) –

      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.

Exceptions

  • EventBridge.Client.exceptions.ResourceNotFoundException

  • EventBridge.Client.exceptions.InternalException