Connect / Client / describe_notification

describe_notification

Connect.Client.describe_notification(**kwargs)

Retrieves detailed information about a specific notification, including its content, priority, recipients, and metadata.

See also: AWS API Documentation

Request Syntax

response = client.describe_notification(
    InstanceId='string',
    NotificationId='string'
)
Parameters:
  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • NotificationId (string) –

    [REQUIRED]

    The unique identifier for the notification.

Return type:

dict

Returns:

Response Syntax

{
    'Notification': {
        'Content': {
            'string': 'string'
        },
        'Id': 'string',
        'Arn': 'string',
        'Priority': 'URGENT'|'HIGH'|'LOW',
        'Recipients': [
            'string',
        ],
        'LastModifiedTime': datetime(2015, 1, 1),
        'CreatedAt': datetime(2015, 1, 1),
        'ExpiresAt': datetime(2015, 1, 1),
        'LastModifiedRegion': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • Notification (dict) –

      The complete notification information including content, priority, recipients, and metadata.

      • Content (dict) –

        The localized content of the notification. A map where keys are locale codes and values are the notification text in that locale.

        • (string) –

          The locale code for localized content. Supported values include en_US, de_DE, es_ES, fr_FR, id_ID, it_IT, ja_JP, ko_KR, pt_BR, zh_CN, and zh_TW.

          • (string) –

            A localized string value. Maximum length is 500 characters.

      • Id (string) –

        The unique identifier for the notification.

      • Arn (string) –

        The Amazon Resource Name (ARN) of the notification.

      • Priority (string) –

        The priority level of the notification. Valid values are URGENT, HIGH, and LOW.

      • Recipients (list) –

        A list of Amazon Resource Names (ARNs) identifying the recipients of the notification. Maximum of 200 recipients.

        • (string) –

      • LastModifiedTime (datetime) –

        The timestamp when the notification was last modified.

      • CreatedAt (datetime) –

        The timestamp when the notification was created.

      • ExpiresAt (datetime) –

        The timestamp when the notification expires and is no longer displayed to users.

      • LastModifiedRegion (string) –

        The AWS Region where the notification was last modified.

      • Tags (dict) –

        The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

        • (string) –

          • (string) –

Exceptions

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ThrottlingException

  • Connect.Client.exceptions.AccessDeniedException

  • Connect.Client.exceptions.InvalidParameterException