UserNotifications / Client / list_event_rules

list_event_rules#

UserNotifications.Client.list_event_rules(**kwargs)#

Returns a list of EventRules according to specified filters, in reverse chronological order (newest first).

See also: AWS API Documentation

Request Syntax

response = client.list_event_rules(
    notificationConfigurationArn='string',
    maxResults=123,
    nextToken='string'
)
Parameters:

  • notificationConfigurationArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the NotificationConfiguration.

  • maxResults (integer) – The maximum number of results to be returned in this call. The default value is 20.

  • nextToken (string) – The start token for paginated calls. Retrieved from the response of a previous ListEventRules call. Next token uses Base64 encoding.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'eventRules': [
        {
            '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) –

    • nextToken (string) –

      A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

    • eventRules (list) –

      A list of EventRules.

      • (dict) –

        Contains a complete list of fields related to an EventRule.

        • arn (string) –

          The Amazon Resource Name (ARN) of the resource.

        • notificationConfigurationArn (string) –

          The ARN for the NotificationConfiguration associated with this EventRule.

        • creationTime (datetime) –

          The creation time of the resource.

        • source (string) –

          The matched event source.

          Must match one of the valid EventBridge sources. Only AWS service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from AWS 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 AWS CloudWatch Alarm State Change. For more information, see Event delivery from AWS 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 AWS Regions that send events to this EventRule.

          • (string) –

        • managedRules (list) –

          A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.

          Note

          These are created by AWS User Notifications within your account so your EventRules can function.

          • (string) –

        • statusSummaryByRegion (dict) –

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

          • (string) –

            • (dict) –

              Describes EventRule status information.

              • 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