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

GetLens

Get an existing lens.

Request Syntax


GET /lenses/LensAlias?LensVersion=LensVersion HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

LensAlias

The alias of the lens.

For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary:LensAlias.

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

Required: Yes

LensVersion

The lens version to be retrieved.

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

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Lens": { 
      "Description": "string",
      "LensArn": "string",
      "LensVersion": "string",
      "Name": "string",
      "Owner": "string",
      "ShareInvitationId": "string",
      "Tags": { 
         "string" : "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.

Lens

A lens return object.

Type: Lens object

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

ResourceNotFoundException

The requested resource was not found.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The user input is not valid.

HTTP Status Code: 400