UserNotifications / Client / get_managed_notification_event

get_managed_notification_event#

UserNotifications.Client.get_managed_notification_event(**kwargs)#

Returns a specified ManagedNotificationEvent.

See also: AWS API Documentation

Request Syntax

response = client.get_managed_notification_event(
    arn='string',
    locale='de_DE'|'en_CA'|'en_US'|'en_UK'|'es_ES'|'fr_CA'|'fr_FR'|'id_ID'|'it_IT'|'ja_JP'|'ko_KR'|'pt_BR'|'tr_TR'|'zh_CN'|'zh_TW'
)
Parameters:

  • arn (string) –

    [REQUIRED]

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

  • locale (string) – The locale code of the language used for the retrieved ManagedNotificationEvent. The default locale is English (en_US).

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'managedNotificationConfigurationArn': 'string',
    'creationTime': datetime(2015, 1, 1),
    'content': {
        'schemaVersion': 'v1.0',
        'id': 'string',
        'messageComponents': {
            'headline': 'string',
            'paragraphSummary': 'string',
            'completeDescription': 'string',
            'dimensions': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ]
        },
        'sourceEventDetailUrl': 'string',
        'sourceEventDetailUrlDisplayText': 'string',
        'notificationType': 'ALERT'|'WARNING'|'ANNOUNCEMENT'|'INFORMATIONAL',
        'eventStatus': 'HEALTHY'|'UNHEALTHY',
        'aggregationEventType': 'AGGREGATE'|'CHILD'|'NONE',
        'aggregationSummary': {
            'eventCount': 123,
            'aggregatedBy': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ],
            'aggregatedAccounts': {
                'name': 'string',
                'count': 123,
                'sampleValues': [
                    'string',
                ]
            },
            'aggregatedRegions': {
                'name': 'string',
                'count': 123,
                'sampleValues': [
                    'string',
                ]
            },
            'aggregatedOrganizationalUnits': {
                'name': 'string',
                'count': 123,
                'sampleValues': [
                    'string',
                ]
            },
            'additionalSummarizationDimensions': [
                {
                    'name': 'string',
                    'count': 123,
                    'sampleValues': [
                        'string',
                    ]
                },
            ]
        },
        'startTime': datetime(2015, 1, 1),
        'endTime': datetime(2015, 1, 1),
        'textParts': {
            'string': {
                'type': 'LOCALIZED_TEXT'|'PLAIN_TEXT'|'URL',
                'displayText': 'string',
                'textByLocale': {
                    'string': 'string'
                },
                'url': 'string'
            }
        },
        'organizationalUnitId': 'string'
    }
}

Response Structure

  • (dict) –

    • arn (string) –

      The ARN of the resource.

    • managedNotificationConfigurationArn (string) –

      The ARN of the ManagedNotificationConfiguration.

    • creationTime (datetime) –

      The creation time of the ManagedNotificationEvent.

    • content (dict) –

      The content of the ManagedNotificationEvent.

      • schemaVersion (string) –

        Version of the ManagedNotificationEvent schema.

      • id (string) –

        Unique identifier for a ManagedNotificationEvent.

      • messageComponents (dict) –

        Describes the components of a notification message.

        • headline (string) –

          A sentence long summary. For example, titles or an email subject line.

        • paragraphSummary (string) –

          A paragraph long or multiple sentence summary. For example, Chatbot notifications.

        • completeDescription (string) –

          A complete summary with all possible relevant information.

        • dimensions (list) –

          A list of properties in key-value pairs. Pairs are shown in order of importance from most important to least important. Channels may limit the number of dimensions shown to the notification viewer.

          Note

          Included dimensions, keys, and values are subject to change.

          • (dict) –

            The key-value pair of properties for an event.

            • name (string) –

              The name of the dimension

            • value (string) –

              The value of the dimension.

      • sourceEventDetailUrl (string) –

        URL defined by Source Service to be used by notification consumers to get additional information about event.

      • sourceEventDetailUrlDisplayText (string) –

        Text that needs to be hyperlinked with the sourceEventDetailUrl. For example, the description of the sourceEventDetailUrl.

      • notificationType (string) –

        The nature of the event causing this notification.

        • Values:

          • ALERT

            • A notification about an event where something was triggered, initiated, reopened, deployed, or a threshold was breached.

          • WARNING

            • A notification about an event where an issue is about to arise. For example, something is approaching a threshold.

          • ANNOUNCEMENT

            • A notification about an important event. For example, a step in a workflow or escalation path or that a workflow was updated.

          • INFORMATIONAL

            • A notification about informational messages. For example, recommendations, service announcements, or reminders.

      • eventStatus (string) –

        The status of an event.

        • Values:

          • HEALTHY

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

          • UNHEALTHY

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

      • aggregationEventType (string) –

        The notifications aggregation type.

      • aggregationSummary (dict) –

        Provides additional information about the aggregation key.

        • eventCount (integer) –

          Indicates the number of events associated with the aggregation key.

        • aggregatedBy (list) –

          Indicates the criteria or rules by which notifications have been grouped together.

          • (dict) –

            Key-value collection that indicate how notifications are grouped.

            • name (string) –

              Indicates the type of aggregation key.

            • value (string) –

              Indicates the value associated with the aggregation key name.

        • aggregatedAccounts (dict) –

          Indicates the Amazon Web Services accounts in the aggregation key.

          • name (string) –

            Name of the summarization dimension.

          • count (integer) –

            Total number of occurrences for this dimension.

          • sampleValues (list) –

            Indicates the sample values found within the dimension.

            • (string) –

        • aggregatedRegions (dict) –

          Indicates the Amazon Web Services Regions in the aggregation key.

          • name (string) –

            Name of the summarization dimension.

          • count (integer) –

            Total number of occurrences for this dimension.

          • sampleValues (list) –

            Indicates the sample values found within the dimension.

            • (string) –

        • aggregatedOrganizationalUnits (dict) –

          Indicates the collection of organizational units that are involved in the aggregation key.

          • name (string) –

            Name of the summarization dimension.

          • count (integer) –

            Total number of occurrences for this dimension.

          • sampleValues (list) –

            Indicates the sample values found within the dimension.

            • (string) –

        • additionalSummarizationDimensions (list) –

          List of additional dimensions used to group and summarize data.

          • (dict) –

            Provides an overview of how data is summarized across different dimensions.

            • name (string) –

              Name of the summarization dimension.

            • count (integer) –

              Total number of occurrences for this dimension.

            • sampleValues (list) –

              Indicates the sample values found within the dimension.

              • (string) –

      • startTime (datetime) –

        The earliest time of events to return from this call.

      • endTime (datetime) –

        The end time of the notification event.

      • textParts (dict) –

        A list of text values.

        • (string) –

          • (dict) –

            Describes text information objects containing fields that determine how text part objects are composed.

            • type (string) –

              The type of text part. Determines the usage of all other fields and whether or not they’re required.

            • displayText (string) –

              A short single line description of the link. Must be hyper-linked with the URL itself.

              Used for text parts with the type URL.

            • textByLocale (dict) –

              A map of locales to the text in that locale.

              • (string) –

                • (string) –

            • url (string) –

              The URL itself.

      • organizationalUnitId (string) –

        The Organizational Unit Id that an Amazon Web Services account belongs to.

Exceptions