DataZone / Client / list_notifications

list_notifications

DataZone.Client.list_notifications(**kwargs)

Lists all Amazon DataZone notifications.

See also: AWS API Documentation

Request Syntax

response = client.list_notifications(
    afterTimestamp=datetime(2015, 1, 1),
    beforeTimestamp=datetime(2015, 1, 1),
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    subjects=[
        'string',
    ],
    taskStatus='ACTIVE'|'INACTIVE',
    type='TASK'|'EVENT'
)

Parameters:

• afterTimestamp (datetime) – The time after which you want to list notifications.

• beforeTimestamp (datetime) – The time before which you want to list notifications.

• domainIdentifier (string) –

  [REQUIRED]

  The identifier of the Amazon DataZone domain.

• maxResults (integer) – The maximum number of notifications to return in a single call to ListNotifications. When the number of notifications to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListNotifications to list the next set of notifications.

• nextToken (string) – When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.

• subjects (list) –

  The subjects of notifications.

  • (string) –

• taskStatus (string) – The task status of notifications.

• type (string) –

  [REQUIRED]

  The type of notifications.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'notifications': [
        {
            'actionLink': 'string',
            'creationTimestamp': datetime(2015, 1, 1),
            'domainIdentifier': 'string',
            'identifier': 'string',
            'lastUpdatedTimestamp': datetime(2015, 1, 1),
            'message': 'string',
            'metadata': {
                'string': 'string'
            },
            'status': 'ACTIVE'|'INACTIVE',
            'title': 'string',
            'topic': {
                'resource': {
                    'id': 'string',
                    'name': 'string',
                    'type': 'PROJECT'
                },
                'role': 'PROJECT_OWNER'|'PROJECT_CONTRIBUTOR'|'PROJECT_VIEWER'|'DOMAIN_OWNER'|'PROJECT_SUBSCRIBER',
                'subject': 'string'
            },
            'type': 'TASK'|'EVENT'
        },
    ]
}

Response Structure

• (dict) –

  • nextToken (string) –

    When the number of notifications is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notifications, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotifications to list the next set of notifications.

  • notifications (list) –

    The results of the ListNotifications action.

    • (dict) –

      The details of a notification generated in Amazon DataZone.

      • actionLink (string) –

        The action link included in the notification.

      • creationTimestamp (datetime) –

        The timestamp of when a notification was created.

      • domainIdentifier (string) –

        The identifier of a Amazon DataZone domain in which the notification exists.

      • identifier (string) –

        The identifier of the notification.

      • lastUpdatedTimestamp (datetime) –

        The timestamp of when the notification was last updated.

      • message (string) –

        The message included in the notification.

      • metadata (dict) –

        The metadata included in the notification.

        • (string) –

          • (string) –

      • status (string) –

        The status included in the notification.

      • title (string) –

        The title of the notification.

      • topic (dict) –

        The topic of the notification.

        • resource (dict) –

          The details of the resource mentioned in a notification.

          • id (string) –

            The ID of the resource mentioned in a notification.

          • name (string) –

            The name of the resource mentioned in a notification.

          • type (string) –

            The type of the resource mentioned in a notification.

        • role (string) –

          The role of the resource mentioned in a notification.

        • subject (string) –

          The subject of the resource mentioned in a notification.

      • type (string) –

        The type of the notification.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.ResourceNotFoundException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException