UserNotifications / Paginator / ListManagedNotificationChildEvents

ListManagedNotificationChildEvents

class UserNotifications.Paginator.ListManagedNotificationChildEvents

paginator = client.get_paginator('list_managed_notification_child_events')

paginate(**kwargs)

Creates an iterator that will paginate through responses from UserNotifications.Client.list_managed_notification_child_events().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    aggregateManagedNotificationEventArn='string',
    startTime=datetime(2015, 1, 1),
    endTime=datetime(2015, 1, 1),
    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',
    relatedAccount='string',
    organizationalUnitId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• aggregateManagedNotificationEventArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) of the ManagedNotificationEvent.

• startTime (datetime) – The earliest time of events to return from this call.

• endTime (datetime) – Latest time of events to return from this call.

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

• relatedAccount (string) – The Amazon Web Services account ID associated with the Managed Notification Child Events.

• organizationalUnitId (string) – The identifier of the Amazon Web Services Organizations organizational unit (OU) associated with the Managed Notification Child Events.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'managedNotificationChildEvents': [
        {
            'arn': 'string',
            'managedNotificationConfigurationArn': 'string',
            'relatedAccount': 'string',
            'creationTime': datetime(2015, 1, 1),
            'childEvent': {
                'schemaVersion': 'v1.0',
                'sourceEventMetadata': {
                    'eventOriginRegion': 'string',
                    'source': 'string',
                    'eventType': 'string'
                },
                'messageComponents': {
                    'headline': 'string'
                },
                'aggregationDetail': {
                    'summarizationDimensions': [
                        {
                            'name': 'string',
                            'value': 'string'
                        },
                    ]
                },
                'eventStatus': 'HEALTHY'|'UNHEALTHY',
                'notificationType': 'ALERT'|'WARNING'|'ANNOUNCEMENT'|'INFORMATIONAL'
            },
            'aggregateManagedNotificationEventArn': 'string',
            'organizationalUnitId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • managedNotificationChildEvents (list) –

    A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries.

    • (dict) –

      Describes an overview and metadata for a ManagedNotificationChildEvent.

      • arn (string) –

        The Amazon Resource Name (ARN) of the ManagedNotificationChildEvent.

      • managedNotificationConfigurationArn (string) –

        The Amazon Resource Name (ARN) of the ManagedNotificationConfiguration.

      • relatedAccount (string) –

        The account that related to the ManagedNotificationChildEvent.

      • creationTime (datetime) –

        The creation time of the ManagedNotificationChildEvent.

      • childEvent (dict) –

        The content of the ManagedNotificationChildEvent.

        • schemaVersion (string) –

          The schema version of the ManagedNotificationChildEvent.

        • sourceEventMetadata (dict) –

          Contains all event metadata present identically across all NotificationEvents. All fields are present in Source Events via Eventbridge.

          • eventOriginRegion (string) –

            The Region where the notification originated.

          • source (string) –

            The source service of the notification.

            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.

          • eventType (string) –

            The event Type of the notification.

        • messageComponents (dict) –

          Contains the headline message component.

          • headline (string) –

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

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

        • eventStatus (string) –

          The perceived nature of the 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.

        • notificationType (string) –

          The Type 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.

      • aggregateManagedNotificationEventArn (string) –

        The Amazon Resource Name (ARN) of the ManagedNotificationEvent that is associated with this ManagedNotificationChildEvent.

      • organizationalUnitId (string) –

        The Organizational Unit Id that an AWS account belongs to.

  • NextToken (string) –

    A token to resume pagination.