UserNotifications / Client / get_managed_notification_child_event

get_managed_notification_child_event

UserNotifications.Client.get_managed_notification_child_event(**kwargs)

Returns the child event of a specific given ManagedNotificationEvent.

See also: AWS API Documentation

Request Syntax

response = client.get_managed_notification_child_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 ManagedNotificationChildEvent to return.

• locale (string) – The locale code of the language used for the retrieved ManagedNotificationChildEvent. 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',
        'aggregateManagedNotificationEventArn': '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',
        'aggregationDetail': {
            'summarizationDimensions': [
                {
                    'name': 'string',
                    'value': 'string'
                },
            ]
        }
    }
}

Response Structure

• (dict) –

  • arn (string) –

    The ARN of the resource.

  • managedNotificationConfigurationArn (string) –

    The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration associated with the ManagedNotificationChildEvent.

  • creationTime (datetime) –

    The creation time of the ManagedNotificationChildEvent.

  • content (dict) –

    The content of the ManagedNotificationChildEvent.

    • schemaVersion (string) –

      The schema version of the Managed Notification Child Event.

    • id (string) –

      The unique identifier for a Managed Notification Child Event.

    • 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, Amazon Q Developer in chat applications 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) –

      The source event URL.

    • sourceEventDetailUrlDisplayText (string) –

      The detailed URL for the source event.

    • notificationType (string) –

      The type of event causing the 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 assesed nature of the event.

      • Values:

        • HEALTHY

          • All EventRules are ACTIVE.

        • UNHEALTHY

          • Some EventRules are ACTIVE and some are INACTIVE.

    • aggregateManagedNotificationEventArn (string) –

      The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this Managed Notification Child Event.

    • startTime (datetime) –

      The notification event start time.

    • endTime (datetime) –

      The end time of the 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.

    • aggregationDetail (dict) –

      Provides detailed information about the dimensions used for event summarization and aggregation.

      • summarizationDimensions (list) –

        Properties used to summarize aggregated events.

        • (dict) –

          Provides detailed information about the dimensions used for event summarization and aggregation.

          • name (string) –

            The name of the SummarizationDimensionDetail.

          • value (string) –

            Value of the property used to summarize aggregated events.

Exceptions

• UserNotifications.Client.exceptions.AccessDeniedException

• UserNotifications.Client.exceptions.ValidationException

• UserNotifications.Client.exceptions.InternalServerException

• UserNotifications.Client.exceptions.ResourceNotFoundException

• UserNotifications.Client.exceptions.ThrottlingException