UserNotifications / Client / get_event_rule

get_event_rule

UserNotifications.Client.get_event_rule(**kwargs)

Returns a specified EventRule.

See also: AWS API Documentation

Request Syntax

response = client.get_event_rule(
    arn='string'
)
Parameters:

arn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the EventRule to return.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'notificationConfigurationArn': 'string',
    'creationTime': datetime(2015, 1, 1),
    'source': 'string',
    'eventType': 'string',
    'eventPattern': 'string',
    'regions': [
        'string',
    ],
    'managedRules': [
        'string',
    ],
    'statusSummaryByRegion': {
        'string': {
            'status': 'ACTIVE'|'INACTIVE'|'CREATING'|'UPDATING'|'DELETING',
            'reason': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • arn (string) –

      The ARN of the resource.

    • notificationConfigurationArn (string) –

      The ARN of a NotificationConfiguration.

    • creationTime (datetime) –

      The date when the EventRule was created.

    • source (string) –

      The matched event source.

      Must match one of the valid EventBridge sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

    • eventType (string) –

      The event type to match.

      Must match one of the valid Amazon EventBridge event types. For example, EC2 Instance State-change Notification and Amazon CloudWatch Alarm State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

    • eventPattern (string) –

      An additional event pattern used to further filter the events this EventRule receives.

      For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

    • regions (list) –

      A list of Amazon Web Services Regions that send events to this EventRule.

      • (string) –

    • managedRules (list) –

      A list of managed rules from EventBridge that are associated with this EventRule.

      Note

      These are created by User Notifications within your account so this EventRule functions.

      • (string) –

    • statusSummaryByRegion (dict) –

      A list of an EventRule’s status by Region. Regions are mapped to EventRuleStatusSummary.

      • (string) –

        • (dict) –

          Provides additional information about the current EventRule status.

          • status (string) –

            The status of the EventRule.

            • Values:

              • ACTIVE

                • The EventRule can process events.

              • INACTIVE

                • The EventRule may be unable to process events.

              • CREATING

                • The EventRule is being created. Only GET and LIST calls can be run.

              • UPDATING

                • The EventRule is being updated. Only GET and LIST calls can be run.

              • DELETING

                • The EventRule is being deleted. Only GET and LIST calls can be run.

          • reason (string) –

            A human-readable reason for EventRuleStatus.

Exceptions