UserNotifications / Client / get_notification_configuration

get_notification_configuration#

UserNotifications.Client.get_notification_configuration(**kwargs)#

Returns a specified NotificationConfiguration.

See also: AWS API Documentation

Request Syntax

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

arn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'name': 'string',
    'description': 'string',
    'status': 'ACTIVE'|'PARTIALLY_ACTIVE'|'INACTIVE'|'DELETING',
    'creationTime': datetime(2015, 1, 1),
    'aggregationDuration': 'LONG'|'SHORT'|'NONE'
}

Response Structure

  • (dict) –

    • arn (string) –

      The ARN of the resource.

    • name (string) –

      The name of the NotificationConfiguration.

    • description (string) –

      The description of the NotificationConfiguration.

    • status (string) –

      The status of this NotificationConfiguration.

      The status should always be INACTIVE when part of the CreateNotificationConfiguration response.

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

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

          • Only GET and LIST calls can be run.

    • 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. No delay in delivery.

Exceptions