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

ListLenses

List the available lenses.

Request Syntax


GET /lenses?LensName=LensName&LensStatus=LensStatus&LensType=LensType&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

LensName

The full name of the lens.

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

LensStatus

The status of lenses to be returned.

Valid Values: ALL | DRAFT | PUBLISHED

LensType

The type of lenses to be returned.

Valid Values: AWS_OFFICIAL | CUSTOM_SHARED | CUSTOM_SELF

MaxResults

The maximum number of results to return for this request.

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

NextToken

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "LensSummaries": [ 
      { 
         "CreatedAt": number,
         "Description": "string",
         "LensAlias": "string",
         "LensArn": "string",
         "LensName": "string",
         "LensStatus": "string",
         "LensType": "string",
         "LensVersion": "string",
         "Owner": "string",
         "UpdatedAt": number
      }
   ],
   "NextToken": "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.

LensSummaries

List of lens summaries of available lenses.

Type: Array of LensSummary objects

NextToken

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

Type: String

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.

Message: Description of the error.

HTTP Status Code: 403

InternalServerException

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

Message: Description of the error.

HTTP Status Code: 500

ThrottlingException

Request was denied due to request throttling.

Message: Description of the error.
QuotaCode: Service Quotas requirement to identify originating quota.
ServiceCode: Service Quotas requirement to identify originating service.

HTTP Status Code: 429

ValidationException

The user input is not valid.

Fields: The fields that caused the error, if applicable.
Message: Description of the error.
Reason: The reason why the request failed validation.

HTTP Status Code: 400