{ "version":"2.0", "metadata":{ "apiVersion":"2020-03-31", "endpointPrefix":"wellarchitected", "jsonVersion":"1.1", "protocol":"rest-json", "serviceAbbreviation":"Well-Architected", "serviceFullName":"AWS Well-Architected Tool", "serviceId":"WellArchitected", "signatureVersion":"v4", "signingName":"wellarchitected", "uid":"wellarchitected-2020-03-31" }, "operations":{ "AssociateLenses":{ "name":"AssociateLenses", "http":{ "method":"PATCH", "requestUri":"/workloads/{WorkloadId}/associateLenses" }, "input":{"shape":"AssociateLensesInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "AssociateProfiles":{ "name":"AssociateProfiles", "http":{ "method":"PATCH", "requestUri":"/workloads/{WorkloadId}/associateProfiles" }, "input":{"shape":"AssociateProfilesInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Associate a profile with a workload.

" }, "CreateLensShare":{ "name":"CreateLensShare", "http":{ "method":"POST", "requestUri":"/lenses/{LensAlias}/shares" }, "input":{"shape":"CreateLensShareInput"}, "output":{"shape":"CreateLensShareOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "CreateLensVersion":{ "name":"CreateLensVersion", "http":{ "method":"POST", "requestUri":"/lenses/{LensAlias}/versions" }, "input":{"shape":"CreateLensVersionInput"}, "output":{"shape":"CreateLensVersionOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "CreateMilestone":{ "name":"CreateMilestone", "http":{ "method":"POST", "requestUri":"/workloads/{WorkloadId}/milestones" }, "input":{"shape":"CreateMilestoneInput"}, "output":{"shape":"CreateMilestoneOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Create a milestone for an existing workload.

" }, "CreateProfile":{ "name":"CreateProfile", "http":{ "method":"POST", "requestUri":"/profiles" }, "input":{"shape":"CreateProfileInput"}, "output":{"shape":"CreateProfileOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Create a profile.

" }, "CreateProfileShare":{ "name":"CreateProfileShare", "http":{ "method":"POST", "requestUri":"/profiles/{ProfileArn}/shares" }, "input":{"shape":"CreateProfileShareInput"}, "output":{"shape":"CreateProfileShareOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Create a profile share.

" }, "CreateReviewTemplate":{ "name":"CreateReviewTemplate", "http":{ "method":"POST", "requestUri":"/reviewTemplates" }, "input":{"shape":"CreateReviewTemplateInput"}, "output":{"shape":"CreateReviewTemplateOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

Create a review template.

Disclaimer

Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template 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.

" }, "CreateTemplateShare":{ "name":"CreateTemplateShare", "http":{ "method":"POST", "requestUri":"/templates/shares/{TemplateArn}" }, "input":{"shape":"CreateTemplateShareInput"}, "output":{"shape":"CreateTemplateShareOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Create a review template share.

The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.

Shared access to a review template is not removed until the review template share invitation is deleted.

If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.

Disclaimer

By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.

" }, "CreateWorkload":{ "name":"CreateWorkload", "http":{ "method":"POST", "requestUri":"/workloads" }, "input":{"shape":"CreateWorkloadInput"}, "output":{"shape":"CreateWorkloadOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

When creating a workload using a review template, you must have the following IAM permissions:

- `wellarchitected:GetReviewTemplate`

- `wellarchitected:GetReviewTemplateAnswer`

- `wellarchitected:ListReviewTemplateAnswers`

- `wellarchitected:GetReviewTemplateLensReview`

" }, "CreateWorkloadShare":{ "name":"CreateWorkloadShare", "http":{ "method":"POST", "requestUri":"/workloads/{WorkloadId}/shares" }, "input":{"shape":"CreateWorkloadShareInput"}, "output":{"shape":"CreateWorkloadShareOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "DeleteLens":{ "name":"DeleteLens", "http":{ "method":"DELETE", "requestUri":"/lenses/{LensAlias}" }, "input":{"shape":"DeleteLensInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "DeleteLensShare":{ "name":"DeleteLensShare", "http":{ "method":"DELETE", "requestUri":"/lenses/{LensAlias}/shares/{ShareId}" }, "input":{"shape":"DeleteLensShareInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "DeleteProfile":{ "name":"DeleteProfile", "http":{ "method":"DELETE", "requestUri":"/profiles/{ProfileArn}" }, "input":{"shape":"DeleteProfileInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "DeleteProfileShare":{ "name":"DeleteProfileShare", "http":{ "method":"DELETE", "requestUri":"/profiles/{ProfileArn}/shares/{ShareId}" }, "input":{"shape":"DeleteProfileShareInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Delete a profile share.

" }, "DeleteReviewTemplate":{ "name":"DeleteReviewTemplate", "http":{ "method":"DELETE", "requestUri":"/reviewTemplates/{TemplateArn}" }, "input":{"shape":"DeleteReviewTemplateInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Delete a review template.

Only the owner of a review template can delete it.

After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

" }, "DeleteTemplateShare":{ "name":"DeleteTemplateShare", "http":{ "method":"DELETE", "requestUri":"/templates/shares/{TemplateArn}/{ShareId}" }, "input":{"shape":"DeleteTemplateShareInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Delete a review template share.

After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

" }, "DeleteWorkload":{ "name":"DeleteWorkload", "http":{ "method":"DELETE", "requestUri":"/workloads/{WorkloadId}" }, "input":{"shape":"DeleteWorkloadInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Delete an existing workload.

" }, "DeleteWorkloadShare":{ "name":"DeleteWorkloadShare", "http":{ "method":"DELETE", "requestUri":"/workloads/{WorkloadId}/shares/{ShareId}" }, "input":{"shape":"DeleteWorkloadShareInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Delete a workload share.

" }, "DisassociateLenses":{ "name":"DisassociateLenses", "http":{ "method":"PATCH", "requestUri":"/workloads/{WorkloadId}/disassociateLenses" }, "input":{"shape":"DisassociateLensesInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "DisassociateProfiles":{ "name":"DisassociateProfiles", "http":{ "method":"PATCH", "requestUri":"/workloads/{WorkloadId}/disassociateProfiles" }, "input":{"shape":"DisassociateProfilesInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Disassociate a profile from a workload.

" }, "ExportLens":{ "name":"ExportLens", "http":{ "method":"GET", "requestUri":"/lenses/{LensAlias}/export" }, "input":{"shape":"ExportLensInput"}, "output":{"shape":"ExportLensOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "GetAnswer":{ "name":"GetAnswer", "http":{ "method":"GET", "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}" }, "input":{"shape":"GetAnswerInput"}, "output":{"shape":"GetAnswerOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get the answer to a specific question in a workload review.

" }, "GetConsolidatedReport":{ "name":"GetConsolidatedReport", "http":{ "method":"GET", "requestUri":"/consolidatedReport" }, "input":{"shape":"GetConsolidatedReportInput"}, "output":{"shape":"GetConsolidatedReportOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"}, {"shape":"ConflictException"} ], "documentation":"

Get a consolidated report of your workloads.

You can optionally choose to include workloads that have been shared with you.

" }, "GetLens":{ "name":"GetLens", "http":{ "method":"GET", "requestUri":"/lenses/{LensAlias}" }, "input":{"shape":"GetLensInput"}, "output":{"shape":"GetLensOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get an existing lens.

" }, "GetLensReview":{ "name":"GetLensReview", "http":{ "method":"GET", "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}" }, "input":{"shape":"GetLensReviewInput"}, "output":{"shape":"GetLensReviewOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get lens review.

" }, "GetLensReviewReport":{ "name":"GetLensReviewReport", "http":{ "method":"GET", "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}/report" }, "input":{"shape":"GetLensReviewReportInput"}, "output":{"shape":"GetLensReviewReportOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get lens review report.

" }, "GetLensVersionDifference":{ "name":"GetLensVersionDifference", "http":{ "method":"GET", "requestUri":"/lenses/{LensAlias}/versionDifference" }, "input":{"shape":"GetLensVersionDifferenceInput"}, "output":{"shape":"GetLensVersionDifferenceOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get lens version differences.

" }, "GetMilestone":{ "name":"GetMilestone", "http":{ "method":"GET", "requestUri":"/workloads/{WorkloadId}/milestones/{MilestoneNumber}" }, "input":{"shape":"GetMilestoneInput"}, "output":{"shape":"GetMilestoneOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get a milestone for an existing workload.

" }, "GetProfile":{ "name":"GetProfile", "http":{ "method":"GET", "requestUri":"/profiles/{ProfileArn}" }, "input":{"shape":"GetProfileInput"}, "output":{"shape":"GetProfileOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get profile information.

" }, "GetProfileTemplate":{ "name":"GetProfileTemplate", "http":{ "method":"GET", "requestUri":"/profileTemplate" }, "input":{"shape":"GetProfileTemplateInput"}, "output":{"shape":"GetProfileTemplateOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get profile template.

" }, "GetReviewTemplate":{ "name":"GetReviewTemplate", "http":{ "method":"GET", "requestUri":"/reviewTemplates/{TemplateArn}" }, "input":{"shape":"GetReviewTemplateInput"}, "output":{"shape":"GetReviewTemplateOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get review template.

" }, "GetReviewTemplateAnswer":{ "name":"GetReviewTemplateAnswer", "http":{ "method":"GET", "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}" }, "input":{"shape":"GetReviewTemplateAnswerInput"}, "output":{"shape":"GetReviewTemplateAnswerOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get review template answer.

" }, "GetReviewTemplateLensReview":{ "name":"GetReviewTemplateLensReview", "http":{ "method":"GET", "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}" }, "input":{"shape":"GetReviewTemplateLensReviewInput"}, "output":{"shape":"GetReviewTemplateLensReviewOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get a lens review associated with a review template.

" }, "GetWorkload":{ "name":"GetWorkload", "http":{ "method":"GET", "requestUri":"/workloads/{WorkloadId}" }, "input":{"shape":"GetWorkloadInput"}, "output":{"shape":"GetWorkloadOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Get an existing workload.

" }, "ImportLens":{ "name":"ImportLens", "http":{ "method":"PUT", "requestUri":"/importLens" }, "input":{"shape":"ImportLensInput"}, "output":{"shape":"ImportLensOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "ListAnswers":{ "name":"ListAnswers", "http":{ "method":"GET", "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers" }, "input":{"shape":"ListAnswersInput"}, "output":{"shape":"ListAnswersOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List of answers for a particular workload and lens.

" }, "ListCheckDetails":{ "name":"ListCheckDetails", "http":{ "method":"POST", "requestUri":"/workloads/{WorkloadId}/checks" }, "input":{"shape":"ListCheckDetailsInput"}, "output":{"shape":"ListCheckDetailsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List of Trusted Advisor check details by account related to the workload.

" }, "ListCheckSummaries":{ "name":"ListCheckSummaries", "http":{ "method":"POST", "requestUri":"/workloads/{WorkloadId}/checkSummaries" }, "input":{"shape":"ListCheckSummariesInput"}, "output":{"shape":"ListCheckSummariesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List of Trusted Advisor checks summarized for all accounts related to the workload.

" }, "ListLensReviewImprovements":{ "name":"ListLensReviewImprovements", "http":{ "method":"GET", "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements" }, "input":{"shape":"ListLensReviewImprovementsInput"}, "output":{"shape":"ListLensReviewImprovementsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List lens review improvements.

" }, "ListLensReviews":{ "name":"ListLensReviews", "http":{ "method":"GET", "requestUri":"/workloads/{WorkloadId}/lensReviews" }, "input":{"shape":"ListLensReviewsInput"}, "output":{"shape":"ListLensReviewsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List lens reviews for a particular workload.

" }, "ListLensShares":{ "name":"ListLensShares", "http":{ "method":"GET", "requestUri":"/lenses/{LensAlias}/shares" }, "input":{"shape":"ListLensSharesInput"}, "output":{"shape":"ListLensSharesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List the lens shares associated with the lens.

" }, "ListLenses":{ "name":"ListLenses", "http":{ "method":"GET", "requestUri":"/lenses" }, "input":{"shape":"ListLensesInput"}, "output":{"shape":"ListLensesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List the available lenses.

" }, "ListMilestones":{ "name":"ListMilestones", "http":{ "method":"POST", "requestUri":"/workloads/{WorkloadId}/milestonesSummaries" }, "input":{"shape":"ListMilestonesInput"}, "output":{"shape":"ListMilestonesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List all milestones for an existing workload.

" }, "ListNotifications":{ "name":"ListNotifications", "http":{ "method":"POST", "requestUri":"/notifications" }, "input":{"shape":"ListNotificationsInput"}, "output":{"shape":"ListNotificationsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List lens notifications.

" }, "ListProfileNotifications":{ "name":"ListProfileNotifications", "http":{ "method":"GET", "requestUri":"/profileNotifications/" }, "input":{"shape":"ListProfileNotificationsInput"}, "output":{"shape":"ListProfileNotificationsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List profile notifications.

" }, "ListProfileShares":{ "name":"ListProfileShares", "http":{ "method":"GET", "requestUri":"/profiles/{ProfileArn}/shares" }, "input":{"shape":"ListProfileSharesInput"}, "output":{"shape":"ListProfileSharesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List profile shares.

" }, "ListProfiles":{ "name":"ListProfiles", "http":{ "method":"GET", "requestUri":"/profileSummaries" }, "input":{"shape":"ListProfilesInput"}, "output":{"shape":"ListProfilesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List profiles.

" }, "ListReviewTemplateAnswers":{ "name":"ListReviewTemplateAnswers", "http":{ "method":"GET", "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers" }, "input":{"shape":"ListReviewTemplateAnswersInput"}, "output":{"shape":"ListReviewTemplateAnswersOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List the answers of a review template.

" }, "ListReviewTemplates":{ "name":"ListReviewTemplates", "http":{ "method":"GET", "requestUri":"/reviewTemplates" }, "input":{"shape":"ListReviewTemplatesInput"}, "output":{"shape":"ListReviewTemplatesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List review templates.

" }, "ListShareInvitations":{ "name":"ListShareInvitations", "http":{ "method":"GET", "requestUri":"/shareInvitations" }, "input":{"shape":"ListShareInvitationsInput"}, "output":{"shape":"ListShareInvitationsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List the share invitations.

`WorkloadNamePrefix`, `LensNamePrefix`, `ProfileNamePrefix`, and `TemplateNamePrefix` are mutually exclusive. Use the parameter that matches your `ShareResourceType`.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ "method":"GET", "requestUri":"/tags/{WorkloadArn}" }, "input":{"shape":"ListTagsForResourceInput"}, "output":{"shape":"ListTagsForResourceOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

List the tags for a resource.

The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

" }, "ListTemplateShares":{ "name":"ListTemplateShares", "http":{ "method":"GET", "requestUri":"/templates/shares/{TemplateArn}" }, "input":{"shape":"ListTemplateSharesInput"}, "output":{"shape":"ListTemplateSharesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List review template shares.

" }, "ListWorkloadShares":{ "name":"ListWorkloadShares", "http":{ "method":"GET", "requestUri":"/workloads/{WorkloadId}/shares" }, "input":{"shape":"ListWorkloadSharesInput"}, "output":{"shape":"ListWorkloadSharesOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

List the workload shares associated with the workload.

" }, "ListWorkloads":{ "name":"ListWorkloads", "http":{ "method":"POST", "requestUri":"/workloadsSummaries" }, "input":{"shape":"ListWorkloadsInput"}, "output":{"shape":"ListWorkloadsOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Paginated list of workloads.

" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/tags/{WorkloadArn}" }, "input":{"shape":"TagResourceInput"}, "output":{"shape":"TagResourceOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Adds one or more tags to the specified resource.

The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"DELETE", "requestUri":"/tags/{WorkloadArn}" }, "input":{"shape":"UntagResourceInput"}, "output":{"shape":"UntagResourceOutput"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Deletes specified tags from a resource.

The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

To specify multiple tags, use separate tagKeys parameters, for example:

`DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2`

" }, "UpdateAnswer":{ "name":"UpdateAnswer", "http":{ "method":"PATCH", "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}" }, "input":{"shape":"UpdateAnswerInput"}, "output":{"shape":"UpdateAnswerOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Update the answer to a specific question in a workload review.

" }, "UpdateGlobalSettings":{ "name":"UpdateGlobalSettings", "http":{ "method":"PATCH", "requestUri":"/global-settings" }, "input":{"shape":"UpdateGlobalSettingsInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

" }, "UpdateLensReview":{ "name":"UpdateLensReview", "http":{ "method":"PATCH", "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}" }, "input":{"shape":"UpdateLensReviewInput"}, "output":{"shape":"UpdateLensReviewOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Update lens review for a particular workload.

" }, "UpdateProfile":{ "name":"UpdateProfile", "http":{ "method":"PATCH", "requestUri":"/profiles/{ProfileArn}" }, "input":{"shape":"UpdateProfileInput"}, "output":{"shape":"UpdateProfileOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Update a profile.

" }, "UpdateReviewTemplate":{ "name":"UpdateReviewTemplate", "http":{ "method":"PATCH", "requestUri":"/reviewTemplates/{TemplateArn}" }, "input":{"shape":"UpdateReviewTemplateInput"}, "output":{"shape":"UpdateReviewTemplateOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Update a review template.

" }, "UpdateReviewTemplateAnswer":{ "name":"UpdateReviewTemplateAnswer", "http":{ "method":"PATCH", "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}" }, "input":{"shape":"UpdateReviewTemplateAnswerInput"}, "output":{"shape":"UpdateReviewTemplateAnswerOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Update a review template answer.

" }, "UpdateReviewTemplateLensReview":{ "name":"UpdateReviewTemplateLensReview", "http":{ "method":"PATCH", "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}" }, "input":{"shape":"UpdateReviewTemplateLensReviewInput"}, "output":{"shape":"UpdateReviewTemplateLensReviewOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Update a lens review associated with a review template.

" }, "UpdateShareInvitation":{ "name":"UpdateShareInvitation", "http":{ "method":"PATCH", "requestUri":"/shareInvitations/{ShareInvitationId}" }, "input":{"shape":"UpdateShareInvitationInput"}, "output":{"shape":"UpdateShareInvitationOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

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.

" }, "UpdateWorkload":{ "name":"UpdateWorkload", "http":{ "method":"PATCH", "requestUri":"/workloads/{WorkloadId}" }, "input":{"shape":"UpdateWorkloadInput"}, "output":{"shape":"UpdateWorkloadOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Update an existing workload.

" }, "UpdateWorkloadShare":{ "name":"UpdateWorkloadShare", "http":{ "method":"PATCH", "requestUri":"/workloads/{WorkloadId}/shares/{ShareId}" }, "input":{"shape":"UpdateWorkloadShareInput"}, "output":{"shape":"UpdateWorkloadShareOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Update a workload share.

" }, "UpgradeLensReview":{ "name":"UpgradeLensReview", "http":{ "method":"PUT", "requestUri":"/workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade" }, "input":{"shape":"UpgradeLensReviewInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Upgrade lens review for a particular workload.

" }, "UpgradeProfileVersion":{ "name":"UpgradeProfileVersion", "http":{ "method":"PUT", "requestUri":"/workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade" }, "input":{"shape":"UpgradeProfileVersionInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Upgrade a profile.

" }, "UpgradeReviewTemplateLensReview":{ "name":"UpgradeReviewTemplateLensReview", "http":{ "method":"PUT", "requestUri":"/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/upgrade" }, "input":{"shape":"UpgradeReviewTemplateLensReviewInput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], "documentation":"

Upgrade the lens review of a review template.

" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

User does not have sufficient access to perform this action.

", "error":{"httpStatusCode":403}, "exception":true }, "AccountSummary":{ "type":"map", "key":{"shape":"CheckStatus"}, "value":{"shape":"CheckStatusCount"}, "documentation":"

Account summary for a Well-Architected best practice in relation to Trusted Advisor checks.

" }, "AdditionalResourceType":{ "type":"string", "enum":[ "HELPFUL_RESOURCE", "IMPROVEMENT_PLAN" ] }, "AdditionalResources":{ "type":"structure", "members":{ "Type":{ "shape":"AdditionalResourceType", "documentation":"

Type of additional resource for a custom lens.

" }, "Content":{ "shape":"Urls", "documentation":"

The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

" } }, "documentation":"

The choice level additional resources for a custom lens.

This field does not apply to Amazon Web Services official lenses.

" }, "AdditionalResourcesList":{ "type":"list", "member":{"shape":"AdditionalResources"} }, "Answer":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "PillarId":{"shape":"PillarId"}, "QuestionTitle":{"shape":"QuestionTitle"}, "QuestionDescription":{"shape":"QuestionDescription"}, "ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"}, "HelpfulResourceUrl":{"shape":"HelpfulResourceUrl"}, "HelpfulResourceDisplayText":{ "shape":"DisplayText", "documentation":"

The helpful resource text to be displayed for a custom lens.

This field does not apply to Amazon Web Services official lenses.

" }, "Choices":{"shape":"Choices"}, "SelectedChoices":{"shape":"SelectedChoices"}, "ChoiceAnswers":{ "shape":"ChoiceAnswers", "documentation":"

A list of selected choices to a question in your workload.

" }, "IsApplicable":{"shape":"IsApplicable"}, "Risk":{"shape":"Risk"}, "Notes":{"shape":"Notes"}, "Reason":{ "shape":"AnswerReason", "documentation":"

The reason why the question is not applicable to your workload.

" } }, "documentation":"

An answer of the question.

" }, "AnswerReason":{ "type":"string", "enum":[ "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE" ] }, "AnswerSummaries":{ "type":"list", "member":{"shape":"AnswerSummary"}, "documentation":"

List of answer summaries of lens review in a workload.

" }, "AnswerSummary":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "PillarId":{"shape":"PillarId"}, "QuestionTitle":{"shape":"QuestionTitle"}, "Choices":{"shape":"Choices"}, "SelectedChoices":{"shape":"SelectedChoices"}, "ChoiceAnswerSummaries":{ "shape":"ChoiceAnswerSummaries", "documentation":"

A list of selected choices to a question in your workload.

" }, "IsApplicable":{"shape":"IsApplicable"}, "Risk":{"shape":"Risk"}, "Reason":{ "shape":"AnswerReason", "documentation":"

The reason why a choice is non-applicable to a question in your workload.

" }, "QuestionType":{ "shape":"QuestionType", "documentation":"

The type of the question.

" } }, "documentation":"

An answer summary of a lens review in a workload.

" }, "ApplicationArn":{ "type":"string", "max":2084, "pattern":"arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+" }, "AssociateLensesInput":{ "type":"structure", "required":[ "WorkloadId", "LensAliases" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAliases":{"shape":"LensAliases"} }, "documentation":"

Input to associate lens reviews.

" }, "AssociateProfilesInput":{ "type":"structure", "required":[ "WorkloadId", "ProfileArns" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "ProfileArns":{ "shape":"ProfileArns", "documentation":"

The list of profile ARNs to associate with the workload.

" } } }, "AwsAccountId":{ "type":"string", "documentation":"

An Amazon Web Services account ID.

", "max":12, "min":12, "pattern":"[0-9]{12}" }, "AwsRegion":{ "type":"string", "documentation":"

An Amazon Web Services Region, for example, `us-west-2` or `ap-northeast-1`.

", "max":100 }, "Base64String":{ "type":"string", "documentation":"

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.

" }, "BestPractice":{ "type":"structure", "members":{ "ChoiceId":{"shape":"ChoiceId"}, "ChoiceTitle":{"shape":"ChoiceTitle"} }, "documentation":"

A best practice, or question choice, that has been identified as a risk in this question.

" }, "BestPractices":{ "type":"list", "member":{"shape":"BestPractice"} }, "CheckDescription":{"type":"string"}, "CheckDetail":{ "type":"structure", "members":{ "Id":{ "shape":"CheckId", "documentation":"

Trusted Advisor check ID.

" }, "Name":{ "shape":"CheckName", "documentation":"

Trusted Advisor check name.

" }, "Description":{ "shape":"CheckDescription", "documentation":"

Trusted Advisor check description.

" }, "Provider":{ "shape":"CheckProvider", "documentation":"

Provider of the check related to the best practice.

" }, "LensArn":{ "shape":"LensArn", "documentation":"

Well-Architected Lens ARN associated to the check.

" }, "PillarId":{"shape":"PillarId"}, "QuestionId":{"shape":"QuestionId"}, "ChoiceId":{"shape":"ChoiceId"}, "Status":{ "shape":"CheckStatus", "documentation":"

Status associated to the check.

" }, "AccountId":{"shape":"AwsAccountId"}, "FlaggedResources":{ "shape":"FlaggedResources", "documentation":"

Count of flagged resources associated to the check.

" }, "Reason":{ "shape":"CheckFailureReason", "documentation":"

Reason associated to the check.

" }, "UpdatedAt":{"shape":"Timestamp"} }, "documentation":"

Account details for a Well-Architected best practice in relation to Trusted Advisor checks.

" }, "CheckDetails":{ "type":"list", "member":{"shape":"CheckDetail"} }, "CheckFailureReason":{ "type":"string", "enum":[ "ASSUME_ROLE_ERROR", "ACCESS_DENIED", "UNKNOWN_ERROR", "PREMIUM_SUPPORT_REQUIRED" ] }, "CheckId":{"type":"string"}, "CheckName":{"type":"string"}, "CheckProvider":{ "type":"string", "enum":["TRUSTED_ADVISOR"] }, "CheckStatus":{ "type":"string", "enum":[ "OKAY", "WARNING", "ERROR", "NOT_AVAILABLE", "FETCH_FAILED" ] }, "CheckStatusCount":{ "type":"integer", "max":101, "min":1 }, "CheckSummaries":{ "type":"list", "member":{"shape":"CheckSummary"} }, "CheckSummary":{ "type":"structure", "members":{ "Id":{ "shape":"CheckId", "documentation":"

Trusted Advisor check ID.

" }, "Name":{ "shape":"CheckName", "documentation":"

Trusted Advisor check name.

" }, "Provider":{ "shape":"CheckProvider", "documentation":"

Provider of the check related to the best practice.

" }, "Description":{ "shape":"CheckDescription", "documentation":"

Trusted Advisor check description.

" }, "UpdatedAt":{"shape":"Timestamp"}, "LensArn":{ "shape":"LensArn", "documentation":"

Well-Architected Lens ARN associated to the check.

" }, "PillarId":{"shape":"PillarId"}, "QuestionId":{"shape":"QuestionId"}, "ChoiceId":{"shape":"ChoiceId"}, "Status":{ "shape":"CheckStatus", "documentation":"

Status associated to the check.

" }, "AccountSummary":{ "shape":"AccountSummary", "documentation":"

Account summary associated to the check.

" } }, "documentation":"

Trusted Advisor check summary.

" }, "Choice":{ "type":"structure", "members":{ "ChoiceId":{"shape":"ChoiceId"}, "Title":{"shape":"ChoiceTitle"}, "Description":{"shape":"ChoiceDescription"}, "HelpfulResource":{ "shape":"ChoiceContent", "documentation":"

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":{ "shape":"ChoiceContent", "documentation":"

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":{ "shape":"AdditionalResourcesList", "documentation":"

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.

" } }, "documentation":"

A choice available to answer question.

" }, "ChoiceAnswer":{ "type":"structure", "members":{ "ChoiceId":{"shape":"ChoiceId"}, "Status":{ "shape":"ChoiceStatus", "documentation":"

The status of a choice.

" }, "Reason":{ "shape":"ChoiceReason", "documentation":"

The reason why a choice is non-applicable to a question in your workload.

" }, "Notes":{ "shape":"ChoiceNotes", "documentation":"

The notes associated with a choice.

" } }, "documentation":"

A choice that has been answered on a question in your workload.

" }, "ChoiceAnswerSummaries":{ "type":"list", "member":{"shape":"ChoiceAnswerSummary"} }, "ChoiceAnswerSummary":{ "type":"structure", "members":{ "ChoiceId":{"shape":"ChoiceId"}, "Status":{ "shape":"ChoiceStatus", "documentation":"

The status of a choice.

" }, "Reason":{ "shape":"ChoiceReason", "documentation":"

The reason why a choice is non-applicable to a question in your workload.

" } }, "documentation":"

A choice summary that has been answered on a question in your workload.

" }, "ChoiceAnswers":{ "type":"list", "member":{"shape":"ChoiceAnswer"} }, "ChoiceContent":{ "type":"structure", "members":{ "DisplayText":{ "shape":"ChoiceContentDisplayText", "documentation":"

The display text for the choice content.

" }, "Url":{ "shape":"ChoiceContentUrl", "documentation":"

The URL for the choice content.

" } }, "documentation":"

The choice content.

" }, "ChoiceContentDisplayText":{ "type":"string", "max":1024, "min":1 }, "ChoiceContentUrl":{ "type":"string", "max":1024, "min":1 }, "ChoiceDescription":{ "type":"string", "documentation":"

The description of a choice.

", "max":1024, "min":1 }, "ChoiceId":{ "type":"string", "documentation":"

The ID of a choice.

", "max":64, "min":1 }, "ChoiceImprovementPlan":{ "type":"structure", "members":{ "ChoiceId":{"shape":"ChoiceId"}, "DisplayText":{ "shape":"DisplayText", "documentation":"

The display text for the improvement plan.

" }, "ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"} }, "documentation":"

The choice level improvement plan.

" }, "ChoiceImprovementPlans":{ "type":"list", "member":{"shape":"ChoiceImprovementPlan"} }, "ChoiceNotes":{ "type":"string", "max":250 }, "ChoiceReason":{ "type":"string", "enum":[ "OUT_OF_SCOPE", "BUSINESS_PRIORITIES", "ARCHITECTURE_CONSTRAINTS", "OTHER", "NONE" ] }, "ChoiceStatus":{ "type":"string", "enum":[ "SELECTED", "NOT_APPLICABLE", "UNSELECTED" ] }, "ChoiceTitle":{ "type":"string", "documentation":"

The title of a choice.

", "max":512, "min":1 }, "ChoiceUpdate":{ "type":"structure", "required":["Status"], "members":{ "Status":{ "shape":"ChoiceStatus", "documentation":"

The status of a choice.

" }, "Reason":{ "shape":"ChoiceReason", "documentation":"

The reason why a choice is non-applicable to a question in your workload.

" }, "Notes":{ "shape":"ChoiceNotes", "documentation":"

The notes associated with a choice.

" } }, "documentation":"

A list of choices to be updated.

" }, "ChoiceUpdates":{ "type":"map", "key":{"shape":"ChoiceId"}, "value":{"shape":"ChoiceUpdate"} }, "Choices":{ "type":"list", "member":{"shape":"Choice"}, "documentation":"

List of choices available for a question.

" }, "ClientRequestToken":{ "type":"string", "documentation":"

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.

", "max":2048, "min":1 }, "ConflictException":{ "type":"structure", "required":[ "Message", "ResourceId", "ResourceType" ], "members":{ "Message":{"shape":"ExceptionMessage"}, "ResourceId":{"shape":"ExceptionResourceId"}, "ResourceType":{"shape":"ExceptionResourceType"} }, "documentation":"

The resource has already been processed, was deleted, or is too large.

", "error":{"httpStatusCode":409}, "exception":true }, "ConsolidatedReportMetric":{ "type":"structure", "members":{ "MetricType":{ "shape":"MetricType", "documentation":"

The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.

" }, "RiskCounts":{"shape":"RiskCounts"}, "WorkloadId":{"shape":"WorkloadId"}, "WorkloadName":{"shape":"WorkloadName"}, "WorkloadArn":{"shape":"WorkloadArn"}, "UpdatedAt":{"shape":"Timestamp"}, "Lenses":{ "shape":"LensMetrics", "documentation":"

The metrics for the lenses in the workload.

" }, "LensesAppliedCount":{ "shape":"LensesAppliedCount", "documentation":"

The total number of lenses applied to the workload.

" } }, "documentation":"

A metric that contributes to the consolidated report.

" }, "ConsolidatedReportMetrics":{ "type":"list", "member":{"shape":"ConsolidatedReportMetric"} }, "Count":{ "type":"integer", "documentation":"

A non-negative integer that denotes how many.

", "min":0 }, "CreateLensShareInput":{ "type":"structure", "required":[ "LensAlias", "SharedWith", "ClientRequestToken" ], "members":{ "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "SharedWith":{"shape":"SharedWith"}, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true } } }, "CreateLensShareOutput":{ "type":"structure", "members":{ "ShareId":{"shape":"ShareId"} } }, "CreateLensVersionInput":{ "type":"structure", "required":[ "LensAlias", "LensVersion", "ClientRequestToken" ], "members":{ "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "LensVersion":{ "shape":"LensVersion", "documentation":"

The version of the lens being created.

" }, "IsMajorVersion":{ "shape":"IsMajorVersion", "documentation":"

Set to true if this new major lens version.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true } } }, "CreateLensVersionOutput":{ "type":"structure", "members":{ "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "LensVersion":{ "shape":"LensVersion", "documentation":"

The version of the lens.

" } } }, "CreateMilestoneInput":{ "type":"structure", "required":[ "WorkloadId", "MilestoneName", "ClientRequestToken" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "MilestoneName":{"shape":"MilestoneName"}, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true } }, "documentation":"

Input for milestone creation.

" }, "CreateMilestoneOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "MilestoneNumber":{"shape":"MilestoneNumber"} }, "documentation":"

Output of a create milestone call.

" }, "CreateProfileInput":{ "type":"structure", "required":[ "ProfileName", "ProfileDescription", "ProfileQuestions", "ClientRequestToken" ], "members":{ "ProfileName":{ "shape":"ProfileName", "documentation":"

Name of the profile.

" }, "ProfileDescription":{ "shape":"ProfileDescription", "documentation":"

The profile description.

" }, "ProfileQuestions":{ "shape":"ProfileQuestionUpdates", "documentation":"

The profile questions.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true }, "Tags":{ "shape":"TagMap", "documentation":"

The tags assigned to the profile.

" } } }, "CreateProfileOutput":{ "type":"structure", "members":{ "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

" }, "ProfileVersion":{ "shape":"ProfileVersion", "documentation":"

Version of the profile.

" } } }, "CreateProfileShareInput":{ "type":"structure", "required":[ "ProfileArn", "SharedWith", "ClientRequestToken" ], "members":{ "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

", "location":"uri", "locationName":"ProfileArn" }, "SharedWith":{"shape":"SharedWith"}, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true } } }, "CreateProfileShareOutput":{ "type":"structure", "members":{ "ShareId":{"shape":"ShareId"}, "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

" } } }, "CreateReviewTemplateInput":{ "type":"structure", "required":[ "TemplateName", "Description", "Lenses", "ClientRequestToken" ], "members":{ "TemplateName":{ "shape":"TemplateName", "documentation":"

Name of the review template.

" }, "Description":{ "shape":"TemplateDescription", "documentation":"

The review template description.

" }, "Lenses":{ "shape":"ReviewTemplateLenses", "documentation":"

Lenses applied to the review template.

" }, "Notes":{"shape":"Notes"}, "Tags":{ "shape":"TagMap", "documentation":"

The tags assigned to the review template.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true } } }, "CreateReviewTemplateOutput":{ "type":"structure", "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" } } }, "CreateTemplateShareInput":{ "type":"structure", "required":[ "TemplateArn", "SharedWith", "ClientRequestToken" ], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" }, "SharedWith":{"shape":"SharedWith"}, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true } } }, "CreateTemplateShareOutput":{ "type":"structure", "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" }, "ShareId":{"shape":"ShareId"} } }, "CreateWorkloadInput":{ "type":"structure", "required":[ "WorkloadName", "Description", "Environment", "Lenses", "ClientRequestToken" ], "members":{ "WorkloadName":{"shape":"WorkloadName"}, "Description":{"shape":"WorkloadDescription"}, "Environment":{"shape":"WorkloadEnvironment"}, "AccountIds":{"shape":"WorkloadAccountIds"}, "AwsRegions":{"shape":"WorkloadAwsRegions"}, "NonAwsRegions":{"shape":"WorkloadNonAwsRegions"}, "PillarPriorities":{"shape":"WorkloadPillarPriorities"}, "ArchitecturalDesign":{"shape":"WorkloadArchitecturalDesign"}, "ReviewOwner":{"shape":"WorkloadReviewOwner"}, "IndustryType":{"shape":"WorkloadIndustryType"}, "Industry":{"shape":"WorkloadIndustry"}, "Lenses":{"shape":"WorkloadLenses"}, "Notes":{"shape":"Notes"}, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true }, "Tags":{ "shape":"TagMap", "documentation":"

The tags to be associated with the workload.

" }, "DiscoveryConfig":{ "shape":"WorkloadDiscoveryConfig", "documentation":"

Well-Architected discovery configuration settings associated to the workload.

" }, "Applications":{ "shape":"WorkloadApplications", "documentation":"

List of AppRegistry application ARNs associated to the workload.

" }, "ProfileArns":{ "shape":"WorkloadProfileArns", "documentation":"

The list of profile ARNs associated with the workload.

" }, "ReviewTemplateArns":{ "shape":"ReviewTemplateArns", "documentation":"

The list of review template ARNs to associate with the workload.

" } }, "documentation":"

Input for workload creation.

" }, "CreateWorkloadOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "WorkloadArn":{"shape":"WorkloadArn"} }, "documentation":"

Output of a create workload call.

" }, "CreateWorkloadShareInput":{ "type":"structure", "required":[ "WorkloadId", "SharedWith", "PermissionType", "ClientRequestToken" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "SharedWith":{"shape":"SharedWith"}, "PermissionType":{"shape":"PermissionType"}, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true } }, "documentation":"

Input for Create Workload Share

" }, "CreateWorkloadShareOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "ShareId":{"shape":"ShareId"} }, "documentation":"

Input for Create Workload Share

" }, "DefinitionType":{ "type":"string", "enum":[ "WORKLOAD_METADATA", "APP_REGISTRY" ] }, "DeleteLensInput":{ "type":"structure", "required":[ "LensAlias", "ClientRequestToken", "LensStatus" ], "members":{ "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true, "location":"querystring", "locationName":"ClientRequestToken" }, "LensStatus":{ "shape":"LensStatusType", "documentation":"

The status of the lens to be deleted.

", "location":"querystring", "locationName":"LensStatus" } } }, "DeleteLensShareInput":{ "type":"structure", "required":[ "ShareId", "LensAlias", "ClientRequestToken" ], "members":{ "ShareId":{ "shape":"ShareId", "location":"uri", "locationName":"ShareId" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true, "location":"querystring", "locationName":"ClientRequestToken" } } }, "DeleteProfileInput":{ "type":"structure", "required":[ "ProfileArn", "ClientRequestToken" ], "members":{ "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

", "location":"uri", "locationName":"ProfileArn" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true, "location":"querystring", "locationName":"ClientRequestToken" } } }, "DeleteProfileShareInput":{ "type":"structure", "required":[ "ShareId", "ProfileArn", "ClientRequestToken" ], "members":{ "ShareId":{ "shape":"ShareId", "location":"uri", "locationName":"ShareId" }, "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

", "location":"uri", "locationName":"ProfileArn" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true, "location":"querystring", "locationName":"ClientRequestToken" } } }, "DeleteReviewTemplateInput":{ "type":"structure", "required":[ "TemplateArn", "ClientRequestToken" ], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true, "location":"querystring", "locationName":"ClientRequestToken" } } }, "DeleteTemplateShareInput":{ "type":"structure", "required":[ "ShareId", "TemplateArn", "ClientRequestToken" ], "members":{ "ShareId":{ "shape":"ShareId", "location":"uri", "locationName":"ShareId" }, "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true, "location":"querystring", "locationName":"ClientRequestToken" } } }, "DeleteWorkloadInput":{ "type":"structure", "required":[ "WorkloadId", "ClientRequestToken" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true, "location":"querystring", "locationName":"ClientRequestToken" } }, "documentation":"

Input for workload deletion.

" }, "DeleteWorkloadShareInput":{ "type":"structure", "required":[ "ShareId", "WorkloadId", "ClientRequestToken" ], "members":{ "ShareId":{ "shape":"ShareId", "location":"uri", "locationName":"ShareId" }, "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true, "location":"querystring", "locationName":"ClientRequestToken" } }, "documentation":"

Input for Delete Workload Share

" }, "DifferenceStatus":{ "type":"string", "enum":[ "UPDATED", "NEW", "DELETED" ] }, "DisassociateLensesInput":{ "type":"structure", "required":[ "WorkloadId", "LensAliases" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAliases":{"shape":"LensAliases"} }, "documentation":"

Input to disassociate lens reviews.

" }, "DisassociateProfilesInput":{ "type":"structure", "required":[ "WorkloadId", "ProfileArns" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "ProfileArns":{ "shape":"ProfileArns", "documentation":"

The list of profile ARNs to disassociate from the workload.

" } } }, "DiscoveryIntegrationStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "DisplayText":{ "type":"string", "max":64, "min":1 }, "ExceptionMessage":{ "type":"string", "documentation":"

Description of the error.

" }, "ExceptionResourceId":{ "type":"string", "documentation":"

Identifier of the resource affected.

" }, "ExceptionResourceType":{ "type":"string", "documentation":"

Type of the resource affected.

" }, "ExportLensInput":{ "type":"structure", "required":["LensAlias"], "members":{ "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "LensVersion":{ "shape":"LensVersion", "documentation":"

The lens version to be exported.

", "location":"querystring", "locationName":"LensVersion" } } }, "ExportLensOutput":{ "type":"structure", "members":{ "LensJSON":{ "shape":"LensJSON", "documentation":"

The JSON representation of a lens.

" } } }, "FlaggedResources":{ "type":"integer", "max":9999, "min":1 }, "GetAnswerInput":{ "type":"structure", "required":[ "WorkloadId", "LensAlias", "QuestionId" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "QuestionId":{ "shape":"QuestionId", "location":"uri", "locationName":"QuestionId" }, "MilestoneNumber":{ "shape":"MilestoneNumber", "location":"querystring", "locationName":"MilestoneNumber" } }, "documentation":"

Input to get answer.

" }, "GetAnswerOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "MilestoneNumber":{"shape":"MilestoneNumber"}, "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "Answer":{"shape":"Answer"} }, "documentation":"

Output of a get answer call.

" }, "GetConsolidatedReportInput":{ "type":"structure", "required":["Format"], "members":{ "Format":{ "shape":"ReportFormat", "documentation":"

The format of the consolidated report.

For `PDF`, `Base64String` is returned. For `JSON`, `Metrics` is returned.

", "location":"querystring", "locationName":"Format" }, "IncludeSharedResources":{ "shape":"IncludeSharedResources", "documentation":"

Set to `true` to have shared resources included in the report.

", "location":"querystring", "locationName":"IncludeSharedResources" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"GetConsolidatedReportMaxResults", "documentation":"

The maximum number of results to return for this request.

", "location":"querystring", "locationName":"MaxResults" } } }, "GetConsolidatedReportMaxResults":{ "type":"integer", "max":15, "min":1 }, "GetConsolidatedReportOutput":{ "type":"structure", "members":{ "Metrics":{ "shape":"ConsolidatedReportMetrics", "documentation":"

The metrics that make up the consolidated report.

Only returned when `JSON` format is requested.

" }, "NextToken":{"shape":"NextToken"}, "Base64String":{"shape":"Base64String"} } }, "GetLensInput":{ "type":"structure", "required":["LensAlias"], "members":{ "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "LensVersion":{ "shape":"LensVersion", "documentation":"

The lens version to be retrieved.

", "location":"querystring", "locationName":"LensVersion" } } }, "GetLensOutput":{ "type":"structure", "members":{ "Lens":{ "shape":"Lens", "documentation":"

A lens return object.

" } } }, "GetLensReviewInput":{ "type":"structure", "required":[ "WorkloadId", "LensAlias" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "MilestoneNumber":{ "shape":"MilestoneNumber", "location":"querystring", "locationName":"MilestoneNumber" } }, "documentation":"

Input to get lens review.

" }, "GetLensReviewOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "MilestoneNumber":{"shape":"MilestoneNumber"}, "LensReview":{"shape":"LensReview"} }, "documentation":"

Output of a get lens review call.

" }, "GetLensReviewReportInput":{ "type":"structure", "required":[ "WorkloadId", "LensAlias" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "MilestoneNumber":{ "shape":"MilestoneNumber", "location":"querystring", "locationName":"MilestoneNumber" } }, "documentation":"

Input to get lens review report.

" }, "GetLensReviewReportOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "MilestoneNumber":{"shape":"MilestoneNumber"}, "LensReviewReport":{"shape":"LensReviewReport"} }, "documentation":"

Output of a get lens review report call.

" }, "GetLensVersionDifferenceInput":{ "type":"structure", "required":["LensAlias"], "members":{ "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "BaseLensVersion":{ "shape":"LensVersion", "documentation":"

The base version of the lens.

", "location":"querystring", "locationName":"BaseLensVersion" }, "TargetLensVersion":{ "shape":"LensVersion", "documentation":"

The lens version to target a difference for.

", "location":"querystring", "locationName":"TargetLensVersion" } } }, "GetLensVersionDifferenceOutput":{ "type":"structure", "members":{ "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "BaseLensVersion":{ "shape":"LensVersion", "documentation":"

The base version of the lens.

" }, "TargetLensVersion":{ "shape":"LensVersion", "documentation":"

The target lens version for the lens.

" }, "LatestLensVersion":{ "shape":"LensVersion", "documentation":"

The latest version of the lens.

" }, "VersionDifferences":{"shape":"VersionDifferences"} } }, "GetMilestoneInput":{ "type":"structure", "required":[ "WorkloadId", "MilestoneNumber" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "MilestoneNumber":{ "shape":"MilestoneNumber", "location":"uri", "locationName":"MilestoneNumber" } }, "documentation":"

Input to get a milestone.

" }, "GetMilestoneOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "Milestone":{"shape":"Milestone"} }, "documentation":"

Output of a get milestone call.

" }, "GetProfileInput":{ "type":"structure", "required":["ProfileArn"], "members":{ "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

", "location":"uri", "locationName":"ProfileArn" }, "ProfileVersion":{ "shape":"ProfileVersion", "documentation":"

The profile version.

", "location":"querystring", "locationName":"ProfileVersion" } } }, "GetProfileOutput":{ "type":"structure", "members":{ "Profile":{ "shape":"Profile", "documentation":"

The profile.

" } } }, "GetProfileTemplateInput":{ "type":"structure", "members":{ } }, "GetProfileTemplateOutput":{ "type":"structure", "members":{ "ProfileTemplate":{ "shape":"ProfileTemplate", "documentation":"

The profile template.

" } } }, "GetReviewTemplateAnswerInput":{ "type":"structure", "required":[ "TemplateArn", "LensAlias", "QuestionId" ], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "QuestionId":{ "shape":"QuestionId", "location":"uri", "locationName":"QuestionId" } } }, "GetReviewTemplateAnswerOutput":{ "type":"structure", "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" }, "LensAlias":{"shape":"LensAlias"}, "Answer":{ "shape":"ReviewTemplateAnswer", "documentation":"

An answer of the question.

" } } }, "GetReviewTemplateInput":{ "type":"structure", "required":["TemplateArn"], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" } } }, "GetReviewTemplateLensReviewInput":{ "type":"structure", "required":[ "TemplateArn", "LensAlias" ], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" } } }, "GetReviewTemplateLensReviewOutput":{ "type":"structure", "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" }, "LensReview":{ "shape":"ReviewTemplateLensReview", "documentation":"

A lens review of a question.

" } } }, "GetReviewTemplateOutput":{ "type":"structure", "members":{ "ReviewTemplate":{ "shape":"ReviewTemplate", "documentation":"

The review template.

" } } }, "GetWorkloadInput":{ "type":"structure", "required":["WorkloadId"], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" } }, "documentation":"

Input to get a workload.

" }, "GetWorkloadOutput":{ "type":"structure", "members":{ "Workload":{"shape":"Workload"} }, "documentation":"

Output of a get workload call.

" }, "HelpfulResourceUrl":{ "type":"string", "documentation":"

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.

", "max":2048, "min":1 }, "ImportLensInput":{ "type":"structure", "required":[ "JSONString", "ClientRequestToken" ], "members":{ "LensAlias":{"shape":"LensAlias"}, "JSONString":{ "shape":"LensJSON", "documentation":"

The JSON representation of a lens.

" }, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true }, "Tags":{ "shape":"TagMap", "documentation":"

Tags to associate to a lens.

" } } }, "ImportLensOutput":{ "type":"structure", "members":{ "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens that was created or updated.

" }, "Status":{ "shape":"ImportLensStatus", "documentation":"

The status of the imported lens.

" } } }, "ImportLensStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "COMPLETE", "ERROR" ] }, "ImprovementPlanUrl":{ "type":"string", "documentation":"

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.

", "max":2048, "min":1 }, "ImprovementSummaries":{ "type":"list", "member":{"shape":"ImprovementSummary"}, "documentation":"

List of improvement summaries of lens review in a workload.

" }, "ImprovementSummary":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "PillarId":{"shape":"PillarId"}, "QuestionTitle":{"shape":"QuestionTitle"}, "Risk":{"shape":"Risk"}, "ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"}, "ImprovementPlans":{ "shape":"ChoiceImprovementPlans", "documentation":"

The improvement plan details.

" } }, "documentation":"

An improvement summary of a lens review in a workload.

" }, "IncludeSharedResources":{"type":"boolean"}, "InternalServerException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"ExceptionMessage"} }, "documentation":"

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

", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "IsApplicable":{ "type":"boolean", "documentation":"

Defines whether this question is applicable to a lens review.

" }, "IsMajorVersion":{"type":"boolean"}, "IsReviewOwnerUpdateAcknowledged":{"type":"boolean"}, "Lens":{ "type":"structure", "members":{ "LensArn":{ "shape":"LensArn", "documentation":"

The ARN of a lens.

" }, "LensVersion":{ "shape":"LensVersion", "documentation":"

The version of a lens.

" }, "Name":{"shape":"LensName"}, "Description":{"shape":"LensDescription"}, "Owner":{ "shape":"LensOwner", "documentation":"

The Amazon Web Services account ID that owns the lens.

" }, "ShareInvitationId":{ "shape":"ShareInvitationId", "documentation":"

The ID assigned to the share invitation.

" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags assigned to the lens.

" } }, "documentation":"

A lens return object.

" }, "LensAlias":{ "type":"string", "documentation":"

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.

", "max":128, "min":1 }, "LensAliases":{ "type":"list", "member":{"shape":"LensAlias"}, "documentation":"

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.

", "min":1 }, "LensArn":{"type":"string"}, "LensDescription":{ "type":"string", "documentation":"

The description of the lens.

", "max":1024, "min":1 }, "LensJSON":{ "type":"string", "max":500000, "min":2 }, "LensMetric":{ "type":"structure", "members":{ "LensArn":{ "shape":"LensArn", "documentation":"

The lens ARN.

" }, "Pillars":{ "shape":"PillarMetrics", "documentation":"

The metrics for the pillars in a lens.

" }, "RiskCounts":{"shape":"RiskCounts"} }, "documentation":"

A metric for a particular lens in a workload.

" }, "LensMetrics":{ "type":"list", "member":{"shape":"LensMetric"} }, "LensName":{ "type":"string", "documentation":"

The full name of the lens.

", "max":128, "min":1 }, "LensNamePrefix":{ "type":"string", "max":100 }, "LensOwner":{"type":"string"}, "LensReview":{ "type":"structure", "members":{ "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "LensVersion":{ "shape":"LensVersion", "documentation":"

The version of the lens.

" }, "LensName":{"shape":"LensName"}, "LensStatus":{ "shape":"LensStatus", "documentation":"

The status of the lens.

" }, "PillarReviewSummaries":{"shape":"PillarReviewSummaries"}, "UpdatedAt":{"shape":"Timestamp"}, "Notes":{"shape":"Notes"}, "RiskCounts":{"shape":"RiskCounts"}, "NextToken":{"shape":"NextToken"}, "Profiles":{ "shape":"WorkloadProfiles", "documentation":"

The profiles associated with the workload.

" }, "PrioritizedRiskCounts":{"shape":"RiskCounts"} }, "documentation":"

A lens review of a question.

" }, "LensReviewReport":{ "type":"structure", "members":{ "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "Base64String":{"shape":"Base64String"} }, "documentation":"

A report of a lens review.

" }, "LensReviewSummaries":{ "type":"list", "member":{"shape":"LensReviewSummary"}, "documentation":"

List of lens summaries of lens reviews of a workload.

" }, "LensReviewSummary":{ "type":"structure", "members":{ "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "LensVersion":{ "shape":"LensVersion", "documentation":"

The version of the lens.

" }, "LensName":{"shape":"LensName"}, "LensStatus":{ "shape":"LensStatus", "documentation":"

The status of the lens.

" }, "UpdatedAt":{"shape":"Timestamp"}, "RiskCounts":{"shape":"RiskCounts"}, "Profiles":{ "shape":"WorkloadProfiles", "documentation":"

The profiles associated with the workload.

" }, "PrioritizedRiskCounts":{"shape":"RiskCounts"} }, "documentation":"

A lens review summary of a workload.

" }, "LensShareSummaries":{ "type":"list", "member":{"shape":"LensShareSummary"} }, "LensShareSummary":{ "type":"structure", "members":{ "ShareId":{"shape":"ShareId"}, "SharedWith":{"shape":"SharedWith"}, "Status":{"shape":"ShareStatus"}, "StatusMessage":{ "shape":"StatusMessage", "documentation":"

Optional message to compliment the Status field.

" } }, "documentation":"

A lens share summary return object.

" }, "LensStatus":{ "type":"string", "enum":[ "CURRENT", "NOT_CURRENT", "DEPRECATED", "DELETED", "UNSHARED" ] }, "LensStatusType":{ "type":"string", "enum":[ "ALL", "DRAFT", "PUBLISHED" ] }, "LensSummaries":{ "type":"list", "member":{"shape":"LensSummary"}, "documentation":"

List of lens summaries of available lenses.

" }, "LensSummary":{ "type":"structure", "members":{ "LensArn":{ "shape":"LensArn", "documentation":"

The ARN of the lens.

" }, "LensAlias":{"shape":"LensAlias"}, "LensName":{"shape":"LensName"}, "LensType":{ "shape":"LensType", "documentation":"

The type of the lens.

" }, "Description":{"shape":"LensDescription"}, "CreatedAt":{"shape":"Timestamp"}, "UpdatedAt":{"shape":"Timestamp"}, "LensVersion":{ "shape":"LensVersion", "documentation":"

The version of the lens.

" }, "Owner":{"shape":"AwsAccountId"}, "LensStatus":{ "shape":"LensStatus", "documentation":"

The status of the lens.

" } }, "documentation":"

A lens summary of a lens.

" }, "LensType":{ "type":"string", "enum":[ "AWS_OFFICIAL", "CUSTOM_SHARED", "CUSTOM_SELF" ] }, "LensUpgradeSummary":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "WorkloadName":{"shape":"WorkloadName"}, "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "CurrentLensVersion":{ "shape":"LensVersion", "documentation":"

The current version of the lens.

" }, "LatestLensVersion":{ "shape":"LensVersion", "documentation":"

The latest version of the lens.

" }, "ResourceArn":{ "shape":"ResourceArn", "documentation":"

`ResourceArn` of the lens being upgraded

" }, "ResourceName":{"shape":"WorkloadName"} }, "documentation":"

Lens upgrade summary return object.

" }, "LensVersion":{ "type":"string", "max":32, "min":1 }, "LensesAppliedCount":{ "type":"integer", "min":0 }, "ListAnswersInput":{ "type":"structure", "required":[ "WorkloadId", "LensAlias" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "PillarId":{ "shape":"PillarId", "location":"querystring", "locationName":"PillarId" }, "MilestoneNumber":{ "shape":"MilestoneNumber", "location":"querystring", "locationName":"MilestoneNumber" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"ListAnswersMaxResults", "documentation":"

The maximum number of results to return for this request.

", "location":"querystring", "locationName":"MaxResults" }, "QuestionPriority":{ "shape":"QuestionPriority", "documentation":"

The priority of the question.

", "location":"querystring", "locationName":"QuestionPriority" } }, "documentation":"

Input to list answers.

" }, "ListAnswersMaxResults":{ "type":"integer", "max":50, "min":1 }, "ListAnswersOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "MilestoneNumber":{"shape":"MilestoneNumber"}, "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "AnswerSummaries":{"shape":"AnswerSummaries"}, "NextToken":{"shape":"NextToken"} }, "documentation":"

Output of a list answers call.

" }, "ListCheckDetailsInput":{ "type":"structure", "required":[ "WorkloadId", "LensArn", "PillarId", "QuestionId", "ChoiceId" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "NextToken":{"shape":"NextToken"}, "MaxResults":{"shape":"MaxResults"}, "LensArn":{ "shape":"LensArn", "documentation":"

Well-Architected Lens ARN.

" }, "PillarId":{"shape":"PillarId"}, "QuestionId":{"shape":"QuestionId"}, "ChoiceId":{"shape":"ChoiceId"} } }, "ListCheckDetailsOutput":{ "type":"structure", "members":{ "CheckDetails":{ "shape":"CheckDetails", "documentation":"

The details about the Trusted Advisor checks related to the Well-Architected best practice.

" }, "NextToken":{"shape":"NextToken"} } }, "ListCheckSummariesInput":{ "type":"structure", "required":[ "WorkloadId", "LensArn", "PillarId", "QuestionId", "ChoiceId" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "NextToken":{"shape":"NextToken"}, "MaxResults":{"shape":"MaxResults"}, "LensArn":{ "shape":"LensArn", "documentation":"

Well-Architected Lens ARN.

" }, "PillarId":{"shape":"PillarId"}, "QuestionId":{"shape":"QuestionId"}, "ChoiceId":{"shape":"ChoiceId"} } }, "ListCheckSummariesOutput":{ "type":"structure", "members":{ "CheckSummaries":{ "shape":"CheckSummaries", "documentation":"

List of Trusted Advisor summaries related to the Well-Architected best practice.

" }, "NextToken":{"shape":"NextToken"} } }, "ListLensReviewImprovementsInput":{ "type":"structure", "required":[ "WorkloadId", "LensAlias" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "PillarId":{ "shape":"PillarId", "location":"querystring", "locationName":"PillarId" }, "MilestoneNumber":{ "shape":"MilestoneNumber", "location":"querystring", "locationName":"MilestoneNumber" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"ListLensReviewImprovementsMaxResults", "documentation":"

The maximum number of results to return for this request.

", "location":"querystring", "locationName":"MaxResults" }, "QuestionPriority":{ "shape":"QuestionPriority", "documentation":"

The priority of the question.

", "location":"querystring", "locationName":"QuestionPriority" } }, "documentation":"

Input to list lens review improvements.

" }, "ListLensReviewImprovementsMaxResults":{ "type":"integer", "max":100, "min":1 }, "ListLensReviewImprovementsOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "MilestoneNumber":{"shape":"MilestoneNumber"}, "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "ImprovementSummaries":{"shape":"ImprovementSummaries"}, "NextToken":{"shape":"NextToken"} }, "documentation":"

Output of a list lens review improvements call.

" }, "ListLensReviewsInput":{ "type":"structure", "required":["WorkloadId"], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "MilestoneNumber":{ "shape":"MilestoneNumber", "location":"querystring", "locationName":"MilestoneNumber" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"MaxResults" } }, "documentation":"

Input to list lens reviews.

" }, "ListLensReviewsOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "MilestoneNumber":{"shape":"MilestoneNumber"}, "LensReviewSummaries":{"shape":"LensReviewSummaries"}, "NextToken":{"shape":"NextToken"} }, "documentation":"

Output of a list lens reviews call.

" }, "ListLensSharesInput":{ "type":"structure", "required":["LensAlias"], "members":{ "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "SharedWithPrefix":{ "shape":"SharedWithPrefix", "documentation":"

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the lens is shared.

", "location":"querystring", "locationName":"SharedWithPrefix" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"ListWorkloadSharesMaxResults", "documentation":"

The maximum number of results to return for this request.

", "location":"querystring", "locationName":"MaxResults" }, "Status":{ "shape":"ShareStatus", "location":"querystring", "locationName":"Status" } } }, "ListLensSharesOutput":{ "type":"structure", "members":{ "LensShareSummaries":{ "shape":"LensShareSummaries", "documentation":"

A list of lens share summaries.

" }, "NextToken":{"shape":"NextToken"} } }, "ListLensesInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"MaxResults" }, "LensType":{ "shape":"LensType", "documentation":"

The type of lenses to be returned.

", "location":"querystring", "locationName":"LensType" }, "LensStatus":{ "shape":"LensStatusType", "documentation":"

The status of lenses to be returned.

", "location":"querystring", "locationName":"LensStatus" }, "LensName":{ "shape":"LensName", "location":"querystring", "locationName":"LensName" } }, "documentation":"

Input to list lenses.

" }, "ListLensesOutput":{ "type":"structure", "members":{ "LensSummaries":{"shape":"LensSummaries"}, "NextToken":{"shape":"NextToken"} }, "documentation":"

Output of a list lenses call.

" }, "ListMilestonesInput":{ "type":"structure", "required":["WorkloadId"], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "NextToken":{"shape":"NextToken"}, "MaxResults":{"shape":"MaxResults"} }, "documentation":"

Input to list all milestones for a workload.

" }, "ListMilestonesOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "MilestoneSummaries":{"shape":"MilestoneSummaries"}, "NextToken":{"shape":"NextToken"} }, "documentation":"

Output of a list milestones call.

" }, "ListNotificationsInput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "NextToken":{"shape":"NextToken"}, "MaxResults":{ "shape":"ListNotificationsMaxResults", "documentation":"

The maximum number of results to return for this request.

" }, "ResourceArn":{ "shape":"ResourceArn", "documentation":"

The ARN for the related resource for the notification.

Only one of `WorkloadID` or `ResourceARN` should be specified.

" } } }, "ListNotificationsMaxResults":{ "type":"integer", "max":50, "min":1 }, "ListNotificationsOutput":{ "type":"structure", "members":{ "NotificationSummaries":{ "shape":"NotificationSummaries", "documentation":"

List of lens notification summaries in a workload.

" }, "NextToken":{"shape":"NextToken"} } }, "ListProfileNotificationsInput":{ "type":"structure", "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"querystring", "locationName":"WorkloadId" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"MaxResults" } } }, "ListProfileNotificationsOutput":{ "type":"structure", "members":{ "NotificationSummaries":{ "shape":"ProfileNotificationSummaries", "documentation":"

Notification summaries.

" }, "NextToken":{"shape":"NextToken"} } }, "ListProfileSharesInput":{ "type":"structure", "required":["ProfileArn"], "members":{ "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

", "location":"uri", "locationName":"ProfileArn" }, "SharedWithPrefix":{ "shape":"SharedWithPrefix", "documentation":"

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.

", "location":"querystring", "locationName":"SharedWithPrefix" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"ListProfileSharesMaxResults", "documentation":"

The maximum number of results to return for this request.

", "location":"querystring", "locationName":"MaxResults" }, "Status":{ "shape":"ShareStatus", "location":"querystring", "locationName":"Status" } } }, "ListProfileSharesMaxResults":{ "type":"integer", "max":50, "min":1 }, "ListProfileSharesOutput":{ "type":"structure", "members":{ "ProfileShareSummaries":{ "shape":"ProfileShareSummaries", "documentation":"

Profile share summaries.

" }, "NextToken":{"shape":"NextToken"} } }, "ListProfilesInput":{ "type":"structure", "members":{ "ProfileNamePrefix":{ "shape":"ProfileNamePrefix", "documentation":"

An optional string added to the beginning of each profile name returned in the results.

", "location":"querystring", "locationName":"ProfileNamePrefix" }, "ProfileOwnerType":{ "shape":"ProfileOwnerType", "documentation":"

Profile owner type.

", "location":"querystring", "locationName":"ProfileOwnerType" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"MaxResults" } } }, "ListProfilesOutput":{ "type":"structure", "members":{ "ProfileSummaries":{ "shape":"ProfileSummaries", "documentation":"

Profile summaries.

" }, "NextToken":{"shape":"NextToken"} } }, "ListReviewTemplateAnswersInput":{ "type":"structure", "required":[ "TemplateArn", "LensAlias" ], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The ARN of the review template.

", "location":"uri", "locationName":"TemplateArn" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "PillarId":{ "shape":"PillarId", "location":"querystring", "locationName":"PillarId" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"ListReviewTemplateAnswersMaxResults", "documentation":"

The maximum number of results to return for this request.

", "location":"querystring", "locationName":"MaxResults" } } }, "ListReviewTemplateAnswersMaxResults":{ "type":"integer", "max":50, "min":1 }, "ListReviewTemplateAnswersOutput":{ "type":"structure", "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The ARN of the review template.

" }, "LensAlias":{"shape":"LensAlias"}, "AnswerSummaries":{ "shape":"ReviewTemplateAnswerSummaries", "documentation":"

List of answer summaries of a lens review in a review template.

" }, "NextToken":{"shape":"NextToken"} } }, "ListReviewTemplatesInput":{ "type":"structure", "members":{ "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"MaxResults", "location":"querystring", "locationName":"MaxResults" } } }, "ListReviewTemplatesOutput":{ "type":"structure", "members":{ "ReviewTemplates":{ "shape":"ReviewTemplates", "documentation":"

List of review templates.

" }, "NextToken":{"shape":"NextToken"} } }, "ListShareInvitationsInput":{ "type":"structure", "members":{ "WorkloadNamePrefix":{ "shape":"WorkloadNamePrefix", "location":"querystring", "locationName":"WorkloadNamePrefix" }, "LensNamePrefix":{ "shape":"LensNamePrefix", "documentation":"

An optional string added to the beginning of each lens name returned in the results.

", "location":"querystring", "locationName":"LensNamePrefix" }, "ShareResourceType":{ "shape":"ShareResourceType", "documentation":"

The type of share invitations to be returned.

", "location":"querystring", "locationName":"ShareResourceType" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"ListShareInvitationsMaxResults", "documentation":"

The maximum number of results to return for this request.

", "location":"querystring", "locationName":"MaxResults" }, "ProfileNamePrefix":{ "shape":"ProfileNamePrefix", "documentation":"

An optional string added to the beginning of each profile name returned in the results.

", "location":"querystring", "locationName":"ProfileNamePrefix" }, "TemplateNamePrefix":{ "shape":"TemplateNamePrefix", "documentation":"

An optional string added to the beginning of each review template name returned in the results.

", "location":"querystring", "locationName":"TemplateNamePrefix" } }, "documentation":"

Input for List Share Invitations

" }, "ListShareInvitationsMaxResults":{ "type":"integer", "max":50, "min":1 }, "ListShareInvitationsOutput":{ "type":"structure", "members":{ "ShareInvitationSummaries":{ "shape":"ShareInvitationSummaries", "documentation":"

List of share invitation summaries in a workload.

" }, "NextToken":{"shape":"NextToken"} }, "documentation":"

Input for List Share Invitations

" }, "ListTagsForResourceInput":{ "type":"structure", "required":["WorkloadArn"], "members":{ "WorkloadArn":{ "shape":"WorkloadArn", "location":"uri", "locationName":"WorkloadArn" } } }, "ListTagsForResourceOutput":{ "type":"structure", "members":{ "Tags":{ "shape":"TagMap", "documentation":"

The tags for the resource.

" } } }, "ListTemplateSharesInput":{ "type":"structure", "required":["TemplateArn"], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" }, "SharedWithPrefix":{ "shape":"SharedWithPrefix", "documentation":"

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.

", "location":"querystring", "locationName":"SharedWithPrefix" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"ListTemplateSharesMaxResults", "documentation":"

The maximum number of results to return for this request.

", "location":"querystring", "locationName":"MaxResults" }, "Status":{ "shape":"ShareStatus", "location":"querystring", "locationName":"Status" } } }, "ListTemplateSharesMaxResults":{ "type":"integer", "max":50, "min":1 }, "ListTemplateSharesOutput":{ "type":"structure", "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" }, "TemplateShareSummaries":{ "shape":"TemplateShareSummaries", "documentation":"

A review template share summary return object.

" }, "NextToken":{"shape":"NextToken"} } }, "ListWorkloadSharesInput":{ "type":"structure", "required":["WorkloadId"], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "SharedWithPrefix":{ "shape":"SharedWithPrefix", "documentation":"

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.

", "location":"querystring", "locationName":"SharedWithPrefix" }, "NextToken":{ "shape":"NextToken", "location":"querystring", "locationName":"NextToken" }, "MaxResults":{ "shape":"ListWorkloadSharesMaxResults", "documentation":"

The maximum number of results to return for this request.

", "location":"querystring", "locationName":"MaxResults" }, "Status":{ "shape":"ShareStatus", "location":"querystring", "locationName":"Status" } }, "documentation":"

Input for List Workload Share

" }, "ListWorkloadSharesMaxResults":{ "type":"integer", "max":50, "min":1 }, "ListWorkloadSharesOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "WorkloadShareSummaries":{"shape":"WorkloadShareSummaries"}, "NextToken":{"shape":"NextToken"} }, "documentation":"

Input for List Workload Share

" }, "ListWorkloadsInput":{ "type":"structure", "members":{ "WorkloadNamePrefix":{"shape":"WorkloadNamePrefix"}, "NextToken":{"shape":"NextToken"}, "MaxResults":{ "shape":"ListWorkloadsMaxResults", "documentation":"

The maximum number of results to return for this request.

" } }, "documentation":"

Input to list all workloads.

" }, "ListWorkloadsMaxResults":{ "type":"integer", "max":50, "min":1 }, "ListWorkloadsOutput":{ "type":"structure", "members":{ "WorkloadSummaries":{"shape":"WorkloadSummaries"}, "NextToken":{"shape":"NextToken"} }, "documentation":"

Output of a list workloads call.

" }, "MaxResults":{ "type":"integer", "documentation":"

The maximum number of results to return for this request.

", "max":50, "min":1 }, "MaxSelectedProfileChoices":{ "type":"integer", "min":0 }, "MetricType":{ "type":"string", "enum":["WORKLOAD"] }, "Milestone":{ "type":"structure", "members":{ "MilestoneNumber":{"shape":"MilestoneNumber"}, "MilestoneName":{"shape":"MilestoneName"}, "RecordedAt":{"shape":"Timestamp"}, "Workload":{"shape":"Workload"} }, "documentation":"

A milestone return object.

" }, "MilestoneName":{ "type":"string", "documentation":"

The name of the milestone in a workload.

Milestone names must be unique within a workload.

", "max":100, "min":3 }, "MilestoneNumber":{ "type":"integer", "documentation":"

The milestone number.

A workload can have a maximum of 100 milestones.

", "max":100, "min":1 }, "MilestoneSummaries":{ "type":"list", "member":{"shape":"MilestoneSummary"}, "documentation":"

A list of milestone summaries.

" }, "MilestoneSummary":{ "type":"structure", "members":{ "MilestoneNumber":{"shape":"MilestoneNumber"}, "MilestoneName":{"shape":"MilestoneName"}, "RecordedAt":{"shape":"Timestamp"}, "WorkloadSummary":{"shape":"WorkloadSummary"} }, "documentation":"

A milestone summary return object.

" }, "MinSelectedProfileChoices":{ "type":"integer", "min":0 }, "NextToken":{ "type":"string", "documentation":"

The token to use to retrieve the next set of results.

" }, "Notes":{ "type":"string", "documentation":"

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

", "max":2084 }, "NotificationSummaries":{ "type":"list", "member":{"shape":"NotificationSummary"} }, "NotificationSummary":{ "type":"structure", "members":{ "Type":{ "shape":"NotificationType", "documentation":"

The type of notification.

" }, "LensUpgradeSummary":{ "shape":"LensUpgradeSummary", "documentation":"

Summary of lens upgrade.

" } }, "documentation":"

A notification summary return object.

" }, "NotificationType":{ "type":"string", "enum":[ "LENS_VERSION_UPGRADED", "LENS_VERSION_DEPRECATED" ] }, "OrganizationSharingStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "PermissionType":{ "type":"string", "documentation":"

Permission granted on a share request.

", "enum":[ "READONLY", "CONTRIBUTOR" ] }, "PillarDifference":{ "type":"structure", "members":{ "PillarId":{"shape":"PillarId"}, "PillarName":{"shape":"PillarName"}, "DifferenceStatus":{ "shape":"DifferenceStatus", "documentation":"

Indicates the type of change to the pillar.

" }, "QuestionDifferences":{ "shape":"QuestionDifferences", "documentation":"

List of question differences.

" } }, "documentation":"

A pillar difference return object.

" }, "PillarDifferences":{ "type":"list", "member":{"shape":"PillarDifference"} }, "PillarId":{ "type":"string", "documentation":"

The ID used to identify a pillar, for example, `security`.

A pillar is identified by its PillarReviewSummary$PillarId.

", "max":64, "min":1 }, "PillarMetric":{ "type":"structure", "members":{ "PillarId":{"shape":"PillarId"}, "RiskCounts":{"shape":"RiskCounts"}, "Questions":{ "shape":"QuestionMetrics", "documentation":"

The questions that have been identified as risks in the pillar.

" } }, "documentation":"

A metric for a particular pillar in a lens.

" }, "PillarMetrics":{ "type":"list", "member":{"shape":"PillarMetric"} }, "PillarName":{ "type":"string", "documentation":"

The name of the pillar.

", "max":128, "min":1 }, "PillarNotes":{ "type":"map", "key":{"shape":"PillarId"}, "value":{"shape":"Notes"}, "documentation":"

List of pillar notes of a lens review in a workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

" }, "PillarReviewSummaries":{ "type":"list", "member":{"shape":"PillarReviewSummary"}, "documentation":"

List of pillar review summaries of lens review in a workload.

" }, "PillarReviewSummary":{ "type":"structure", "members":{ "PillarId":{"shape":"PillarId"}, "PillarName":{"shape":"PillarName"}, "Notes":{"shape":"Notes"}, "RiskCounts":{"shape":"RiskCounts"}, "PrioritizedRiskCounts":{"shape":"RiskCounts"} }, "documentation":"

A pillar review summary of a lens review.

" }, "Profile":{ "type":"structure", "members":{ "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

" }, "ProfileVersion":{ "shape":"ProfileVersion", "documentation":"

The profile version.

" }, "ProfileName":{ "shape":"ProfileName", "documentation":"

The profile name.

" }, "ProfileDescription":{ "shape":"ProfileDescription", "documentation":"

The profile description.

" }, "ProfileQuestions":{ "shape":"ProfileQuestions", "documentation":"

Profile questions.

" }, "Owner":{"shape":"AwsAccountId"}, "CreatedAt":{"shape":"Timestamp"}, "UpdatedAt":{"shape":"Timestamp"}, "ShareInvitationId":{ "shape":"ShareInvitationId", "documentation":"

The ID assigned to the share invitation.

" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags assigned to the profile.

" } }, "documentation":"

A profile.

" }, "ProfileArn":{ "type":"string", "max":2084, "pattern":"arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+" }, "ProfileArns":{ "type":"list", "member":{"shape":"ProfileArn"}, "min":1 }, "ProfileChoice":{ "type":"structure", "members":{ "ChoiceId":{"shape":"ChoiceId"}, "ChoiceTitle":{"shape":"ChoiceTitle"}, "ChoiceDescription":{"shape":"ChoiceDescription"} }, "documentation":"

The profile choice.

" }, "ProfileDescription":{ "type":"string", "max":100, "min":3, "pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" }, "ProfileName":{ "type":"string", "max":100, "min":3, "pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" }, "ProfileNamePrefix":{ "type":"string", "max":100, "pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" }, "ProfileNotificationSummaries":{ "type":"list", "member":{"shape":"ProfileNotificationSummary"} }, "ProfileNotificationSummary":{ "type":"structure", "members":{ "CurrentProfileVersion":{ "shape":"ProfileVersion", "documentation":"

The current profile version.

" }, "LatestProfileVersion":{ "shape":"ProfileVersion", "documentation":"

The latest profile version.

" }, "Type":{ "shape":"ProfileNotificationType", "documentation":"

Type of notification.

" }, "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

" }, "ProfileName":{ "shape":"ProfileName", "documentation":"

The profile name.

" }, "WorkloadId":{"shape":"WorkloadId"}, "WorkloadName":{"shape":"WorkloadName"} }, "documentation":"

The profile notification summary.

" }, "ProfileNotificationType":{ "type":"string", "enum":[ "PROFILE_ANSWERS_UPDATED", "PROFILE_DELETED" ] }, "ProfileOwnerType":{ "type":"string", "enum":[ "SELF", "SHARED" ] }, "ProfileQuestion":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "QuestionTitle":{"shape":"QuestionTitle"}, "QuestionDescription":{"shape":"QuestionDescription"}, "QuestionChoices":{ "shape":"ProfileQuestionChoices", "documentation":"

The question choices.

" }, "SelectedChoiceIds":{ "shape":"SelectedChoiceIds", "documentation":"

The selected choices.

" }, "MinSelectedChoices":{ "shape":"MinSelectedProfileChoices", "documentation":"

The minimum number of selected choices.

" }, "MaxSelectedChoices":{ "shape":"MaxSelectedProfileChoices", "documentation":"

The maximum number of selected choices.

" } }, "documentation":"

A profile question.

" }, "ProfileQuestionChoices":{ "type":"list", "member":{"shape":"ProfileChoice"} }, "ProfileQuestionUpdate":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "SelectedChoiceIds":{ "shape":"SelectedProfileChoiceIds", "documentation":"

The selected choices.

" } }, "documentation":"

An update to a profile question.

" }, "ProfileQuestionUpdates":{ "type":"list", "member":{"shape":"ProfileQuestionUpdate"} }, "ProfileQuestions":{ "type":"list", "member":{"shape":"ProfileQuestion"} }, "ProfileShareSummaries":{ "type":"list", "member":{"shape":"ProfileShareSummary"} }, "ProfileShareSummary":{ "type":"structure", "members":{ "ShareId":{"shape":"ShareId"}, "SharedWith":{"shape":"SharedWith"}, "Status":{"shape":"ShareStatus"}, "StatusMessage":{ "shape":"StatusMessage", "documentation":"

Profile share invitation status message.

" } }, "documentation":"

Summary of a profile share.

" }, "ProfileSummaries":{ "type":"list", "member":{"shape":"ProfileSummary"} }, "ProfileSummary":{ "type":"structure", "members":{ "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

" }, "ProfileVersion":{ "shape":"ProfileVersion", "documentation":"

The profile version.

" }, "ProfileName":{ "shape":"ProfileName", "documentation":"

The profile name.

" }, "ProfileDescription":{ "shape":"ProfileDescription", "documentation":"

The profile description.

" }, "Owner":{"shape":"AwsAccountId"}, "CreatedAt":{"shape":"Timestamp"}, "UpdatedAt":{"shape":"Timestamp"} }, "documentation":"

Summary of a profile.

" }, "ProfileTemplate":{ "type":"structure", "members":{ "TemplateName":{ "shape":"ProfileName", "documentation":"

The name of the profile template.

" }, "TemplateQuestions":{ "shape":"TemplateQuestions", "documentation":"

Profile template questions.

" }, "CreatedAt":{"shape":"Timestamp"}, "UpdatedAt":{"shape":"Timestamp"} }, "documentation":"

The profile template.

" }, "ProfileTemplateChoice":{ "type":"structure", "members":{ "ChoiceId":{"shape":"ChoiceId"}, "ChoiceTitle":{"shape":"ChoiceTitle"}, "ChoiceDescription":{"shape":"ChoiceDescription"} }, "documentation":"

A profile template choice.

" }, "ProfileTemplateQuestion":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "QuestionTitle":{"shape":"QuestionTitle"}, "QuestionDescription":{"shape":"QuestionDescription"}, "QuestionChoices":{ "shape":"ProfileTemplateQuestionChoices", "documentation":"

The question choices.

" }, "MinSelectedChoices":{ "shape":"MinSelectedProfileChoices", "documentation":"

The minimum number of choices selected.

" }, "MaxSelectedChoices":{ "shape":"MaxSelectedProfileChoices", "documentation":"

The maximum number of choices selected.

" } }, "documentation":"

A profile template question.

" }, "ProfileTemplateQuestionChoices":{ "type":"list", "member":{"shape":"ProfileTemplateChoice"} }, "ProfileVersion":{ "type":"string", "max":32, "min":1, "pattern":"^[A-Za-z0-9-]+$" }, "Question":{ "type":"string", "enum":[ "UNANSWERED", "ANSWERED" ] }, "QuestionCounts":{ "type":"map", "key":{"shape":"Question"}, "value":{"shape":"Count"} }, "QuestionDescription":{ "type":"string", "documentation":"

The description of the question.

", "max":1024, "min":1 }, "QuestionDifference":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "QuestionTitle":{"shape":"QuestionTitle"}, "DifferenceStatus":{ "shape":"DifferenceStatus", "documentation":"

Indicates the type of change to the question.

" } }, "documentation":"

A question difference return object.

" }, "QuestionDifferences":{ "type":"list", "member":{"shape":"QuestionDifference"} }, "QuestionId":{ "type":"string", "documentation":"

The ID of the question.

", "max":128, "min":1 }, "QuestionMetric":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "Risk":{"shape":"Risk"}, "BestPractices":{ "shape":"BestPractices", "documentation":"

The best practices, or choices, that have been identified as contributing to risk in a question.

" } }, "documentation":"

A metric for a particular question in the pillar.

" }, "QuestionMetrics":{ "type":"list", "member":{"shape":"QuestionMetric"} }, "QuestionPriority":{ "type":"string", "enum":[ "PRIORITIZED", "NONE" ] }, "QuestionTitle":{ "type":"string", "documentation":"

The title of the question.

", "max":512, "min":1 }, "QuestionType":{ "type":"string", "enum":[ "PRIORITIZED", "NON_PRIORITIZED" ] }, "QuotaCode":{ "type":"string", "documentation":"

Service Quotas requirement to identify originating quota.

" }, "ReportFormat":{ "type":"string", "enum":[ "PDF", "JSON" ] }, "ResourceArn":{ "type":"string", "max":250, "min":50, "pattern":"arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\\d:\\d{12}:(review-template)/[a-f0-9]{32}" }, "ResourceNotFoundException":{ "type":"structure", "required":[ "Message", "ResourceId", "ResourceType" ], "members":{ "Message":{"shape":"ExceptionMessage"}, "ResourceId":{"shape":"ExceptionResourceId"}, "ResourceType":{"shape":"ExceptionResourceType"} }, "documentation":"

The requested resource was not found.

", "error":{"httpStatusCode":404}, "exception":true }, "ReviewTemplate":{ "type":"structure", "members":{ "Description":{ "shape":"TemplateDescription", "documentation":"

The review template description.

" }, "Lenses":{ "shape":"ReviewTemplateLenses", "documentation":"

The lenses applied to the review template.

" }, "Notes":{"shape":"Notes"}, "QuestionCounts":{ "shape":"QuestionCounts", "documentation":"

A count of how many total questions are answered and unanswered in the review template.

" }, "Owner":{"shape":"AwsAccountId"}, "UpdatedAt":{"shape":"Timestamp"}, "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" }, "TemplateName":{ "shape":"TemplateName", "documentation":"

The name of the review template.

" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags assigned to the review template.

" }, "UpdateStatus":{ "shape":"ReviewTemplateUpdateStatus", "documentation":"

The latest status of a review template.

" }, "ShareInvitationId":{ "shape":"ShareInvitationId", "documentation":"

The ID assigned to the template share invitation.

" } }, "documentation":"

A review template.

" }, "ReviewTemplateAnswer":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "PillarId":{"shape":"PillarId"}, "QuestionTitle":{"shape":"QuestionTitle"}, "QuestionDescription":{"shape":"QuestionDescription"}, "ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"}, "HelpfulResourceUrl":{"shape":"HelpfulResourceUrl"}, "HelpfulResourceDisplayText":{ "shape":"DisplayText", "documentation":"

The helpful resource text to be displayed for a custom lens.

This field does not apply to Amazon Web Services official lenses.

" }, "Choices":{"shape":"Choices"}, "SelectedChoices":{"shape":"SelectedChoices"}, "ChoiceAnswers":{ "shape":"ChoiceAnswers", "documentation":"

A list of selected choices to a question in your review template.

" }, "IsApplicable":{"shape":"IsApplicable"}, "AnswerStatus":{ "shape":"ReviewTemplateAnswerStatus", "documentation":"

The status of whether or not this question has been answered.

" }, "Notes":{"shape":"Notes"}, "Reason":{ "shape":"AnswerReason", "documentation":"

The reason why the question is not applicable to your review template.

" } }, "documentation":"

An answer of the question.

" }, "ReviewTemplateAnswerStatus":{ "type":"string", "enum":[ "UNANSWERED", "ANSWERED" ] }, "ReviewTemplateAnswerSummaries":{ "type":"list", "member":{"shape":"ReviewTemplateAnswerSummary"} }, "ReviewTemplateAnswerSummary":{ "type":"structure", "members":{ "QuestionId":{"shape":"QuestionId"}, "PillarId":{"shape":"PillarId"}, "QuestionTitle":{"shape":"QuestionTitle"}, "Choices":{"shape":"Choices"}, "SelectedChoices":{"shape":"SelectedChoices"}, "ChoiceAnswerSummaries":{ "shape":"ChoiceAnswerSummaries", "documentation":"

A list of selected choices to a question in the review template.

" }, "IsApplicable":{"shape":"IsApplicable"}, "AnswerStatus":{ "shape":"ReviewTemplateAnswerStatus", "documentation":"

The status of whether or not this question has been answered.

" }, "Reason":{ "shape":"AnswerReason", "documentation":"

The reason why a choice is not-applicable to a question in the review template.

" }, "QuestionType":{ "shape":"QuestionType", "documentation":"

The type of question.

" } }, "documentation":"

The summary of review template answers.

" }, "ReviewTemplateArns":{ "type":"list", "member":{"shape":"TemplateArn"}, "max":1 }, "ReviewTemplateLensAliases":{ "type":"list", "member":{"shape":"LensAlias"}, "max":10, "min":1 }, "ReviewTemplateLensReview":{ "type":"structure", "members":{ "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The lens ARN.

" }, "LensVersion":{ "shape":"LensVersion", "documentation":"

The version of the lens.

" }, "LensName":{"shape":"LensName"}, "LensStatus":{ "shape":"LensStatus", "documentation":"

The status of the lens.

" }, "PillarReviewSummaries":{ "shape":"ReviewTemplatePillarReviewSummaries", "documentation":"

Pillar review summaries of a lens review.

" }, "UpdatedAt":{"shape":"Timestamp"}, "Notes":{"shape":"Notes"}, "QuestionCounts":{ "shape":"QuestionCounts", "documentation":"

A count of how many questions are answered and unanswered in the lens review.

" }, "NextToken":{"shape":"NextToken"} }, "documentation":"

The lens review of a review template.

" }, "ReviewTemplateLenses":{ "type":"list", "member":{"shape":"LensAlias"} }, "ReviewTemplatePillarReviewSummaries":{ "type":"list", "member":{"shape":"ReviewTemplatePillarReviewSummary"} }, "ReviewTemplatePillarReviewSummary":{ "type":"structure", "members":{ "PillarId":{"shape":"PillarId"}, "PillarName":{"shape":"PillarName"}, "Notes":{"shape":"Notes"}, "QuestionCounts":{ "shape":"QuestionCounts", "documentation":"

A count of how many questions are answered and unanswered in the requested pillar of the lens review.

" } }, "documentation":"

Summary of a review template.

" }, "ReviewTemplateSummary":{ "type":"structure", "members":{ "Description":{ "shape":"TemplateDescription", "documentation":"

Description of the review template.

" }, "Lenses":{ "shape":"ReviewTemplateLenses", "documentation":"

Lenses associated with the review template.

" }, "Owner":{"shape":"AwsAccountId"}, "UpdatedAt":{"shape":"Timestamp"}, "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" }, "TemplateName":{ "shape":"TemplateName", "documentation":"

The name of the review template.

" }, "UpdateStatus":{ "shape":"ReviewTemplateUpdateStatus", "documentation":"

The latest status of a review template.

" } }, "documentation":"

Summary of a review template.

" }, "ReviewTemplateUpdateStatus":{ "type":"string", "enum":[ "CURRENT", "LENS_NOT_CURRENT" ] }, "ReviewTemplates":{ "type":"list", "member":{"shape":"ReviewTemplateSummary"} }, "Risk":{ "type":"string", "documentation":"

The risk for a given workload, lens review, pillar, or question.

", "enum":[ "UNANSWERED", "HIGH", "MEDIUM", "NONE", "NOT_APPLICABLE" ] }, "RiskCounts":{ "type":"map", "key":{"shape":"Risk"}, "value":{"shape":"Count"}, "documentation":"

A map from risk names to the count of how many questions have that rating.

" }, "SelectedChoiceIds":{ "type":"list", "member":{"shape":"ChoiceId"} }, "SelectedChoices":{ "type":"list", "member":{"shape":"ChoiceId"}, "documentation":"

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

" }, "SelectedProfileChoiceIds":{ "type":"list", "member":{"shape":"ChoiceId"} }, "ServiceCode":{ "type":"string", "documentation":"

Service Quotas requirement to identify originating service.

" }, "ServiceQuotaExceededException":{ "type":"structure", "required":[ "Message", "QuotaCode", "ServiceCode" ], "members":{ "Message":{"shape":"ExceptionMessage"}, "ResourceId":{"shape":"ExceptionResourceId"}, "ResourceType":{"shape":"ExceptionResourceType"}, "QuotaCode":{"shape":"QuotaCode"}, "ServiceCode":{"shape":"ServiceCode"} }, "documentation":"

The user has reached their resource quota.

", "error":{"httpStatusCode":402}, "exception":true }, "ShareId":{ "type":"string", "documentation":"

The ID associated with the share.

", "pattern":"[0-9a-f]{32}" }, "ShareInvitation":{ "type":"structure", "members":{ "ShareInvitationId":{ "shape":"ShareInvitationId", "documentation":"

The ID assigned to the share invitation.

" }, "ShareResourceType":{ "shape":"ShareResourceType", "documentation":"

The resource type of the share invitation.

" }, "WorkloadId":{"shape":"WorkloadId"}, "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

" }, "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" } }, "documentation":"

The share invitation.

" }, "ShareInvitationAction":{ "type":"string", "documentation":"

Share invitation action taken by contributor.

", "enum":[ "ACCEPT", "REJECT" ] }, "ShareInvitationId":{ "type":"string", "pattern":"[0-9a-f]{32}" }, "ShareInvitationSummaries":{ "type":"list", "member":{"shape":"ShareInvitationSummary"} }, "ShareInvitationSummary":{ "type":"structure", "members":{ "ShareInvitationId":{ "shape":"ShareInvitationId", "documentation":"

The ID assigned to the share invitation.

" }, "SharedBy":{"shape":"AwsAccountId"}, "SharedWith":{"shape":"SharedWith"}, "PermissionType":{"shape":"PermissionType"}, "ShareResourceType":{ "shape":"ShareResourceType", "documentation":"

The resource type of the share invitation.

" }, "WorkloadName":{"shape":"WorkloadName"}, "WorkloadId":{"shape":"WorkloadId"}, "LensName":{"shape":"LensName"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "ProfileName":{ "shape":"ProfileName", "documentation":"

The profile name.

" }, "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

" }, "TemplateName":{ "shape":"TemplateName", "documentation":"

The name of the review template.

" }, "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" } }, "documentation":"

A share invitation summary return object.

" }, "ShareResourceType":{ "type":"string", "enum":[ "WORKLOAD", "LENS", "PROFILE", "TEMPLATE" ] }, "ShareStatus":{ "type":"string", "documentation":"

The status of the share request.

", "enum":[ "ACCEPTED", "REJECTED", "PENDING", "REVOKED", "EXPIRED", "ASSOCIATING", "ASSOCIATED", "FAILED" ] }, "SharedWith":{ "type":"string", "documentation":"

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

", "max":2048, "min":12 }, "SharedWithPrefix":{ "type":"string", "max":100 }, "StatusMessage":{ "type":"string", "max":512, "min":1 }, "TagKey":{ "type":"string", "max":128, "min":1 }, "TagKeyList":{ "type":"list", "member":{"shape":"TagKey"}, "max":50, "min":1 }, "TagMap":{ "type":"map", "key":{"shape":"TagKey"}, "value":{"shape":"TagValue"}, "max":50, "min":1 }, "TagResourceInput":{ "type":"structure", "required":[ "WorkloadArn", "Tags" ], "members":{ "WorkloadArn":{ "shape":"WorkloadArn", "location":"uri", "locationName":"WorkloadArn" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags for the resource.

" } } }, "TagResourceOutput":{ "type":"structure", "members":{ } }, "TagValue":{ "type":"string", "max":256, "min":0 }, "TemplateArn":{ "type":"string", "max":250, "min":50, "pattern":"arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\\d:\\d{12}:(review-template)/[a-f0-9]{32}" }, "TemplateDescription":{ "type":"string", "max":250, "min":3, "pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" }, "TemplateName":{ "type":"string", "max":100, "min":3, "pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" }, "TemplateNamePrefix":{ "type":"string", "max":100, "pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$" }, "TemplateQuestions":{ "type":"list", "member":{"shape":"ProfileTemplateQuestion"} }, "TemplateShareSummaries":{ "type":"list", "member":{"shape":"TemplateShareSummary"} }, "TemplateShareSummary":{ "type":"structure", "members":{ "ShareId":{"shape":"ShareId"}, "SharedWith":{"shape":"SharedWith"}, "Status":{"shape":"ShareStatus"}, "StatusMessage":{ "shape":"StatusMessage", "documentation":"

Review template share invitation status message.

" } }, "documentation":"

Summary of a review template share.

" }, "ThrottlingException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"ExceptionMessage"}, "QuotaCode":{"shape":"QuotaCode"}, "ServiceCode":{"shape":"ServiceCode"} }, "documentation":"

Request was denied due to request throttling.

", "error":{"httpStatusCode":429}, "exception":true }, "Timestamp":{ "type":"timestamp", "documentation":"

The date and time recorded.

" }, "TrustedAdvisorIntegrationStatus":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "UntagResourceInput":{ "type":"structure", "required":[ "WorkloadArn", "TagKeys" ], "members":{ "WorkloadArn":{ "shape":"WorkloadArn", "location":"uri", "locationName":"WorkloadArn" }, "TagKeys":{ "shape":"TagKeyList", "documentation":"

A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.

", "location":"querystring", "locationName":"tagKeys" } } }, "UntagResourceOutput":{ "type":"structure", "members":{ } }, "UpdateAnswerInput":{ "type":"structure", "required":[ "WorkloadId", "LensAlias", "QuestionId" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "QuestionId":{ "shape":"QuestionId", "location":"uri", "locationName":"QuestionId" }, "SelectedChoices":{"shape":"SelectedChoices"}, "ChoiceUpdates":{ "shape":"ChoiceUpdates", "documentation":"

A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.

" }, "Notes":{"shape":"Notes"}, "IsApplicable":{"shape":"IsApplicable"}, "Reason":{ "shape":"AnswerReason", "documentation":"

The reason why a question is not applicable to your workload.

" } }, "documentation":"

Input to update answer.

" }, "UpdateAnswerOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "LensAlias":{"shape":"LensAlias"}, "LensArn":{ "shape":"LensArn", "documentation":"

The ARN for the lens.

" }, "Answer":{"shape":"Answer"} }, "documentation":"

Output of a update answer call.

" }, "UpdateGlobalSettingsInput":{ "type":"structure", "members":{ "OrganizationSharingStatus":{ "shape":"OrganizationSharingStatus", "documentation":"

The status of organization sharing settings.

" }, "DiscoveryIntegrationStatus":{ "shape":"DiscoveryIntegrationStatus", "documentation":"

The status of discovery support settings.

" } } }, "UpdateLensReviewInput":{ "type":"structure", "required":[ "WorkloadId", "LensAlias" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "LensNotes":{"shape":"Notes"}, "PillarNotes":{"shape":"PillarNotes"} }, "documentation":"

Input for update lens review.

" }, "UpdateLensReviewOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "LensReview":{"shape":"LensReview"} }, "documentation":"

Output of a update lens review call.

" }, "UpdateProfileInput":{ "type":"structure", "required":["ProfileArn"], "members":{ "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

", "location":"uri", "locationName":"ProfileArn" }, "ProfileDescription":{ "shape":"ProfileDescription", "documentation":"

The profile description.

" }, "ProfileQuestions":{ "shape":"ProfileQuestionUpdates", "documentation":"

Profile questions.

" } } }, "UpdateProfileOutput":{ "type":"structure", "members":{ "Profile":{ "shape":"Profile", "documentation":"

The profile.

" } } }, "UpdateReviewTemplateAnswerInput":{ "type":"structure", "required":[ "TemplateArn", "LensAlias", "QuestionId" ], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "QuestionId":{ "shape":"QuestionId", "location":"uri", "locationName":"QuestionId" }, "SelectedChoices":{"shape":"SelectedChoices"}, "ChoiceUpdates":{ "shape":"ChoiceUpdates", "documentation":"

A list of choices to be updated.

" }, "Notes":{"shape":"Notes"}, "IsApplicable":{"shape":"IsApplicable"}, "Reason":{ "shape":"AnswerReason", "documentation":"

The update reason.

" } } }, "UpdateReviewTemplateAnswerOutput":{ "type":"structure", "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" }, "LensAlias":{"shape":"LensAlias"}, "Answer":{ "shape":"ReviewTemplateAnswer", "documentation":"

An answer of the question.

" } } }, "UpdateReviewTemplateInput":{ "type":"structure", "required":["TemplateArn"], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" }, "TemplateName":{ "shape":"TemplateName", "documentation":"

The review template name.

" }, "Description":{ "shape":"TemplateDescription", "documentation":"

The review template description.

" }, "Notes":{"shape":"Notes"}, "LensesToAssociate":{ "shape":"ReviewTemplateLensAliases", "documentation":"

A list of lens aliases or ARNs to apply to the review template.

" }, "LensesToDisassociate":{ "shape":"ReviewTemplateLensAliases", "documentation":"

A list of lens aliases or ARNs to unapply to the review template. The `wellarchitected` lens cannot be unapplied.

" } } }, "UpdateReviewTemplateLensReviewInput":{ "type":"structure", "required":[ "TemplateArn", "LensAlias" ], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

", "location":"uri", "locationName":"TemplateArn" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "LensNotes":{"shape":"Notes"}, "PillarNotes":{"shape":"PillarNotes"} } }, "UpdateReviewTemplateLensReviewOutput":{ "type":"structure", "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The review template ARN.

" }, "LensReview":{ "shape":"ReviewTemplateLensReview", "documentation":"

A lens review of a question.

" } } }, "UpdateReviewTemplateOutput":{ "type":"structure", "members":{ "ReviewTemplate":{ "shape":"ReviewTemplate", "documentation":"

A review template.

" } } }, "UpdateShareInvitationInput":{ "type":"structure", "required":[ "ShareInvitationId", "ShareInvitationAction" ], "members":{ "ShareInvitationId":{ "shape":"ShareInvitationId", "documentation":"

The ID assigned to the share invitation.

", "location":"uri", "locationName":"ShareInvitationId" }, "ShareInvitationAction":{"shape":"ShareInvitationAction"} }, "documentation":"

Input for Update Share Invitation

" }, "UpdateShareInvitationOutput":{ "type":"structure", "members":{ "ShareInvitation":{ "shape":"ShareInvitation", "documentation":"

The updated workload or custom lens share invitation.

" } } }, "UpdateWorkloadInput":{ "type":"structure", "required":["WorkloadId"], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "WorkloadName":{"shape":"WorkloadName"}, "Description":{"shape":"WorkloadDescription"}, "Environment":{"shape":"WorkloadEnvironment"}, "AccountIds":{"shape":"WorkloadAccountIds"}, "AwsRegions":{"shape":"WorkloadAwsRegions"}, "NonAwsRegions":{"shape":"WorkloadNonAwsRegions"}, "PillarPriorities":{"shape":"WorkloadPillarPriorities"}, "ArchitecturalDesign":{"shape":"WorkloadArchitecturalDesign"}, "ReviewOwner":{"shape":"WorkloadReviewOwner"}, "IsReviewOwnerUpdateAcknowledged":{ "shape":"IsReviewOwnerUpdateAcknowledged", "documentation":"

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":{"shape":"WorkloadIndustryType"}, "Industry":{"shape":"WorkloadIndustry"}, "Notes":{"shape":"Notes"}, "ImprovementStatus":{"shape":"WorkloadImprovementStatus"}, "DiscoveryConfig":{ "shape":"WorkloadDiscoveryConfig", "documentation":"

Well-Architected discovery configuration settings to associate to the workload.

" }, "Applications":{ "shape":"WorkloadApplications", "documentation":"

List of AppRegistry application ARNs to associate to the workload.

" } }, "documentation":"

Input to update a workload.

" }, "UpdateWorkloadOutput":{ "type":"structure", "members":{ "Workload":{"shape":"Workload"} }, "documentation":"

Output of an update workload call.

" }, "UpdateWorkloadShareInput":{ "type":"structure", "required":[ "ShareId", "WorkloadId", "PermissionType" ], "members":{ "ShareId":{ "shape":"ShareId", "location":"uri", "locationName":"ShareId" }, "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "PermissionType":{"shape":"PermissionType"} }, "documentation":"

Input for Update Workload Share

" }, "UpdateWorkloadShareOutput":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "WorkloadShare":{"shape":"WorkloadShare"} }, "documentation":"

Input for Update Workload Share

" }, "UpgradeLensReviewInput":{ "type":"structure", "required":[ "WorkloadId", "LensAlias", "MilestoneName" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "MilestoneName":{"shape":"MilestoneName"}, "ClientRequestToken":{"shape":"ClientRequestToken"} } }, "UpgradeProfileVersionInput":{ "type":"structure", "required":[ "WorkloadId", "ProfileArn" ], "members":{ "WorkloadId":{ "shape":"WorkloadId", "location":"uri", "locationName":"WorkloadId" }, "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

", "location":"uri", "locationName":"ProfileArn" }, "MilestoneName":{"shape":"MilestoneName"}, "ClientRequestToken":{ "shape":"ClientRequestToken", "idempotencyToken":true } } }, "UpgradeReviewTemplateLensReviewInput":{ "type":"structure", "required":[ "TemplateArn", "LensAlias" ], "members":{ "TemplateArn":{ "shape":"TemplateArn", "documentation":"

The ARN of the review template.

", "location":"uri", "locationName":"TemplateArn" }, "LensAlias":{ "shape":"LensAlias", "location":"uri", "locationName":"LensAlias" }, "ClientRequestToken":{"shape":"ClientRequestToken"} } }, "Urls":{ "type":"list", "member":{"shape":"ChoiceContent"} }, "ValidationException":{ "type":"structure", "required":["Message"], "members":{ "Message":{"shape":"ExceptionMessage"}, "Reason":{"shape":"ValidationExceptionReason"}, "Fields":{"shape":"ValidationExceptionFieldList"} }, "documentation":"

The user input is not valid.

", "error":{"httpStatusCode":400}, "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "Name", "Message" ], "members":{ "Name":{"shape":"ValidationExceptionFieldName"}, "Message":{"shape":"ExceptionMessage"} }, "documentation":"

Stores information about a field passed inside a request that resulted in an exception.

" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"}, "documentation":"

The fields that caused the error, if applicable.

" }, "ValidationExceptionFieldName":{ "type":"string", "documentation":"

The field name for which validation failed.

" }, "ValidationExceptionReason":{ "type":"string", "documentation":"

The reason why the request failed validation.

", "enum":[ "UNKNOWN_OPERATION", "CANNOT_PARSE", "FIELD_VALIDATION_FAILED", "OTHER" ] }, "VersionDifferences":{ "type":"structure", "members":{ "PillarDifferences":{ "shape":"PillarDifferences", "documentation":"

The differences between the base and latest versions of the lens.

" } }, "documentation":"

The differences between the base and latest versions of the lens.

" }, "Workload":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "WorkloadArn":{"shape":"WorkloadArn"}, "WorkloadName":{"shape":"WorkloadName"}, "Description":{"shape":"WorkloadDescription"}, "Environment":{"shape":"WorkloadEnvironment"}, "UpdatedAt":{"shape":"Timestamp"}, "AccountIds":{"shape":"WorkloadAccountIds"}, "AwsRegions":{"shape":"WorkloadAwsRegions"}, "NonAwsRegions":{"shape":"WorkloadNonAwsRegions"}, "ArchitecturalDesign":{"shape":"WorkloadArchitecturalDesign"}, "ReviewOwner":{"shape":"WorkloadReviewOwner"}, "ReviewRestrictionDate":{"shape":"Timestamp"}, "IsReviewOwnerUpdateAcknowledged":{ "shape":"IsReviewOwnerUpdateAcknowledged", "documentation":"

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":{"shape":"WorkloadIndustryType"}, "Industry":{"shape":"WorkloadIndustry"}, "Notes":{"shape":"Notes"}, "ImprovementStatus":{"shape":"WorkloadImprovementStatus"}, "RiskCounts":{"shape":"RiskCounts"}, "PillarPriorities":{"shape":"WorkloadPillarPriorities"}, "Lenses":{"shape":"WorkloadLenses"}, "Owner":{"shape":"AwsAccountId"}, "ShareInvitationId":{ "shape":"ShareInvitationId", "documentation":"

The ID assigned to the share invitation.

" }, "Tags":{ "shape":"TagMap", "documentation":"

The tags associated with the workload.

" }, "DiscoveryConfig":{ "shape":"WorkloadDiscoveryConfig", "documentation":"

Discovery configuration associated to the workload.

" }, "Applications":{ "shape":"WorkloadApplications", "documentation":"

List of AppRegistry application ARNs associated to the workload.

" }, "Profiles":{ "shape":"WorkloadProfiles", "documentation":"

Profile associated with a workload.

" }, "PrioritizedRiskCounts":{"shape":"RiskCounts"} }, "documentation":"

A workload return object.

" }, "WorkloadAccountIds":{ "type":"list", "member":{"shape":"AwsAccountId"}, "documentation":"

The list of Amazon Web Services account IDs associated with the workload.

", "max":100 }, "WorkloadApplications":{ "type":"list", "member":{"shape":"ApplicationArn"}, "max":1 }, "WorkloadArchitecturalDesign":{ "type":"string", "documentation":"

The URL of the architectural design for the workload.

", "max":2048, "pattern":"^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$" }, "WorkloadArn":{ "type":"string", "documentation":"

The ARN for the workload.

" }, "WorkloadAwsRegions":{ "type":"list", "member":{"shape":"AwsRegion"}, "documentation":"

The list of Amazon Web Services Regions associated with the workload, for example, `us-east-2`, or `ca-central-1`.

", "max":50 }, "WorkloadDescription":{ "type":"string", "documentation":"

The description for the workload.

", "max":250, "min":3 }, "WorkloadDiscoveryConfig":{ "type":"structure", "members":{ "TrustedAdvisorIntegrationStatus":{ "shape":"TrustedAdvisorIntegrationStatus", "documentation":"

Discovery integration status in respect to Trusted Advisor for the workload.

" }, "WorkloadResourceDefinition":{ "shape":"WorkloadResourceDefinition", "documentation":"

The mode to use for identifying resources associated with the workload.

You can specify `WORKLOAD_METADATA`, `APP_REGISTRY`, or both.

" } }, "documentation":"

Discovery configuration associated to the workload.

" }, "WorkloadEnvironment":{ "type":"string", "documentation":"

The environment for the workload.

", "enum":[ "PRODUCTION", "PREPRODUCTION" ] }, "WorkloadId":{ "type":"string", "documentation":"

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

", "max":32, "min":32, "pattern":"[0-9a-f]{32}" }, "WorkloadImprovementStatus":{ "type":"string", "documentation":"

The improvement status for a workload.

", "enum":[ "NOT_APPLICABLE", "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "RISK_ACKNOWLEDGED" ] }, "WorkloadIndustry":{ "type":"string", "documentation":"

The industry for the workload.

", "max":100 }, "WorkloadIndustryType":{ "type":"string", "documentation":"

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`

", "max":100 }, "WorkloadLenses":{ "type":"list", "member":{"shape":"LensAlias"}, "documentation":"

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

" }, "WorkloadName":{ "type":"string", "documentation":"

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.

", "max":100, "min":3 }, "WorkloadNamePrefix":{ "type":"string", "documentation":"

An optional string added to the beginning of each workload name returned in the results.

", "max":100 }, "WorkloadNonAwsRegion":{ "type":"string", "max":25, "min":3 }, "WorkloadNonAwsRegions":{ "type":"list", "member":{"shape":"WorkloadNonAwsRegion"}, "documentation":"

The list of non-Amazon Web Services Regions associated with the workload.

", "max":5 }, "WorkloadPillarPriorities":{ "type":"list", "member":{"shape":"PillarId"}, "documentation":"

The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

" }, "WorkloadProfile":{ "type":"structure", "members":{ "ProfileArn":{ "shape":"ProfileArn", "documentation":"

The profile ARN.

" }, "ProfileVersion":{ "shape":"ProfileVersion", "documentation":"

The profile version.

" } }, "documentation":"

The profile associated with a workload.

" }, "WorkloadProfileArns":{ "type":"list", "member":{"shape":"ProfileArn"}, "max":1 }, "WorkloadProfiles":{ "type":"list", "member":{"shape":"WorkloadProfile"}, "max":1 }, "WorkloadResourceDefinition":{ "type":"list", "member":{"shape":"DefinitionType"} }, "WorkloadReviewOwner":{ "type":"string", "documentation":"

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

", "max":255, "min":3 }, "WorkloadShare":{ "type":"structure", "members":{ "ShareId":{"shape":"ShareId"}, "SharedBy":{"shape":"AwsAccountId"}, "SharedWith":{"shape":"SharedWith"}, "PermissionType":{"shape":"PermissionType"}, "Status":{"shape":"ShareStatus"}, "WorkloadName":{"shape":"WorkloadName"}, "WorkloadId":{"shape":"WorkloadId"} }, "documentation":"

A workload share return object.

" }, "WorkloadShareSummaries":{ "type":"list", "member":{"shape":"WorkloadShareSummary"}, "documentation":"

A list of workload share summaries.

" }, "WorkloadShareSummary":{ "type":"structure", "members":{ "ShareId":{"shape":"ShareId"}, "SharedWith":{"shape":"SharedWith"}, "PermissionType":{"shape":"PermissionType"}, "Status":{"shape":"ShareStatus"}, "StatusMessage":{ "shape":"StatusMessage", "documentation":"

Optional message to compliment the Status field.

" } }, "documentation":"

A workload share summary return object.

" }, "WorkloadSummaries":{ "type":"list", "member":{"shape":"WorkloadSummary"}, "documentation":"

A list of workload summaries.

" }, "WorkloadSummary":{ "type":"structure", "members":{ "WorkloadId":{"shape":"WorkloadId"}, "WorkloadArn":{"shape":"WorkloadArn"}, "WorkloadName":{"shape":"WorkloadName"}, "Owner":{"shape":"AwsAccountId"}, "UpdatedAt":{"shape":"Timestamp"}, "Lenses":{"shape":"WorkloadLenses"}, "RiskCounts":{"shape":"RiskCounts"}, "ImprovementStatus":{"shape":"WorkloadImprovementStatus"}, "Profiles":{ "shape":"WorkloadProfiles", "documentation":"

Profile associated with a workload.

" }, "PrioritizedRiskCounts":{"shape":"RiskCounts"} }, "documentation":"

A workload summary return object.

" } }, "documentation":"Well-Architected Tool

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.

" }