GetLens - AWS Well-Architected Tool


Get an existing lens.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.


The alias of the lens, for example, serverless.

Each lens is identified by its LensSummary:LensAlias.

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

Required: Yes


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" } }

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.


A lens return object.

Type: Lens object


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


User does not have sufficient access to perform this action.

HTTP Status Code: 403


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

HTTP Status Code: 500


The requested resource was not found.

HTTP Status Code: 404


Request was denied due to request throttling.

HTTP Status Code: 429


The user input is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: