This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.
","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"wellarchitected","x-aws-signingName":"wellarchitected","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/wellarchitected-2020-03-31.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/wellarchitected/"},"servers":[{"url":"http://wellarchitected.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Well-Architected multi-region endpoint"},{"url":"https://wellarchitected.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Well-Architected multi-region endpoint"},{"url":"http://wellarchitected.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Well-Architected endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://wellarchitected.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Well-Architected endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/workloads/{WorkloadId}/associateLenses":{"patch":{"operationId":"AssociateLenses","description":"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.
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.
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","items":{"$ref":"#/components/schemas/LensAlias"},"minItems":1}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/associateProfiles":{"patch":{"operationId":"AssociateProfiles","description":"Associate a profile with a workload.","responses":{"200":{"description":"Success"},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProfileArns"],"properties":{"ProfileArns":{"description":"The list of profile ARNs to associate with the workload.","type":"array","items":{"$ref":"#/components/schemas/ProfileArn"},"minItems":1}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/lenses/{LensAlias}/shares":{"post":{"operationId":"CreateLensShare","description":"Create a lens share.
The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.
Shared access to a lens is not removed until the lens invitation is deleted.
If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens.
For more information, see Sharing a custom lens in the Well-Architected Tool User Guide.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SharedWith","ClientRequestToken"],"properties":{"SharedWith":{"description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.","type":"string","minLength":12,"maxLength":2048},"ClientRequestToken":{"description":"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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"SharedWithPrefix","in":"query","required":false,"description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.","schema":{"type":"string","maxLength":100}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to return for this request.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"Status","in":"query","required":false,"description":"","schema":{"type":"string","enum":["ACCEPTED","REJECTED","PENDING","REVOKED","EXPIRED","ASSOCIATING","ASSOCIATED","FAILED"],"description":"The status of the share request."}}]}},"/lenses/{LensAlias}/versions":{"post":{"operationId":"CreateLensVersion","description":"Create a new lens version.
A lens can have up to 100 versions.
Use this operation to publish a new lens version after you have imported a lens. The LensAlias is used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LensVersion","ClientRequestToken"],"properties":{"LensVersion":{"description":"The version of the lens being created.","type":"string","minLength":1,"maxLength":32},"IsMajorVersion":{"description":"Set to true if this new major lens version.","type":"boolean"},"ClientRequestToken":{"description":"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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
The name of the milestone in a workload.
Milestone names must be unique within a workload.
","type":"string","minLength":3,"maxLength":100},"ClientRequestToken":{"description":"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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the Well-Architected Tool User Guide.
Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload.
You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.
The name of the workload.
The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
","type":"string","minLength":3,"maxLength":100},"Description":{"description":"The description for the workload.","type":"string","minLength":3,"maxLength":250},"Environment":{"description":"The environment for the workload.","type":"string","enum":["PRODUCTION","PREPRODUCTION"]},"AccountIds":{"description":"The list of Amazon Web Services account IDs associated with the workload.","type":"array","items":{"$ref":"#/components/schemas/AwsAccountId"},"maxItems":100},"AwsRegions":{"description":"The list of Amazon Web Services Regions associated with the workload, for example,us-east-2, or ca-central-1.","type":"array","items":{"$ref":"#/components/schemas/AwsRegion"},"maxItems":50},"NonAwsRegions":{"description":" The list of non-Amazon Web Services Regions associated with the workload.","type":"array","items":{"$ref":"#/components/schemas/WorkloadNonAwsRegion"},"maxItems":5},"PillarPriorities":{"description":"The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.","type":"array","items":{"$ref":"#/components/schemas/PillarId"}},"ArchitecturalDesign":{"description":"The URL of the architectural design for the workload.","type":"string","pattern":"^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$","maxLength":2048},"ReviewOwner":{"description":"The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.","type":"string","minLength":3,"maxLength":255},"IndustryType":{"description":"The industry type for the workload.
If specified, must be one of the following:
Agriculture
Automobile
Defense
Design and Engineering
Digital Advertising
Education
Environmental Protection
Financial Services
Gaming
General Public Services
Healthcare
Hospitality
InfoTech
Justice and Public Safety
Life Sciences
Manufacturing
Media & Entertainment
Mining & Resources
Oil & Gas
Power & Utilities
Professional Services
Real Estate & Construction
Retail & Wholesale
Social Protection
Telecommunications
Travel, Transportation & Logistics
Other
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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.
Create a workload share.
The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.
If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.
For more information, see Sharing a workload in the Well-Architected Tool User Guide.
","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkloadShareOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SharedWith","PermissionType","ClientRequestToken"],"properties":{"SharedWith":{"description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.","type":"string","minLength":12,"maxLength":2048},"PermissionType":{"description":"Permission granted on a share request.","type":"string","enum":["READONLY","CONTRIBUTOR"]},"ClientRequestToken":{"description":"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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
Delete an existing lens.
Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"ClientRequestToken","in":"query","required":true,"description":"","schema":{"type":"string","description":"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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
Delete a lens share.
After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"ClientRequestToken","in":"query","required":true,"description":"","schema":{"type":"string","description":"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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
Delete a profile.
Disclaimer
By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.
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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
Disassociate a lens from a workload.
Up to 10 lenses can be disassociated from a workload in a single API operation.
The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.
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","items":{"$ref":"#/components/schemas/LensAlias"},"minItems":1}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/disassociateProfiles":{"patch":{"operationId":"DisassociateProfiles","description":"Disassociate a profile from a workload.","responses":{"200":{"description":"Success"},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProfileArns"],"properties":{"ProfileArns":{"description":"The list of profile ARNs to disassociate from the workload.","type":"array","items":{"$ref":"#/components/schemas/ProfileArn"},"minItems":1}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/lenses/{LensAlias}/export":{"get":{"operationId":"ExportLens","description":"Export an existing lens.
Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"LensVersion","in":"query","required":false,"description":"The lens version to be exported.","schema":{"type":"string","minLength":1,"maxLength":32}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}":{"get":{"operationId":"GetAnswer","description":"Get the answer to a specific question in a workload review.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAnswerOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"QuestionId","in":"path","required":true,"description":"","schema":{"type":"string","description":"The ID of the question.","minLength":1,"maxLength":128}},{"name":"MilestoneNumber","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The milestone number.
A workload can have a maximum of 100 milestones.
","minimum":1,"maximum":100}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"patch":{"operationId":"UpdateAnswer","description":"Update the answer to a specific question in a workload review.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAnswerOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"QuestionId","in":"path","required":true,"description":"","schema":{"type":"string","description":"The ID of the question.","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"SelectedChoices":{"description":"List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
","type":"array","items":{"$ref":"#/components/schemas/ChoiceId"}},"ChoiceUpdates":{"description":"A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.","type":"object","additionalProperties":{"$ref":"#/components/schemas/ChoiceUpdate"}},"Notes":{"description":"The notes associated with the workload.","type":"string","maxLength":2084},"IsApplicable":{"description":"Defines whether this question is applicable to a lens review.","type":"boolean"},"Reason":{"description":"The reason why a question is not applicable to your workload.","type":"string","enum":["OUT_OF_SCOPE","BUSINESS_PRIORITIES","ARCHITECTURE_CONSTRAINTS","OTHER","NONE"]}}}}}}}},"/consolidatedReport#Format":{"get":{"operationId":"GetConsolidatedReport","description":"Get a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetConsolidatedReportOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}}},"parameters":[{"name":"Format","in":"query","required":true,"description":"The format of the consolidated report.
For PDF, Base64String is returned. For JSON, Metrics is returned.
true to have shared resources included in the report.","schema":{"type":"boolean"}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to return for this request.","schema":{"type":"integer","minimum":1,"maximum":15}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/lenses/{LensAlias}":{"get":{"operationId":"GetLens","description":"Get an existing lens.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLensOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"LensVersion","in":"query","required":false,"description":"The lens version to be retrieved.","schema":{"type":"string","minLength":1,"maxLength":32}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/lensReviews/{LensAlias}":{"get":{"operationId":"GetLensReview","description":"Get lens review.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLensReviewOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"MilestoneNumber","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The milestone number.
A workload can have a maximum of 100 milestones.
","minimum":1,"maximum":100}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"patch":{"operationId":"UpdateLensReview","description":"Update lens review for a particular workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLensReviewOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"LensNotes":{"description":"The notes associated with the workload.","type":"string","maxLength":2084},"PillarNotes":{"description":"List of pillar notes of a lens review in a workload.","type":"object","additionalProperties":{"$ref":"#/components/schemas/Notes"}}}}}}}}},"/workloads/{WorkloadId}/lensReviews/{LensAlias}/report":{"get":{"operationId":"GetLensReviewReport","description":"Get lens review report.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLensReviewReportOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"MilestoneNumber","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The milestone number.
A workload can have a maximum of 100 milestones.
","minimum":1,"maximum":100}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/lenses/{LensAlias}/versionDifference":{"get":{"operationId":"GetLensVersionDifference","description":"Get lens version differences.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLensVersionDifferenceOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"BaseLensVersion","in":"query","required":false,"description":"The base version of the lens.","schema":{"type":"string","minLength":1,"maxLength":32}},{"name":"TargetLensVersion","in":"query","required":false,"description":"The lens version to target a difference for.","schema":{"type":"string","minLength":1,"maxLength":32}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/milestones/{MilestoneNumber}":{"get":{"operationId":"GetMilestone","description":"Get a milestone for an existing workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMilestoneOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"MilestoneNumber","in":"path","required":true,"description":"","schema":{"type":"integer","description":"The milestone number.
A workload can have a maximum of 100 milestones.
","minimum":1,"maximum":100}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/profiles/{ProfileArn}":{"get":{"operationId":"GetProfile","description":"Get profile information.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProfileOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"ProfileArn","in":"path","required":true,"description":"The profile ARN.","schema":{"type":"string","pattern":"arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+","maxLength":2084}},{"name":"ProfileVersion","in":"query","required":false,"description":"The profile version.","schema":{"type":"string","pattern":"^[A-Za-z0-9-]+$","minLength":1,"maxLength":32}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"patch":{"operationId":"UpdateProfile","description":"Update a profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProfileOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"ProfileArn","in":"path","required":true,"description":"The profile ARN.","schema":{"type":"string","pattern":"arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+","maxLength":2084}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"ProfileDescription":{"description":"The profile description.","type":"string","pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$","minLength":3,"maxLength":100},"ProfileQuestions":{"description":"Profile questions.","type":"array","items":{"$ref":"#/components/schemas/ProfileQuestionUpdate"}}}}}}}}},"/profileTemplate":{"get":{"operationId":"GetProfileTemplate","description":"Get profile template.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetProfileTemplateOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}":{"get":{"operationId":"GetWorkload","description":"Get an existing workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkloadOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"patch":{"operationId":"UpdateWorkload","description":"Update an existing workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkloadOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"WorkloadName":{"description":"The name of the workload.
The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
","type":"string","minLength":3,"maxLength":100},"Description":{"description":"The description for the workload.","type":"string","minLength":3,"maxLength":250},"Environment":{"description":"The environment for the workload.","type":"string","enum":["PRODUCTION","PREPRODUCTION"]},"AccountIds":{"description":"The list of Amazon Web Services account IDs associated with the workload.","type":"array","items":{"$ref":"#/components/schemas/AwsAccountId"},"maxItems":100},"AwsRegions":{"description":"The list of Amazon Web Services Regions associated with the workload, for example,us-east-2, or ca-central-1.","type":"array","items":{"$ref":"#/components/schemas/AwsRegion"},"maxItems":50},"NonAwsRegions":{"description":" The list of non-Amazon Web Services Regions associated with the workload.","type":"array","items":{"$ref":"#/components/schemas/WorkloadNonAwsRegion"},"maxItems":5},"PillarPriorities":{"description":"The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.","type":"array","items":{"$ref":"#/components/schemas/PillarId"}},"ArchitecturalDesign":{"description":"The URL of the architectural design for the workload.","type":"string","pattern":"^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$","maxLength":2048},"ReviewOwner":{"description":"The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.","type":"string","minLength":3,"maxLength":255},"IsReviewOwnerUpdateAcknowledged":{"description":"Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
","type":"boolean"},"IndustryType":{"description":"The industry type for the workload.
If specified, must be one of the following:
Agriculture
Automobile
Defense
Design and Engineering
Digital Advertising
Education
Environmental Protection
Financial Services
Gaming
General Public Services
Healthcare
Hospitality
InfoTech
Justice and Public Safety
Life Sciences
Manufacturing
Media & Entertainment
Mining & Resources
Oil & Gas
Power & Utilities
Professional Services
Real Estate & Construction
Retail & Wholesale
Social Protection
Telecommunications
Travel, Transportation & Logistics
Other
The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.
Import a new custom lens or update an existing custom lens.
To update an existing custom lens, specify its ARN as the LensAlias. If no ARN is specified, a new custom lens is created.
The new or updated lens will have a status of DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
A custom lens cannot exceed 500 KB in size.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","type":"string","minLength":1,"maxLength":128},"JSONString":{"description":"The JSON representation of a lens.","type":"string","minLength":2,"maxLength":500000},"ClientRequestToken":{"description":"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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"PillarId","in":"query","required":false,"description":"","schema":{"type":"string","description":"The ID used to identify a pillar, for example, security.
A pillar is identified by its PillarReviewSummary$PillarId.
","minLength":1,"maxLength":64}},{"name":"MilestoneNumber","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The milestone number.
A workload can have a maximum of 100 milestones.
","minimum":1,"maximum":100}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to return for this request.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"QuestionPriority","in":"query","required":false,"description":"The priority of the question.","schema":{"type":"string","enum":["PRIORITIZED","NONE"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/checks":{"post":{"operationId":"ListCheckDetails","description":"List of Trusted Advisor check details by account related to the workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCheckDetailsOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LensArn","PillarId","QuestionId","ChoiceId"],"properties":{"NextToken":{"description":"The token to use to retrieve the next set of results.","type":"string"},"MaxResults":{"description":"The maximum number of results to return for this request.","type":"integer","minimum":1,"maximum":50},"LensArn":{"description":"Well-Architected Lens ARN.","type":"string"},"PillarId":{"description":"The ID used to identify a pillar, for example, security.
A pillar is identified by its PillarReviewSummary$PillarId.
","type":"string","minLength":1,"maxLength":64},"QuestionId":{"description":"The ID of the question.","type":"string","minLength":1,"maxLength":128},"ChoiceId":{"description":"The ID of a choice.","type":"string","minLength":1,"maxLength":64}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/checkSummaries":{"post":{"operationId":"ListCheckSummaries","description":"List of Trusted Advisor checks summarized for all accounts related to the workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCheckSummariesOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LensArn","PillarId","QuestionId","ChoiceId"],"properties":{"NextToken":{"description":"The token to use to retrieve the next set of results.","type":"string"},"MaxResults":{"description":"The maximum number of results to return for this request.","type":"integer","minimum":1,"maximum":50},"LensArn":{"description":"Well-Architected Lens ARN.","type":"string"},"PillarId":{"description":"The ID used to identify a pillar, for example, security.
A pillar is identified by its PillarReviewSummary$PillarId.
","type":"string","minLength":1,"maxLength":64},"QuestionId":{"description":"The ID of the question.","type":"string","minLength":1,"maxLength":128},"ChoiceId":{"description":"The ID of a choice.","type":"string","minLength":1,"maxLength":64}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements":{"get":{"operationId":"ListLensReviewImprovements","description":"List lens review improvements.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLensReviewImprovementsOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}},{"name":"PillarId","in":"query","required":false,"description":"","schema":{"type":"string","description":"The ID used to identify a pillar, for example, security.
A pillar is identified by its PillarReviewSummary$PillarId.
","minLength":1,"maxLength":64}},{"name":"MilestoneNumber","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The milestone number.
A workload can have a maximum of 100 milestones.
","minimum":1,"maximum":100}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to return for this request.","schema":{"type":"integer","minimum":1,"maximum":100}},{"name":"QuestionPriority","in":"query","required":false,"description":"The priority of the question.","schema":{"type":"string","enum":["PRIORITIZED","NONE"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/lensReviews":{"get":{"operationId":"ListLensReviews","description":"List lens reviews for a particular workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLensReviewsOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"MilestoneNumber","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The milestone number.
A workload can have a maximum of 100 milestones.
","minimum":1,"maximum":100}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The maximum number of results to return for this request.","minimum":1,"maximum":50}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/lenses":{"get":{"operationId":"ListLenses","description":"List the available lenses.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLensesOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The maximum number of results to return for this request.","minimum":1,"maximum":50}},{"name":"LensType","in":"query","required":false,"description":"The type of lenses to be returned.","schema":{"type":"string","enum":["AWS_OFFICIAL","CUSTOM_SHARED","CUSTOM_SELF"]}},{"name":"LensStatus","in":"query","required":false,"description":"The status of lenses to be returned.","schema":{"type":"string","enum":["ALL","DRAFT","PUBLISHED"]}},{"name":"LensName","in":"query","required":false,"description":"","schema":{"type":"string","description":"The full name of the lens.","minLength":1,"maxLength":128}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/milestonesSummaries":{"post":{"operationId":"ListMilestones","description":"List all milestones for an existing workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMilestonesOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"NextToken":{"description":"The token to use to retrieve the next set of results.","type":"string"},"MaxResults":{"description":"The maximum number of results to return for this request.","type":"integer","minimum":1,"maximum":50}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/notifications":{"post":{"operationId":"ListNotifications","description":"List lens notifications.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListNotificationsOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"MaxResults","in":"query","schema":{"type":"string"},"description":"Pagination limit","required":false},{"name":"NextToken","in":"query","schema":{"type":"string"},"description":"Pagination token","required":false}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"WorkloadId":{"description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","type":"string","pattern":"[0-9a-f]{32}","minLength":32,"maxLength":32},"NextToken":{"description":"The token to use to retrieve the next set of results.","type":"string"},"MaxResults":{"description":"The maximum number of results to return for this request.","type":"integer","minimum":1,"maximum":50}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/profileNotifications/":{"get":{"operationId":"ListProfileNotifications","description":"List profile notifications.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProfileNotificationsOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"query","required":false,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The maximum number of results to return for this request.","minimum":1,"maximum":50}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/profileSummaries":{"get":{"operationId":"ListProfiles","description":"List profiles.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProfilesOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"ProfileNamePrefix","in":"query","required":false,"description":"Prefix for profile name.","schema":{"type":"string","pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$","maxLength":100}},{"name":"ProfileOwnerType","in":"query","required":false,"description":"Profile owner type.","schema":{"type":"string","enum":["SELF","SHARED"]}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"","schema":{"type":"integer","description":"The maximum number of results to return for this request.","minimum":1,"maximum":50}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/shareInvitations":{"get":{"operationId":"ListShareInvitations","description":"List the workload invitations.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListShareInvitationsOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadNamePrefix","in":"query","required":false,"description":"","schema":{"type":"string","description":"An optional string added to the beginning of each workload name returned in the results.","maxLength":100}},{"name":"LensNamePrefix","in":"query","required":false,"description":"An optional string added to the beginning of each lens name returned in the results.","schema":{"type":"string","maxLength":100}},{"name":"ShareResourceType","in":"query","required":false,"description":"The type of share invitations to be returned.","schema":{"type":"string","enum":["WORKLOAD","LENS","PROFILE"]}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to return for this request.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"ProfileNamePrefix","in":"query","required":false,"description":"Profile name prefix.","schema":{"type":"string","pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$","maxLength":100}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tags/{WorkloadArn}":{"get":{"operationId":"ListTagsForResource","description":"List the tags for a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
Adds one or more tags to the specified resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
Deletes specified tags from a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
Update a workload or custom lens share invitation.
This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MilestoneName"],"properties":{"MilestoneName":{"description":"The name of the milestone in a workload.
Milestone names must be unique within a workload.
","type":"string","minLength":3,"maxLength":100},"ClientRequestToken":{"description":"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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
The name of the milestone in a workload.
Milestone names must be unique within a workload.
","type":"string","minLength":3,"maxLength":100},"ClientRequestToken":{"description":"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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
The alias of the lens.
For Amazon Web Services 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 Amazon Web Services 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.
","minLength":1,"maxLength":128},"ValidationException":{},"ResourceNotFoundException":{},"ConflictException":{},"InternalServerException":{},"AccessDeniedException":{},"ThrottlingException":{},"ProfileArn":{"type":"string","pattern":"arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+","maxLength":2084},"CreateLensShareOutput":{"type":"object","properties":{"ShareId":{"$ref":"#/components/schemas/ShareId"}}},"ServiceQuotaExceededException":{},"CreateLensVersionOutput":{"type":"object","properties":{"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"The ARN for the lens."}]},"LensVersion":{"allOf":[{"$ref":"#/components/schemas/LensVersion"},{"description":"The version of the lens."}]}}},"CreateMilestoneOutput":{"type":"object","properties":{"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"MilestoneNumber":{"$ref":"#/components/schemas/MilestoneNumber"}},"description":"Output of a create milestone call."},"CreateProfileOutput":{"type":"object","properties":{"ProfileArn":{"allOf":[{"$ref":"#/components/schemas/ProfileArn"},{"description":"The profile ARN."}]},"ProfileVersion":{"allOf":[{"$ref":"#/components/schemas/ProfileVersion"},{"description":"Version of the profile."}]}}},"ProfileQuestionUpdate":{"type":"object","properties":{"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"SelectedChoiceIds":{"allOf":[{"$ref":"#/components/schemas/SelectedProfileChoiceIds"},{"description":"The selected choices."}]}},"description":"An update to a profile question."},"TagValue":{"type":"string","minLength":0,"maxLength":256},"CreateProfileShareOutput":{"type":"object","properties":{"ShareId":{"$ref":"#/components/schemas/ShareId"},"ProfileArn":{"allOf":[{"$ref":"#/components/schemas/ProfileArn"},{"description":"The profile ARN."}]}}},"CreateWorkloadOutput":{"type":"object","properties":{"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"WorkloadArn":{"$ref":"#/components/schemas/WorkloadArn"}},"description":"Output of a create workload call."},"AwsAccountId":{"type":"string","pattern":"[0-9]{12}","description":"An Amazon Web Services account ID.","minLength":12,"maxLength":12},"AwsRegion":{"type":"string","description":"An Amazon Web Services Region, for example,us-west-2 or ap-northeast-1.","maxLength":100},"WorkloadNonAwsRegion":{"type":"string","minLength":3,"maxLength":25},"PillarId":{"type":"string","description":"The ID used to identify a pillar, for example, security.
A pillar is identified by its PillarReviewSummary$PillarId.
","minLength":1,"maxLength":64},"TrustedAdvisorIntegrationStatus":{"type":"string","enum":["ENABLED","DISABLED"]},"WorkloadResourceDefinition":{"type":"array","items":{"$ref":"#/components/schemas/DefinitionType"}},"ApplicationArn":{"type":"string","pattern":"arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+","maxLength":2084},"CreateWorkloadShareOutput":{"type":"object","properties":{"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"ShareId":{"$ref":"#/components/schemas/ShareId"}},"description":"Input for Create Workload Share"},"ExportLensOutput":{"type":"object","properties":{"LensJSON":{"allOf":[{"$ref":"#/components/schemas/LensJSON"},{"description":"The JSON representation of a lens."}]}}},"GetAnswerOutput":{"type":"object","properties":{"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"MilestoneNumber":{"$ref":"#/components/schemas/MilestoneNumber"},"LensAlias":{"$ref":"#/components/schemas/LensAlias"},"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"The ARN for the lens."}]},"Answer":{"$ref":"#/components/schemas/Answer"}},"description":"Output of a get answer call."},"GetConsolidatedReportOutput":{"type":"object","properties":{"Metrics":{"allOf":[{"$ref":"#/components/schemas/ConsolidatedReportMetrics"},{"description":"The metrics that make up the consolidated report.
Only returned when JSON format is requested.
The choice level additional resources for a custom lens.
This field does not apply to Amazon Web Services official lenses.
"},"AdditionalResourcesList":{"type":"array","items":{"$ref":"#/components/schemas/AdditionalResources"}},"QuestionId":{"type":"string","description":"The ID of the question.","minLength":1,"maxLength":128},"QuestionTitle":{"type":"string","description":"The title of the question.","minLength":1,"maxLength":512},"QuestionDescription":{"type":"string","description":"The description of the question.","minLength":1,"maxLength":1024},"ImprovementPlanUrl":{"type":"string","description":"The improvement plan URL for a question in an Amazon Web Services official lenses.
This value is only available if the question has been answered.
This value does not apply to custom lenses.
","minLength":1,"maxLength":2048},"HelpfulResourceUrl":{"type":"string","description":"The helpful resource URL.
For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.
For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.
List of selected choice IDs in a question answer.
The values entered replace the previously selected choices.
","items":{"$ref":"#/components/schemas/ChoiceId"}},"ChoiceAnswers":{"type":"array","items":{"$ref":"#/components/schemas/ChoiceAnswer"}},"IsApplicable":{"type":"boolean","description":"Defines whether this question is applicable to a lens review."},"Risk":{"type":"string","enum":["UNANSWERED","HIGH","MEDIUM","NONE","NOT_APPLICABLE"],"description":"The risk for a given workload, lens review, pillar, or question."},"AnswerReason":{"type":"string","enum":["OUT_OF_SCOPE","BUSINESS_PRIORITIES","ARCHITECTURE_CONSTRAINTS","OTHER","NONE"]},"Answer":{"type":"object","properties":{"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"PillarId":{"$ref":"#/components/schemas/PillarId"},"QuestionTitle":{"$ref":"#/components/schemas/QuestionTitle"},"QuestionDescription":{"$ref":"#/components/schemas/QuestionDescription"},"ImprovementPlanUrl":{"$ref":"#/components/schemas/ImprovementPlanUrl"},"HelpfulResourceUrl":{"$ref":"#/components/schemas/HelpfulResourceUrl"},"HelpfulResourceDisplayText":{"allOf":[{"$ref":"#/components/schemas/DisplayText"},{"description":"The helpful resource text to be displayed for a custom lens.
This field does not apply to Amazon Web Services official lenses.
"}]},"Choices":{"$ref":"#/components/schemas/Choices"},"SelectedChoices":{"$ref":"#/components/schemas/SelectedChoices"},"ChoiceAnswers":{"allOf":[{"$ref":"#/components/schemas/ChoiceAnswers"},{"description":"A list of selected choices to a question in your workload."}]},"IsApplicable":{"$ref":"#/components/schemas/IsApplicable"},"Risk":{"$ref":"#/components/schemas/Risk"},"Notes":{"$ref":"#/components/schemas/Notes"},"Reason":{"allOf":[{"$ref":"#/components/schemas/AnswerReason"},{"description":"The reason why the question is not applicable to your workload."}]}},"description":"An answer of the question."},"AnswerSummary":{"type":"object","properties":{"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"PillarId":{"$ref":"#/components/schemas/PillarId"},"QuestionTitle":{"$ref":"#/components/schemas/QuestionTitle"},"Choices":{"$ref":"#/components/schemas/Choices"},"SelectedChoices":{"$ref":"#/components/schemas/SelectedChoices"},"ChoiceAnswerSummaries":{"allOf":[{"$ref":"#/components/schemas/ChoiceAnswerSummaries"},{"description":"A list of selected choices to a question in your workload."}]},"IsApplicable":{"$ref":"#/components/schemas/IsApplicable"},"Risk":{"$ref":"#/components/schemas/Risk"},"Reason":{"allOf":[{"$ref":"#/components/schemas/AnswerReason"},{"description":"The reason why a choice is non-applicable to a question in your workload."}]},"QuestionType":{"allOf":[{"$ref":"#/components/schemas/QuestionType"},{"description":"The type of the question."}]}},"description":"An answer summary of a lens review in a workload."},"AnswerSummaries":{"type":"array","description":"List of answer summaries of lens review in a workload.","items":{"$ref":"#/components/schemas/AnswerSummary"}},"ChoiceAnswerSummaries":{"type":"array","items":{"$ref":"#/components/schemas/ChoiceAnswerSummary"}},"QuestionType":{"type":"string","enum":["PRIORITIZED","NON_PRIORITIZED"]},"WorkloadId":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32},"LensAliases":{"type":"array","description":"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.
","items":{"$ref":"#/components/schemas/LensAlias"},"minItems":1},"AssociateLensesInput":{"type":"object","required":["LensAliases"],"title":"AssociateLensesInput","properties":{"LensAliases":{"$ref":"#/components/schemas/LensAliases"}},"description":"Input to associate lens reviews."},"ProfileArns":{"type":"array","items":{"$ref":"#/components/schemas/ProfileArn"},"minItems":1},"AssociateProfilesInput":{"type":"object","required":["ProfileArns"],"title":"AssociateProfilesInput","properties":{"ProfileArns":{"allOf":[{"$ref":"#/components/schemas/ProfileArns"},{"description":"The list of profile ARNs to associate with the workload."}]}}},"Base64String":{"type":"string","description":"The Base64-encoded string representation of a lens review report.
This data can be used to create a PDF file.
Only returned by GetConsolidatedReport when PDF format is requested.
The helpful resource (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one helpful resource.
"}]},"ImprovementPlan":{"allOf":[{"$ref":"#/components/schemas/ChoiceContent"},{"description":"The improvement plan (both text and URL) for a particular choice.
This field only applies to custom lenses. Each choice can have only one improvement plan.
"}]},"AdditionalResources":{"allOf":[{"$ref":"#/components/schemas/AdditionalResourcesList"},{"description":"The additional resources for a choice in a custom lens.
A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.
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 the original request has completed successfully, the result of the original request is returned.
This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.
The name of the workload.
The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.
","minLength":3,"maxLength":100},"WorkloadArn":{"type":"string","description":"The ARN for the workload."},"LensMetrics":{"type":"array","items":{"$ref":"#/components/schemas/LensMetric"}},"LensesAppliedCount":{"type":"integer","minimum":0},"ConsolidatedReportMetric":{"type":"object","properties":{"MetricType":{"allOf":[{"$ref":"#/components/schemas/MetricType"},{"description":"The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported."}]},"RiskCounts":{"$ref":"#/components/schemas/RiskCounts"},"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"WorkloadName":{"$ref":"#/components/schemas/WorkloadName"},"WorkloadArn":{"$ref":"#/components/schemas/WorkloadArn"},"UpdatedAt":{"$ref":"#/components/schemas/Timestamp"},"Lenses":{"allOf":[{"$ref":"#/components/schemas/LensMetrics"},{"description":"The metrics for the lenses in the workload."}]},"LensesAppliedCount":{"allOf":[{"$ref":"#/components/schemas/LensesAppliedCount"},{"description":"The total number of lenses applied to the workload."}]}},"description":"A metric that contributes to the consolidated report."},"ConsolidatedReportMetrics":{"type":"array","items":{"$ref":"#/components/schemas/ConsolidatedReportMetric"}},"Count":{"type":"integer","description":"A non-negative integer that denotes how many.","minimum":0},"SharedWith":{"type":"string","description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.","minLength":12,"maxLength":2048},"CreateLensShareInput":{"type":"object","required":["SharedWith","ClientRequestToken"],"title":"CreateLensShareInput","properties":{"SharedWith":{"$ref":"#/components/schemas/SharedWith"},"ClientRequestToken":{"$ref":"#/components/schemas/ClientRequestToken"}}},"ShareId":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID associated with the share."},"LensVersion":{"type":"string","minLength":1,"maxLength":32},"IsMajorVersion":{"type":"boolean"},"CreateLensVersionInput":{"type":"object","required":["LensVersion","ClientRequestToken"],"title":"CreateLensVersionInput","properties":{"LensVersion":{"allOf":[{"$ref":"#/components/schemas/LensVersion"},{"description":"The version of the lens being created."}]},"IsMajorVersion":{"allOf":[{"$ref":"#/components/schemas/IsMajorVersion"},{"description":"Set to true if this new major lens version."}]},"ClientRequestToken":{"$ref":"#/components/schemas/ClientRequestToken"}}},"MilestoneName":{"type":"string","description":"The name of the milestone in a workload.
Milestone names must be unique within a workload.
","minLength":3,"maxLength":100},"CreateMilestoneInput":{"type":"object","required":["MilestoneName","ClientRequestToken"],"title":"CreateMilestoneInput","properties":{"MilestoneName":{"$ref":"#/components/schemas/MilestoneName"},"ClientRequestToken":{"$ref":"#/components/schemas/ClientRequestToken"}},"description":"Input for milestone creation."},"MilestoneNumber":{"type":"integer","description":"The milestone number.
A workload can have a maximum of 100 milestones.
","minimum":1,"maximum":100},"ProfileName":{"type":"string","pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$","minLength":3,"maxLength":100},"ProfileDescription":{"type":"string","pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$","minLength":3,"maxLength":100},"ProfileQuestionUpdates":{"type":"array","items":{"$ref":"#/components/schemas/ProfileQuestionUpdate"}},"TagMap":{"type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"CreateProfileInput":{"type":"object","required":["ProfileName","ProfileDescription","ProfileQuestions","ClientRequestToken"],"title":"CreateProfileInput","properties":{"ProfileName":{"allOf":[{"$ref":"#/components/schemas/ProfileName"},{"description":"Name of the profile."}]},"ProfileDescription":{"allOf":[{"$ref":"#/components/schemas/ProfileDescription"},{"description":"The profile description."}]},"ProfileQuestions":{"allOf":[{"$ref":"#/components/schemas/ProfileQuestionUpdates"},{"description":"The profile questions."}]},"ClientRequestToken":{"$ref":"#/components/schemas/ClientRequestToken"},"Tags":{"allOf":[{"$ref":"#/components/schemas/TagMap"},{"description":"The tags assigned to the profile."}]}}},"ProfileVersion":{"type":"string","pattern":"^[A-Za-z0-9-]+$","minLength":1,"maxLength":32},"CreateProfileShareInput":{"type":"object","required":["SharedWith","ClientRequestToken"],"title":"CreateProfileShareInput","properties":{"SharedWith":{"$ref":"#/components/schemas/SharedWith"},"ClientRequestToken":{"$ref":"#/components/schemas/ClientRequestToken"}}},"WorkloadDescription":{"type":"string","description":"The description for the workload.","minLength":3,"maxLength":250},"WorkloadEnvironment":{"type":"string","enum":["PRODUCTION","PREPRODUCTION"],"description":"The environment for the workload."},"WorkloadAccountIds":{"type":"array","description":"The list of Amazon Web Services account IDs associated with the workload.","items":{"$ref":"#/components/schemas/AwsAccountId"},"maxItems":100},"WorkloadAwsRegions":{"type":"array","description":"The list of Amazon Web Services Regions associated with the workload, for example,us-east-2, or ca-central-1.","items":{"$ref":"#/components/schemas/AwsRegion"},"maxItems":50},"WorkloadNonAwsRegions":{"type":"array","description":" The list of non-Amazon Web Services Regions associated with the workload.","items":{"$ref":"#/components/schemas/WorkloadNonAwsRegion"},"maxItems":5},"WorkloadPillarPriorities":{"type":"array","description":"The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.","items":{"$ref":"#/components/schemas/PillarId"}},"WorkloadArchitecturalDesign":{"type":"string","pattern":"^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$","description":"The URL of the architectural design for the workload.","maxLength":2048},"WorkloadReviewOwner":{"type":"string","description":"The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.","minLength":3,"maxLength":255},"WorkloadIndustryType":{"type":"string","description":"The industry type for the workload.
If specified, must be one of the following:
Agriculture
Automobile
Defense
Design and Engineering
Digital Advertising
Education
Environmental Protection
Financial Services
Gaming
General Public Services
Healthcare
Hospitality
InfoTech
Justice and Public Safety
Life Sciences
Manufacturing
Media & Entertainment
Mining & Resources
Oil & Gas
Power & Utilities
Professional Services
Real Estate & Construction
Retail & Wholesale
Social Protection
Telecommunications
Travel, Transportation & Logistics
Other
The mode to use for identifying resources associated with the workload.
You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.
Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
"}]},"IndustryType":{"$ref":"#/components/schemas/WorkloadIndustryType"},"Industry":{"$ref":"#/components/schemas/WorkloadIndustry"},"Notes":{"$ref":"#/components/schemas/Notes"},"ImprovementStatus":{"$ref":"#/components/schemas/WorkloadImprovementStatus"},"RiskCounts":{"$ref":"#/components/schemas/RiskCounts"},"PillarPriorities":{"$ref":"#/components/schemas/WorkloadPillarPriorities"},"Lenses":{"$ref":"#/components/schemas/WorkloadLenses"},"Owner":{"$ref":"#/components/schemas/AwsAccountId"},"ShareInvitationId":{"allOf":[{"$ref":"#/components/schemas/ShareInvitationId"},{"description":"The ID assigned to the share invitation."}]},"Tags":{"allOf":[{"$ref":"#/components/schemas/TagMap"},{"description":"The tags associated with the workload."}]},"DiscoveryConfig":{"allOf":[{"$ref":"#/components/schemas/WorkloadDiscoveryConfig"},{"description":"Discovery configuration associated to the workload."}]},"Applications":{"allOf":[{"$ref":"#/components/schemas/WorkloadApplications"},{"description":"List of AppRegistry application ARNs associated to the workload."}]},"Profiles":{"allOf":[{"$ref":"#/components/schemas/WorkloadProfiles"},{"description":"Profile associated with a workload."}]},"PrioritizedRiskCounts":{"$ref":"#/components/schemas/RiskCounts"}},"description":"A workload return object."},"ImportLensInput":{"type":"object","required":["JSONString","ClientRequestToken"],"title":"ImportLensInput","properties":{"LensAlias":{"$ref":"#/components/schemas/LensAlias"},"JSONString":{"allOf":[{"$ref":"#/components/schemas/LensJSON"},{"description":"The JSON representation of a lens."}]},"ClientRequestToken":{"$ref":"#/components/schemas/ClientRequestToken"},"Tags":{"allOf":[{"$ref":"#/components/schemas/TagMap"},{"description":"Tags to associate to a lens."}]}}},"ImportLensStatus":{"type":"string","enum":["IN_PROGRESS","COMPLETE","ERROR"]},"ImprovementSummary":{"type":"object","properties":{"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"PillarId":{"$ref":"#/components/schemas/PillarId"},"QuestionTitle":{"$ref":"#/components/schemas/QuestionTitle"},"Risk":{"$ref":"#/components/schemas/Risk"},"ImprovementPlanUrl":{"$ref":"#/components/schemas/ImprovementPlanUrl"},"ImprovementPlans":{"allOf":[{"$ref":"#/components/schemas/ChoiceImprovementPlans"},{"description":"The improvement plan details."}]}},"description":"An improvement summary of a lens review in a workload."},"ImprovementSummaries":{"type":"array","description":"List of improvement summaries of lens review in a workload.","items":{"$ref":"#/components/schemas/ImprovementSummary"}},"IsReviewOwnerUpdateAcknowledged":{"type":"boolean"},"LensName":{"type":"string","description":"The full name of the lens.","minLength":1,"maxLength":128},"LensDescription":{"type":"string","description":"The description of the lens.","minLength":1,"maxLength":1024},"LensOwner":{"type":"string"},"ShareInvitationId":{"type":"string","pattern":"[0-9a-f]{32}"},"PillarMetrics":{"type":"array","items":{"$ref":"#/components/schemas/PillarMetric"}},"LensMetric":{"type":"object","properties":{"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"The lens ARN."}]},"Pillars":{"allOf":[{"$ref":"#/components/schemas/PillarMetrics"},{"description":"The metrics for the pillars in a lens."}]},"RiskCounts":{"$ref":"#/components/schemas/RiskCounts"}},"description":"A metric for a particular lens in a workload."},"LensNamePrefix":{"type":"string","maxLength":100},"LensStatus":{"type":"string","enum":["CURRENT","NOT_CURRENT","DEPRECATED","DELETED","UNSHARED"]},"PillarReviewSummaries":{"type":"array","description":"List of pillar review summaries of lens review in a workload.","items":{"$ref":"#/components/schemas/PillarReviewSummary"}},"WorkloadProfiles":{"type":"array","items":{"$ref":"#/components/schemas/WorkloadProfile"},"maxItems":1},"LensReviewSummary":{"type":"object","properties":{"LensAlias":{"$ref":"#/components/schemas/LensAlias"},"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"The ARN for the lens."}]},"LensVersion":{"allOf":[{"$ref":"#/components/schemas/LensVersion"},{"description":"The version of the lens."}]},"LensName":{"$ref":"#/components/schemas/LensName"},"LensStatus":{"allOf":[{"$ref":"#/components/schemas/LensStatus"},{"description":"The status of the lens."}]},"UpdatedAt":{"$ref":"#/components/schemas/Timestamp"},"RiskCounts":{"$ref":"#/components/schemas/RiskCounts"},"Profiles":{"allOf":[{"$ref":"#/components/schemas/WorkloadProfiles"},{"description":"The profiles associated with the workload."}]},"PrioritizedRiskCounts":{"$ref":"#/components/schemas/RiskCounts"}},"description":"A lens review summary of a workload."},"LensReviewSummaries":{"type":"array","description":"List of lens summaries of lens reviews of a workload.","items":{"$ref":"#/components/schemas/LensReviewSummary"}},"LensShareSummary":{"type":"object","properties":{"ShareId":{"$ref":"#/components/schemas/ShareId"},"SharedWith":{"$ref":"#/components/schemas/SharedWith"},"Status":{"$ref":"#/components/schemas/ShareStatus"},"StatusMessage":{"allOf":[{"$ref":"#/components/schemas/StatusMessage"},{"description":"Optional message to compliment the Status field."}]}},"description":"A lens share summary return object."},"LensShareSummaries":{"type":"array","items":{"$ref":"#/components/schemas/LensShareSummary"}},"ShareStatus":{"type":"string","enum":["ACCEPTED","REJECTED","PENDING","REVOKED","EXPIRED","ASSOCIATING","ASSOCIATED","FAILED"],"description":"The status of the share request."},"StatusMessage":{"type":"string","minLength":1,"maxLength":512},"LensSummary":{"type":"object","properties":{"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"The ARN of the lens."}]},"LensAlias":{"$ref":"#/components/schemas/LensAlias"},"LensName":{"$ref":"#/components/schemas/LensName"},"LensType":{"allOf":[{"$ref":"#/components/schemas/LensType"},{"description":"The type of the lens."}]},"Description":{"$ref":"#/components/schemas/LensDescription"},"CreatedAt":{"$ref":"#/components/schemas/Timestamp"},"UpdatedAt":{"$ref":"#/components/schemas/Timestamp"},"LensVersion":{"allOf":[{"$ref":"#/components/schemas/LensVersion"},{"description":"The version of the lens."}]},"Owner":{"$ref":"#/components/schemas/AwsAccountId"},"LensStatus":{"allOf":[{"$ref":"#/components/schemas/LensStatus"},{"description":"The status of the lens."}]}},"description":"A lens summary of a lens."},"LensSummaries":{"type":"array","description":"List of lens summaries of available lenses.","items":{"$ref":"#/components/schemas/LensSummary"}},"LensType":{"type":"string","enum":["AWS_OFFICIAL","CUSTOM_SHARED","CUSTOM_SELF"]},"LensUpgradeSummary":{"type":"object","properties":{"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"WorkloadName":{"$ref":"#/components/schemas/WorkloadName"},"LensAlias":{"$ref":"#/components/schemas/LensAlias"},"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"The ARN for the lens."}]},"CurrentLensVersion":{"allOf":[{"$ref":"#/components/schemas/LensVersion"},{"description":"The current version of the lens."}]},"LatestLensVersion":{"allOf":[{"$ref":"#/components/schemas/LensVersion"},{"description":"The latest version of the lens."}]}},"description":"Lens upgrade summary return object."},"ListAnswersMaxResults":{"type":"integer","minimum":1,"maximum":50},"QuestionPriority":{"type":"string","enum":["PRIORITIZED","NONE"]},"ListAnswersInput":{"type":"object","title":"ListAnswersInput","properties":{},"description":"Input to list answers."},"MaxResults":{"type":"integer","description":"The maximum number of results to return for this request.","minimum":1,"maximum":50},"ListCheckDetailsInput":{"type":"object","required":["LensArn","PillarId","QuestionId","ChoiceId"],"title":"ListCheckDetailsInput","properties":{"NextToken":{"$ref":"#/components/schemas/NextToken"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"Well-Architected Lens ARN."}]},"PillarId":{"$ref":"#/components/schemas/PillarId"},"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"ChoiceId":{"$ref":"#/components/schemas/ChoiceId"}}},"ListCheckSummariesInput":{"type":"object","required":["LensArn","PillarId","QuestionId","ChoiceId"],"title":"ListCheckSummariesInput","properties":{"NextToken":{"$ref":"#/components/schemas/NextToken"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"},"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"Well-Architected Lens ARN."}]},"PillarId":{"$ref":"#/components/schemas/PillarId"},"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"ChoiceId":{"$ref":"#/components/schemas/ChoiceId"}}},"ListLensReviewImprovementsMaxResults":{"type":"integer","minimum":1,"maximum":100},"ListLensReviewImprovementsInput":{"type":"object","title":"ListLensReviewImprovementsInput","properties":{},"description":"Input to list lens review improvements."},"ListLensReviewsInput":{"type":"object","title":"ListLensReviewsInput","properties":{},"description":"Input to list lens reviews."},"SharedWithPrefix":{"type":"string","maxLength":100},"ListWorkloadSharesMaxResults":{"type":"integer","minimum":1,"maximum":50},"ListLensSharesInput":{"type":"object","title":"ListLensSharesInput","properties":{}},"ListLensesInput":{"type":"object","title":"ListLensesInput","properties":{},"description":"Input to list lenses."},"ListMilestonesInput":{"type":"object","title":"ListMilestonesInput","properties":{"NextToken":{"$ref":"#/components/schemas/NextToken"},"MaxResults":{"$ref":"#/components/schemas/MaxResults"}},"description":"Input to list all milestones for a workload."},"MilestoneSummaries":{"type":"array","description":"A list of milestone summaries.","items":{"$ref":"#/components/schemas/MilestoneSummary"}},"ListNotificationsMaxResults":{"type":"integer","minimum":1,"maximum":50},"ListNotificationsInput":{"type":"object","title":"ListNotificationsInput","properties":{"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"NextToken":{"$ref":"#/components/schemas/NextToken"},"MaxResults":{"allOf":[{"$ref":"#/components/schemas/ListNotificationsMaxResults"},{"description":"The maximum number of results to return for this request."}]}}},"NotificationSummaries":{"type":"array","items":{"$ref":"#/components/schemas/NotificationSummary"}},"ListProfileNotificationsInput":{"type":"object","title":"ListProfileNotificationsInput","properties":{}},"ProfileNotificationSummaries":{"type":"array","items":{"$ref":"#/components/schemas/ProfileNotificationSummary"}},"ListProfileSharesMaxResults":{"type":"integer","minimum":1,"maximum":50},"ListProfileSharesInput":{"type":"object","title":"ListProfileSharesInput","properties":{}},"ProfileShareSummaries":{"type":"array","items":{"$ref":"#/components/schemas/ProfileShareSummary"}},"ProfileNamePrefix":{"type":"string","pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$","maxLength":100},"ProfileOwnerType":{"type":"string","enum":["SELF","SHARED"]},"ListProfilesInput":{"type":"object","title":"ListProfilesInput","properties":{}},"ProfileSummaries":{"type":"array","items":{"$ref":"#/components/schemas/ProfileSummary"}},"WorkloadNamePrefix":{"type":"string","description":"An optional string added to the beginning of each workload name returned in the results.","maxLength":100},"ShareResourceType":{"type":"string","enum":["WORKLOAD","LENS","PROFILE"]},"ListShareInvitationsMaxResults":{"type":"integer","minimum":1,"maximum":50},"ListShareInvitationsInput":{"type":"object","title":"ListShareInvitationsInput","properties":{},"description":"Input for List Share Invitations"},"ShareInvitationSummaries":{"type":"array","items":{"$ref":"#/components/schemas/ShareInvitationSummary"}},"ListTagsForResourceInput":{"type":"object","title":"ListTagsForResourceInput","properties":{}},"ListWorkloadSharesInput":{"type":"object","title":"ListWorkloadSharesInput","properties":{},"description":"Input for List Workload Share"},"WorkloadShareSummaries":{"type":"array","description":"A list of workload share summaries.","items":{"$ref":"#/components/schemas/WorkloadShareSummary"}},"ListWorkloadsMaxResults":{"type":"integer","minimum":1,"maximum":50},"ListWorkloadsInput":{"type":"object","title":"ListWorkloadsInput","properties":{"WorkloadNamePrefix":{"$ref":"#/components/schemas/WorkloadNamePrefix"},"NextToken":{"$ref":"#/components/schemas/NextToken"},"MaxResults":{"allOf":[{"$ref":"#/components/schemas/ListWorkloadsMaxResults"},{"description":"The maximum number of results to return for this request."}]}},"description":"Input to list all workloads."},"WorkloadSummaries":{"type":"array","description":"A list of workload summaries.","items":{"$ref":"#/components/schemas/WorkloadSummary"}},"MaxSelectedProfileChoices":{"type":"integer","minimum":0},"MilestoneSummary":{"type":"object","properties":{"MilestoneNumber":{"$ref":"#/components/schemas/MilestoneNumber"},"MilestoneName":{"$ref":"#/components/schemas/MilestoneName"},"RecordedAt":{"$ref":"#/components/schemas/Timestamp"},"WorkloadSummary":{"$ref":"#/components/schemas/WorkloadSummary"}},"description":"A milestone summary return object."},"WorkloadSummary":{"type":"object","properties":{"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"WorkloadArn":{"$ref":"#/components/schemas/WorkloadArn"},"WorkloadName":{"$ref":"#/components/schemas/WorkloadName"},"Owner":{"$ref":"#/components/schemas/AwsAccountId"},"UpdatedAt":{"$ref":"#/components/schemas/Timestamp"},"Lenses":{"$ref":"#/components/schemas/WorkloadLenses"},"RiskCounts":{"$ref":"#/components/schemas/RiskCounts"},"ImprovementStatus":{"$ref":"#/components/schemas/WorkloadImprovementStatus"},"Profiles":{"allOf":[{"$ref":"#/components/schemas/WorkloadProfiles"},{"description":"Profile associated with a workload."}]},"PrioritizedRiskCounts":{"$ref":"#/components/schemas/RiskCounts"}},"description":"A workload summary return object."},"MinSelectedProfileChoices":{"type":"integer","minimum":0},"NotificationSummary":{"type":"object","properties":{"Type":{"allOf":[{"$ref":"#/components/schemas/NotificationType"},{"description":"The type of notification."}]},"LensUpgradeSummary":{"allOf":[{"$ref":"#/components/schemas/LensUpgradeSummary"},{"description":"Summary of lens upgrade."}]}},"description":"A notification summary return object."},"NotificationType":{"type":"string","enum":["LENS_VERSION_UPGRADED","LENS_VERSION_DEPRECATED"]},"OrganizationSharingStatus":{"type":"string","enum":["ENABLED","DISABLED"]},"PillarName":{"type":"string","description":"The name of the pillar.","minLength":1,"maxLength":128},"QuestionDifferences":{"type":"array","items":{"$ref":"#/components/schemas/QuestionDifference"}},"PillarDifference":{"type":"object","properties":{"PillarId":{"$ref":"#/components/schemas/PillarId"},"PillarName":{"$ref":"#/components/schemas/PillarName"},"DifferenceStatus":{"allOf":[{"$ref":"#/components/schemas/DifferenceStatus"},{"description":"Indicates the type of change to the pillar."}]},"QuestionDifferences":{"allOf":[{"$ref":"#/components/schemas/QuestionDifferences"},{"description":"List of question differences."}]}},"description":"A pillar difference return object."},"PillarDifferences":{"type":"array","items":{"$ref":"#/components/schemas/PillarDifference"}},"QuestionMetrics":{"type":"array","items":{"$ref":"#/components/schemas/QuestionMetric"}},"PillarMetric":{"type":"object","properties":{"PillarId":{"$ref":"#/components/schemas/PillarId"},"RiskCounts":{"$ref":"#/components/schemas/RiskCounts"},"Questions":{"allOf":[{"$ref":"#/components/schemas/QuestionMetrics"},{"description":"The questions that have been identified as risks in the pillar."}]}},"description":"A metric for a particular pillar in a lens."},"PillarNotes":{"type":"object","description":"List of pillar notes of a lens review in a workload.","additionalProperties":{"$ref":"#/components/schemas/Notes"}},"PillarReviewSummary":{"type":"object","properties":{"PillarId":{"$ref":"#/components/schemas/PillarId"},"PillarName":{"$ref":"#/components/schemas/PillarName"},"Notes":{"$ref":"#/components/schemas/Notes"},"RiskCounts":{"$ref":"#/components/schemas/RiskCounts"},"PrioritizedRiskCounts":{"$ref":"#/components/schemas/RiskCounts"}},"description":"A pillar review summary of a lens review."},"ProfileQuestions":{"type":"array","items":{"$ref":"#/components/schemas/ProfileQuestion"}},"ProfileChoice":{"type":"object","properties":{"ChoiceId":{"$ref":"#/components/schemas/ChoiceId"},"ChoiceTitle":{"$ref":"#/components/schemas/ChoiceTitle"},"ChoiceDescription":{"$ref":"#/components/schemas/ChoiceDescription"}},"description":"The profile choice."},"ProfileNotificationSummary":{"type":"object","properties":{"CurrentProfileVersion":{"allOf":[{"$ref":"#/components/schemas/ProfileVersion"},{"description":"The current profile version."}]},"LatestProfileVersion":{"allOf":[{"$ref":"#/components/schemas/ProfileVersion"},{"description":"The latest profile version."}]},"Type":{"allOf":[{"$ref":"#/components/schemas/ProfileNotificationType"},{"description":"Type of notification."}]},"ProfileArn":{"allOf":[{"$ref":"#/components/schemas/ProfileArn"},{"description":"The profile ARN."}]},"ProfileName":{"allOf":[{"$ref":"#/components/schemas/ProfileName"},{"description":"The profile name."}]},"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"WorkloadName":{"$ref":"#/components/schemas/WorkloadName"}},"description":"The profile notification summary."},"ProfileNotificationType":{"type":"string","enum":["PROFILE_ANSWERS_UPDATED","PROFILE_DELETED"]},"ProfileQuestionChoices":{"type":"array","items":{"$ref":"#/components/schemas/ProfileChoice"}},"SelectedChoiceIds":{"type":"array","items":{"$ref":"#/components/schemas/ChoiceId"}},"ProfileQuestion":{"type":"object","properties":{"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"QuestionTitle":{"$ref":"#/components/schemas/QuestionTitle"},"QuestionDescription":{"$ref":"#/components/schemas/QuestionDescription"},"QuestionChoices":{"allOf":[{"$ref":"#/components/schemas/ProfileQuestionChoices"},{"description":"The question choices."}]},"SelectedChoiceIds":{"allOf":[{"$ref":"#/components/schemas/SelectedChoiceIds"},{"description":"The selected choices."}]},"MinSelectedChoices":{"allOf":[{"$ref":"#/components/schemas/MinSelectedProfileChoices"},{"description":"The minimum number of selected choices."}]},"MaxSelectedChoices":{"allOf":[{"$ref":"#/components/schemas/MaxSelectedProfileChoices"},{"description":"The maximum number of selected choices."}]}},"description":"A profile question."},"SelectedProfileChoiceIds":{"type":"array","items":{"$ref":"#/components/schemas/ChoiceId"}},"ProfileShareSummary":{"type":"object","properties":{"ShareId":{"$ref":"#/components/schemas/ShareId"},"SharedWith":{"$ref":"#/components/schemas/SharedWith"},"Status":{"$ref":"#/components/schemas/ShareStatus"},"StatusMessage":{"allOf":[{"$ref":"#/components/schemas/StatusMessage"},{"description":"Profile share invitation status message."}]}},"description":"Summary of a profile share."},"ProfileSummary":{"type":"object","properties":{"ProfileArn":{"allOf":[{"$ref":"#/components/schemas/ProfileArn"},{"description":"The profile ARN."}]},"ProfileVersion":{"allOf":[{"$ref":"#/components/schemas/ProfileVersion"},{"description":"The profile version."}]},"ProfileName":{"allOf":[{"$ref":"#/components/schemas/ProfileName"},{"description":"The profile name."}]},"ProfileDescription":{"allOf":[{"$ref":"#/components/schemas/ProfileDescription"},{"description":"The profile description."}]},"Owner":{"$ref":"#/components/schemas/AwsAccountId"},"CreatedAt":{"$ref":"#/components/schemas/Timestamp"},"UpdatedAt":{"$ref":"#/components/schemas/Timestamp"}},"description":"Summary of a profile."},"TemplateQuestions":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTemplateQuestion"}},"ProfileTemplateChoice":{"type":"object","properties":{"ChoiceId":{"$ref":"#/components/schemas/ChoiceId"},"ChoiceTitle":{"$ref":"#/components/schemas/ChoiceTitle"},"ChoiceDescription":{"$ref":"#/components/schemas/ChoiceDescription"}},"description":"A profile template choice."},"ProfileTemplateQuestionChoices":{"type":"array","items":{"$ref":"#/components/schemas/ProfileTemplateChoice"}},"ProfileTemplateQuestion":{"type":"object","properties":{"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"QuestionTitle":{"$ref":"#/components/schemas/QuestionTitle"},"QuestionDescription":{"$ref":"#/components/schemas/QuestionDescription"},"QuestionChoices":{"allOf":[{"$ref":"#/components/schemas/ProfileTemplateQuestionChoices"},{"description":"The question choices."}]},"MinSelectedChoices":{"allOf":[{"$ref":"#/components/schemas/MinSelectedProfileChoices"},{"description":"The minimum number of choices selected."}]},"MaxSelectedChoices":{"allOf":[{"$ref":"#/components/schemas/MaxSelectedProfileChoices"},{"description":"The maximum number of choices selected."}]}},"description":"A profile template question."},"QuestionDifference":{"type":"object","properties":{"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"QuestionTitle":{"$ref":"#/components/schemas/QuestionTitle"},"DifferenceStatus":{"allOf":[{"$ref":"#/components/schemas/DifferenceStatus"},{"description":"Indicates the type of change to the question."}]}},"description":"A question difference return object."},"QuestionMetric":{"type":"object","properties":{"QuestionId":{"$ref":"#/components/schemas/QuestionId"},"Risk":{"$ref":"#/components/schemas/Risk"},"BestPractices":{"allOf":[{"$ref":"#/components/schemas/BestPractices"},{"description":"The best practices, or choices, that have been identified as contributing to risk in a question."}]}},"description":"A metric for a particular question in the pillar. "},"ShareInvitation":{"type":"object","properties":{"ShareInvitationId":{"allOf":[{"$ref":"#/components/schemas/ShareInvitationId"},{"description":"The ID assigned to the share invitation."}]},"ShareResourceType":{"allOf":[{"$ref":"#/components/schemas/ShareResourceType"},{"description":"The resource type of the share invitation."}]},"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"LensAlias":{"$ref":"#/components/schemas/LensAlias"},"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"The ARN for the lens."}]},"ProfileArn":{"allOf":[{"$ref":"#/components/schemas/ProfileArn"},{"description":"The profile ARN."}]}},"description":"The share invitation."},"ShareInvitationAction":{"type":"string","enum":["ACCEPT","REJECT"],"description":"Share invitation action taken by contributor."},"ShareInvitationSummary":{"type":"object","properties":{"ShareInvitationId":{"allOf":[{"$ref":"#/components/schemas/ShareInvitationId"},{"description":"The ID assigned to the share invitation."}]},"SharedBy":{"$ref":"#/components/schemas/AwsAccountId"},"SharedWith":{"$ref":"#/components/schemas/SharedWith"},"PermissionType":{"$ref":"#/components/schemas/PermissionType"},"ShareResourceType":{"allOf":[{"$ref":"#/components/schemas/ShareResourceType"},{"description":"The resource type of the share invitation."}]},"WorkloadName":{"$ref":"#/components/schemas/WorkloadName"},"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"},"LensName":{"$ref":"#/components/schemas/LensName"},"LensArn":{"allOf":[{"$ref":"#/components/schemas/LensArn"},{"description":"The ARN for the lens."}]},"ProfileName":{"allOf":[{"$ref":"#/components/schemas/ProfileName"},{"description":"The profile name."}]},"ProfileArn":{"allOf":[{"$ref":"#/components/schemas/ProfileArn"},{"description":"The profile ARN."}]}},"description":"A share invitation summary return object."},"TagKeyList":{"type":"array","items":{"$ref":"#/components/schemas/TagKey"},"minItems":1,"maxItems":50},"TagResourceInput":{"type":"object","required":["Tags"],"title":"TagResourceInput","properties":{"Tags":{"allOf":[{"$ref":"#/components/schemas/TagMap"},{"description":"The tags for the resource."}]}}},"UntagResourceInput":{"type":"object","title":"UntagResourceInput","properties":{}},"UpdateAnswerInput":{"type":"object","title":"UpdateAnswerInput","properties":{"SelectedChoices":{"$ref":"#/components/schemas/SelectedChoices"},"ChoiceUpdates":{"allOf":[{"$ref":"#/components/schemas/ChoiceUpdates"},{"description":"A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated."}]},"Notes":{"$ref":"#/components/schemas/Notes"},"IsApplicable":{"$ref":"#/components/schemas/IsApplicable"},"Reason":{"allOf":[{"$ref":"#/components/schemas/AnswerReason"},{"description":"The reason why a question is not applicable to your workload."}]}},"description":"Input to update answer."},"UpdateGlobalSettingsInput":{"type":"object","title":"UpdateGlobalSettingsInput","properties":{"OrganizationSharingStatus":{"allOf":[{"$ref":"#/components/schemas/OrganizationSharingStatus"},{"description":"The status of organization sharing settings."}]},"DiscoveryIntegrationStatus":{"allOf":[{"$ref":"#/components/schemas/DiscoveryIntegrationStatus"},{"description":"The status of discovery support settings."}]}}},"UpdateLensReviewInput":{"type":"object","title":"UpdateLensReviewInput","properties":{"LensNotes":{"$ref":"#/components/schemas/Notes"},"PillarNotes":{"$ref":"#/components/schemas/PillarNotes"}},"description":"Input for update lens review."},"UpdateProfileInput":{"type":"object","title":"UpdateProfileInput","properties":{"ProfileDescription":{"allOf":[{"$ref":"#/components/schemas/ProfileDescription"},{"description":"The profile description."}]},"ProfileQuestions":{"allOf":[{"$ref":"#/components/schemas/ProfileQuestionUpdates"},{"description":"Profile questions."}]}}},"UpdateShareInvitationInput":{"type":"object","required":["ShareInvitationAction"],"title":"UpdateShareInvitationInput","properties":{"ShareInvitationAction":{"$ref":"#/components/schemas/ShareInvitationAction"}},"description":"Input for Update Share Invitation"},"WorkloadImprovementStatus":{"type":"string","enum":["NOT_APPLICABLE","NOT_STARTED","IN_PROGRESS","COMPLETE","RISK_ACKNOWLEDGED"],"description":"The improvement status for a workload."},"UpdateWorkloadInput":{"type":"object","title":"UpdateWorkloadInput","properties":{"WorkloadName":{"$ref":"#/components/schemas/WorkloadName"},"Description":{"$ref":"#/components/schemas/WorkloadDescription"},"Environment":{"$ref":"#/components/schemas/WorkloadEnvironment"},"AccountIds":{"$ref":"#/components/schemas/WorkloadAccountIds"},"AwsRegions":{"$ref":"#/components/schemas/WorkloadAwsRegions"},"NonAwsRegions":{"$ref":"#/components/schemas/WorkloadNonAwsRegions"},"PillarPriorities":{"$ref":"#/components/schemas/WorkloadPillarPriorities"},"ArchitecturalDesign":{"$ref":"#/components/schemas/WorkloadArchitecturalDesign"},"ReviewOwner":{"$ref":"#/components/schemas/WorkloadReviewOwner"},"IsReviewOwnerUpdateAcknowledged":{"allOf":[{"$ref":"#/components/schemas/IsReviewOwnerUpdateAcknowledged"},{"description":"Flag indicating whether the workload owner has acknowledged that the Review owner field is required.
If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
"}]},"IndustryType":{"$ref":"#/components/schemas/WorkloadIndustryType"},"Industry":{"$ref":"#/components/schemas/WorkloadIndustry"},"Notes":{"$ref":"#/components/schemas/Notes"},"ImprovementStatus":{"$ref":"#/components/schemas/WorkloadImprovementStatus"},"DiscoveryConfig":{"allOf":[{"$ref":"#/components/schemas/WorkloadDiscoveryConfig"},{"description":"Well-Architected discovery configuration settings to associate to the workload."}]},"Applications":{"allOf":[{"$ref":"#/components/schemas/WorkloadApplications"},{"description":"List of AppRegistry application ARNs to associate to the workload."}]}},"description":"Input to update a workload."},"UpdateWorkloadShareInput":{"type":"object","required":["PermissionType"],"title":"UpdateWorkloadShareInput","properties":{"PermissionType":{"$ref":"#/components/schemas/PermissionType"}},"description":"Input for Update Workload Share"},"WorkloadShare":{"type":"object","properties":{"ShareId":{"$ref":"#/components/schemas/ShareId"},"SharedBy":{"$ref":"#/components/schemas/AwsAccountId"},"SharedWith":{"$ref":"#/components/schemas/SharedWith"},"PermissionType":{"$ref":"#/components/schemas/PermissionType"},"Status":{"$ref":"#/components/schemas/ShareStatus"},"WorkloadName":{"$ref":"#/components/schemas/WorkloadName"},"WorkloadId":{"$ref":"#/components/schemas/WorkloadId"}},"description":"A workload share return object."},"UpgradeLensReviewInput":{"type":"object","required":["MilestoneName"],"title":"UpgradeLensReviewInput","properties":{"MilestoneName":{"$ref":"#/components/schemas/MilestoneName"},"ClientRequestToken":{"$ref":"#/components/schemas/ClientRequestToken"}}},"UpgradeProfileVersionInput":{"type":"object","title":"UpgradeProfileVersionInput","properties":{"MilestoneName":{"$ref":"#/components/schemas/MilestoneName"},"ClientRequestToken":{"$ref":"#/components/schemas/ClientRequestToken"}}},"WorkloadProfile":{"type":"object","properties":{"ProfileArn":{"allOf":[{"$ref":"#/components/schemas/ProfileArn"},{"description":"The profile ARN."}]},"ProfileVersion":{"allOf":[{"$ref":"#/components/schemas/ProfileVersion"},{"description":"The profile version."}]}},"description":"The profile associated with a workload."},"WorkloadShareSummary":{"type":"object","properties":{"ShareId":{"$ref":"#/components/schemas/ShareId"},"SharedWith":{"$ref":"#/components/schemas/SharedWith"},"PermissionType":{"$ref":"#/components/schemas/PermissionType"},"Status":{"$ref":"#/components/schemas/ShareStatus"},"StatusMessage":{"allOf":[{"$ref":"#/components/schemas/StatusMessage"},{"description":"Optional message to compliment the Status field."}]}},"description":"A workload share summary return object."}}},"security":[{"hmac":[]}]}