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

ListNotifications

List lens notifications.

Request Syntax


POST /notifications HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string",
   "ResourceArn": "string",
   "WorkloadId": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return for this request.

Type: Integer

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

Required: No

NextToken

The token to use to retrieve the next set of results.

Type: String

Required: No

ResourceArn

The ARN for the related resource for the notification.

Note

Only one of WorkloadID or ResourceARN should be specified.

Type: String

Length Constraints: Minimum length of 50. Maximum length of 250.

Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32}

Required: No

WorkloadId

The ID assigned to the workload. This ID is unique within an AWS Region.

Type: String

Length Constraints: Fixed length of 32.

Pattern: [0-9a-f]{32}

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "NotificationSummaries": [ 
      { 
         "LensUpgradeSummary": { 
            "CurrentLensVersion": "string",
            "LatestLensVersion": "string",
            "LensAlias": "string",
            "LensArn": "string",
            "ResourceArn": "string",
            "ResourceName": "string",
            "WorkloadId": "string",
            "WorkloadName": "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

The token to use to retrieve the next set of results.

Type: String

NotificationSummaries

List of lens notification summaries in a workload.

Type: Array of NotificationSummary objects

Errors

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

AccessDeniedException

User does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

There is a problem with the AWS Well-Architected Tool API service.

HTTP Status Code: 500

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The user input is not valid.

HTTP Status Code: 400