AssociateLenses - AWS Well-Architected Tool


Associate a lens to a workload.

Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.



By accessing and/or applying custom lenses created by another AWS user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the AWS Customer Agreement.

Request Syntax

PATCH /workloads/WorkloadId/associateLenses HTTP/1.1 Content-type: application/json { "LensAliases": [ "string" ] }

URI Request Parameters

The request uses the following URI parameters.


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

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

Required: Yes

Request Body

The request accepts the following data in JSON format.


List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.

Identify a lens using its LensSummary:LensAlias.

Type: Array of strings

Array Members: Minimum number of 1 item.

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

Required: Yes

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.


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


The resource already exists.

HTTP Status Code: 409


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: