CreateLensVersion - AWS Well-Architected Tool

CreateLensVersion

Create a new lens version.

A lens can have up to 100 versions.

After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other AWS accounts and IAM users in the same AWS Region. Only the owner of a lens can delete it.

Request Syntax

POST /lenses/LensAlias/versions HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "IsMajorVersion": boolean, "LensVersion": "string" }

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-west-2::lens/serverless.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens.

Each lens is identified by its LensSummary:LensAlias.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

ClientRequestToken

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned.

Important

This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail.

Type: String

Required: Yes

IsMajorVersion

Set to true if this new major lens version.

Type: Boolean

Required: No

LensVersion

The version of the lens being created.

Type: String

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

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "LensArn": "string", "LensVersion": "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.

LensArn

The ARN for the lens.

Type: String

LensVersion

The version of the lens.

Type: String

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

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

ConflictException

The resource already exists.

HTTP Status Code: 409

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

ServiceQuotaExceededException

The user has reached their resource quota.

HTTP Status Code: 402

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

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: