PATCH

/workloads/{WorkloadId}/associateLenses

http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/associateLenses

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. <note> Disclaimer By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement. </note>

Access Token Required: API Key

Path Parameters

WorkloadIdstringrequired

Body Params

LensAliasesarrayrequired

List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified. Identify a lens using its <a>LensSummary$LensAlias</a>.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PATCH \
2     --url 'http://wellarchitected.{region}.amazonaws.com/workloads/{WorkloadId}/associateLenses' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}