Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListNotifications

Lists all Amazon DataZone notifications.

Request Syntax


GET /v2/domains/domainIdentifier/notifications?afterTimestamp=afterTimestamp&beforeTimestamp=beforeTimestamp&maxResults=maxResults&nextToken=nextToken&subjects=subjects&taskStatus=taskStatus&type=type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

afterTimestamp

The time after which you want to list notifications.

beforeTimestamp

The time before which you want to list notifications.

domainIdentifier

The identifier of the Amazon DataZone domain.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

maxResults

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.

Valid Range: Minimum value of 1. Maximum value of 50.

nextToken

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.

Length Constraints: Minimum length of 1. Maximum length of 8192.

subjects

The subjects of notifications.

taskStatus

The task status of notifications.

Valid Values: ACTIVE | INACTIVE

type

The type of notifications.

Valid Values: TASK | EVENT

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "notifications": [ 
      { 
         "actionLink": "string",
         "creationTimestamp": number,
         "domainIdentifier": "string",
         "identifier": "string",
         "lastUpdatedTimestamp": number,
         "message": "string",
         "metadata": { 
            "string" : "string" 
         },
         "status": "string",
         "title": "string",
         "topic": { 
            "resource": { 
               "id": "string",
               "name": "string",
               "type": "string"
            },
            "role": "string",
            "subject": "string"
         },
         "type": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

notifications

The results of the ListNotifications action.

Type: Array of NotificationOutput objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource cannot be found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

UnauthorizedException

You do not have permission to perform this action.

HTTP Status Code: 401

ValidationException

The input fails to satisfy the constraints specified by the AWS service.

HTTP Status Code: 400