UserNotifications / Client / list_notification_configurations

list_notification_configurations

UserNotifications.Client.list_notification_configurations(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_notification_configurations(
    eventRuleSource='string',
    channelArn='string',
    status='ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
    maxResults=123,
    nextToken='string'
)
Parameters:

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

  • channelArn (string) – The Amazon Resource Name (ARN) of the Channel to match.

  • status (string) –

    The NotificationConfiguration status to match.

    • Values:

      • ACTIVE

        • All EventRules are ACTIVE and any call can be run.

      • PARTIALLY_ACTIVE

        • Some EventRules are ACTIVE and some are INACTIVE. Any call can be run.

        • Any call can be run.

      • INACTIVE

        • All EventRules are INACTIVE and any call can be run.

      • DELETING

        • This NotificationConfiguration is being deleted.

        • Only GET and LIST calls can be run.

  • maxResults (integer) – The maximum number of results to be returned in this call. Defaults to 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',
    'notificationConfigurations': [
        {
            'arn': 'string',
            'name': 'string',
            'description': 'string',
            'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
            'creationTime': datetime(2015, 1, 1),
            'aggregationDuration': 'LONG'|'SHORT'|'NONE'
        },
    ]
}

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.

    • notificationConfigurations (list) –

      The NotificationConfigurations in the account.

      • (dict) –

        Contains the complete list of fields for a NotificationConfiguration.

        • arn (string) –

          The Amazon Resource Name (ARN) of the NotificationConfiguration resource.

        • name (string) –

          The name of the NotificationConfiguration. Supports RFC 3986’s unreserved characters.

        • description (string) –

          The description of the NotificationConfiguration.

        • status (string) –

          The current status of the NotificationConfiguration.

        • creationTime (datetime) –

          The creation time of the NotificationConfiguration.

        • aggregationDuration (string) –

          The aggregation preference of the NotificationConfiguration.

          • Values:

            • LONG

              • Aggregate notifications for long periods of time (12 hours).

            • SHORT

              • Aggregate notifications for short periods of time (5 minutes).

            • NONE

              • Don’t aggregate notifications.

Exceptions

  • UserNotifications.Client.exceptions.AccessDeniedException

  • UserNotifications.Client.exceptions.ValidationException

  • UserNotifications.Client.exceptions.InternalServerException

  • UserNotifications.Client.exceptions.ThrottlingException