3522 lines
115 KiB
JSON
3522 lines
115 KiB
JSON
{
|
|
"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":"<p>Associate a lens to a workload.</p> <p>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.</p> <note> <p> <b>Disclaimer</b> </p> <p>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. </p> </note>"
|
|
},
|
|
"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":"<p>Create a lens share.</p> <p>The owner of a lens can share it with other Amazon Web Services accounts, IAM users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted.</p> <note> <p> <b>Disclaimer</b> </p> <p>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.</p> </note>"
|
|
},
|
|
"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":"<p>Create a new lens version.</p> <p>A lens can have up to 100 versions.</p> <p>After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it. </p>"
|
|
},
|
|
"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":"<p>Create a milestone for an existing workload.</p>"
|
|
},
|
|
"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":"ThrottlingException"}
|
|
],
|
|
"documentation":"<p>Create a new workload.</p> <p>The owner of a workload can share the workload with other Amazon Web Services accounts, IAM users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html\">Defining a Workload</a> in the <i>Well-Architected Tool User Guide</i>.</p>"
|
|
},
|
|
"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":"<p>Create a workload share.</p> <p>The owner of a workload can share it with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html\">Sharing a Workload</a> in the <i>Well-Architected Tool User Guide</i>.</p>"
|
|
},
|
|
"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":"<p>Delete an existing lens.</p> <p>Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM 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. </p> <note> <p> <b>Disclaimer</b> </p> <p>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.</p> </note>"
|
|
},
|
|
"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":"<p>Delete a lens share.</p> <p>After the lens share is deleted, Amazon Web Services accounts, IAM 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.</p> <note> <p> <b>Disclaimer</b> </p> <p>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.</p> </note>"
|
|
},
|
|
"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":"<p>Delete an existing workload.</p>"
|
|
},
|
|
"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":"<p>Delete a workload share.</p>"
|
|
},
|
|
"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":"<p>Disassociate a lens from a workload.</p> <p>Up to 10 lenses can be disassociated from a workload in a single API operation.</p> <note> <p>The Amazon Web Services Well-Architected Framework lens (<code>wellarchitected</code>) cannot be removed from a workload.</p> </note>"
|
|
},
|
|
"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":"<p>Export an existing lens.</p> <p>Lenses are defined in JSON. For more information, see <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html\">JSON format specification</a> in the <i>Well-Architected Tool User Guide</i>. Only the owner of a lens can export it. </p> <note> <p> <b>Disclaimer</b> </p> <p>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.</p> </note>"
|
|
},
|
|
"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":"<p>Get the answer to a specific question in a workload review.</p>"
|
|
},
|
|
"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":"<p>Get an existing lens.</p>"
|
|
},
|
|
"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":"<p>Get lens review.</p>"
|
|
},
|
|
"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":"<p>Get lens review report.</p>"
|
|
},
|
|
"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":"<p>Get lens version differences.</p>"
|
|
},
|
|
"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":"<p>Get a milestone for an existing workload.</p>"
|
|
},
|
|
"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":"<p>Get an existing workload.</p>"
|
|
},
|
|
"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":"<p>Import a new lens.</p> <p>The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with <a>CreateLensVersion</a> </p> <p>Lenses are defined in JSON. For more information, see <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html\">JSON format specification</a> in the <i>Well-Architected Tool User Guide</i>.</p> <p>A custom lens cannot exceed 500 KB in size.</p> <note> <p> <b>Disclaimer</b> </p> <p>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.</p> </note>"
|
|
},
|
|
"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":"<p>List of answers.</p>"
|
|
},
|
|
"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":"<p>List of Trusted Advisor check details by account related to the workload.</p>"
|
|
},
|
|
"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":"<p>List of Trusted Advisor checks summarized for all accounts related to the workload.</p>"
|
|
},
|
|
"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":"<p>List lens review improvements.</p>"
|
|
},
|
|
"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":"<p>List lens reviews.</p>"
|
|
},
|
|
"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":"<p>List the lens shares associated with the lens.</p>"
|
|
},
|
|
"ListLenses":{
|
|
"name":"ListLenses",
|
|
"http":{
|
|
"method":"GET",
|
|
"requestUri":"/lenses"
|
|
},
|
|
"input":{"shape":"ListLensesInput"},
|
|
"output":{"shape":"ListLensesOutput"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"AccessDeniedException"},
|
|
{"shape":"ThrottlingException"}
|
|
],
|
|
"documentation":"<p>List the available lenses.</p>"
|
|
},
|
|
"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":"<p>List all milestones for an existing workload.</p>"
|
|
},
|
|
"ListNotifications":{
|
|
"name":"ListNotifications",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/notifications"
|
|
},
|
|
"input":{"shape":"ListNotificationsInput"},
|
|
"output":{"shape":"ListNotificationsOutput"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"AccessDeniedException"},
|
|
{"shape":"ThrottlingException"}
|
|
],
|
|
"documentation":"<p>List lens notifications.</p>"
|
|
},
|
|
"ListShareInvitations":{
|
|
"name":"ListShareInvitations",
|
|
"http":{
|
|
"method":"GET",
|
|
"requestUri":"/shareInvitations"
|
|
},
|
|
"input":{"shape":"ListShareInvitationsInput"},
|
|
"output":{"shape":"ListShareInvitationsOutput"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"AccessDeniedException"},
|
|
{"shape":"ThrottlingException"}
|
|
],
|
|
"documentation":"<p>List the workload invitations.</p>"
|
|
},
|
|
"ListTagsForResource":{
|
|
"name":"ListTagsForResource",
|
|
"http":{
|
|
"method":"GET",
|
|
"requestUri":"/tags/{WorkloadArn}"
|
|
},
|
|
"input":{"shape":"ListTagsForResourceInput"},
|
|
"output":{"shape":"ListTagsForResourceOutput"},
|
|
"errors":[
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ResourceNotFoundException"}
|
|
],
|
|
"documentation":"<p>List the tags for a resource.</p> <note> <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p> </note>"
|
|
},
|
|
"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":"<p>List the workload shares associated with the workload.</p>"
|
|
},
|
|
"ListWorkloads":{
|
|
"name":"ListWorkloads",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/workloadsSummaries"
|
|
},
|
|
"input":{"shape":"ListWorkloadsInput"},
|
|
"output":{"shape":"ListWorkloadsOutput"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"AccessDeniedException"},
|
|
{"shape":"ThrottlingException"}
|
|
],
|
|
"documentation":"<p>List workloads. Paginated.</p>"
|
|
},
|
|
"TagResource":{
|
|
"name":"TagResource",
|
|
"http":{
|
|
"method":"POST",
|
|
"requestUri":"/tags/{WorkloadArn}"
|
|
},
|
|
"input":{"shape":"TagResourceInput"},
|
|
"output":{"shape":"TagResourceOutput"},
|
|
"errors":[
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ResourceNotFoundException"}
|
|
],
|
|
"documentation":"<p>Adds one or more tags to the specified resource.</p> <note> <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p> </note>"
|
|
},
|
|
"UntagResource":{
|
|
"name":"UntagResource",
|
|
"http":{
|
|
"method":"DELETE",
|
|
"requestUri":"/tags/{WorkloadArn}"
|
|
},
|
|
"input":{"shape":"UntagResourceInput"},
|
|
"output":{"shape":"UntagResourceOutput"},
|
|
"errors":[
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"ResourceNotFoundException"}
|
|
],
|
|
"documentation":"<p>Deletes specified tags from a resource.</p> <note> <p>The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.</p> </note> <p>To specify multiple tags, use separate <b>tagKeys</b> parameters, for example:</p> <p> <code>DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2</code> </p>"
|
|
},
|
|
"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":"<p>Update the answer to a specific question in a workload review.</p>"
|
|
},
|
|
"UpdateGlobalSettings":{
|
|
"name":"UpdateGlobalSettings",
|
|
"http":{
|
|
"method":"PATCH",
|
|
"requestUri":"/global-settings"
|
|
},
|
|
"input":{"shape":"UpdateGlobalSettingsInput"},
|
|
"errors":[
|
|
{"shape":"ValidationException"},
|
|
{"shape":"ConflictException"},
|
|
{"shape":"InternalServerException"},
|
|
{"shape":"AccessDeniedException"},
|
|
{"shape":"ThrottlingException"}
|
|
],
|
|
"documentation":"<p>Updates whether the Amazon Web Services account is opted into organization sharing features.</p>"
|
|
},
|
|
"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":"<p>Update lens review.</p>"
|
|
},
|
|
"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":"<p>Update a workload or custom lens share invitation.</p> <note> <p>This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.</p> </note>"
|
|
},
|
|
"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":"<p>Update an existing workload.</p>"
|
|
},
|
|
"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":"<p>Update a workload share.</p>"
|
|
},
|
|
"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":"<p>Upgrade lens review.</p>"
|
|
}
|
|
},
|
|
"shapes":{
|
|
"AccessDeniedException":{
|
|
"type":"structure",
|
|
"required":["Message"],
|
|
"members":{
|
|
"Message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>User does not have sufficient access to perform this action.</p>",
|
|
"error":{"httpStatusCode":403},
|
|
"exception":true
|
|
},
|
|
"AccountSummary":{
|
|
"type":"map",
|
|
"key":{"shape":"CheckStatus"},
|
|
"value":{"shape":"CheckStatusCount"},
|
|
"documentation":"<p>Account summary for a Well-Architected best practice in relation to Trusted Advisor checks.</p>"
|
|
},
|
|
"AdditionalResourceType":{
|
|
"type":"string",
|
|
"enum":[
|
|
"HELPFUL_RESOURCE",
|
|
"IMPROVEMENT_PLAN"
|
|
]
|
|
},
|
|
"AdditionalResources":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Type":{
|
|
"shape":"AdditionalResourceType",
|
|
"documentation":"<p>Type of additional resource.</p>"
|
|
},
|
|
"Content":{
|
|
"shape":"Urls",
|
|
"documentation":"<p>The URLs for additional resources, either helpful resources or improvement plans. Up to five additional URLs can be specified.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The choice level additional resources.</p>"
|
|
},
|
|
"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":"<p>The helpful resource text to be displayed.</p>"
|
|
},
|
|
"Choices":{"shape":"Choices"},
|
|
"SelectedChoices":{"shape":"SelectedChoices"},
|
|
"ChoiceAnswers":{
|
|
"shape":"ChoiceAnswers",
|
|
"documentation":"<p>A list of selected choices to a question in your workload.</p>"
|
|
},
|
|
"IsApplicable":{"shape":"IsApplicable"},
|
|
"Risk":{"shape":"Risk"},
|
|
"Notes":{"shape":"Notes"},
|
|
"Reason":{
|
|
"shape":"AnswerReason",
|
|
"documentation":"<p>The reason why the question is not applicable to your workload.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An answer of the question.</p>"
|
|
},
|
|
"AnswerReason":{
|
|
"type":"string",
|
|
"enum":[
|
|
"OUT_OF_SCOPE",
|
|
"BUSINESS_PRIORITIES",
|
|
"ARCHITECTURE_CONSTRAINTS",
|
|
"OTHER",
|
|
"NONE"
|
|
]
|
|
},
|
|
"AnswerSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"AnswerSummary"},
|
|
"documentation":"<p>List of answer summaries of lens review in a workload.</p>"
|
|
},
|
|
"AnswerSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"QuestionId":{"shape":"QuestionId"},
|
|
"PillarId":{"shape":"PillarId"},
|
|
"QuestionTitle":{"shape":"QuestionTitle"},
|
|
"Choices":{"shape":"Choices"},
|
|
"SelectedChoices":{"shape":"SelectedChoices"},
|
|
"ChoiceAnswerSummaries":{
|
|
"shape":"ChoiceAnswerSummaries",
|
|
"documentation":"<p>A list of selected choices to a question in your workload.</p>"
|
|
},
|
|
"IsApplicable":{"shape":"IsApplicable"},
|
|
"Risk":{"shape":"Risk"},
|
|
"Reason":{
|
|
"shape":"AnswerReason",
|
|
"documentation":"<p>The reason why a choice is non-applicable to a question in your workload.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An answer summary of a lens review in a workload.</p>"
|
|
},
|
|
"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":"<p>Input to associate lens reviews.</p>"
|
|
},
|
|
"AwsAccountId":{
|
|
"type":"string",
|
|
"documentation":"<p>An Amazon Web Services account ID.</p>",
|
|
"pattern":"[0-9]{12}"
|
|
},
|
|
"AwsRegion":{
|
|
"type":"string",
|
|
"documentation":"<p>An Amazon Web Services Region, for example, <code>us-west-2</code> or <code>ap-northeast-1</code>.</p>",
|
|
"max":100
|
|
},
|
|
"Base64String":{
|
|
"type":"string",
|
|
"documentation":"<p>The Base64-encoded string representation of a lens review report.</p> <p>This data can be used to create a PDF file.</p>"
|
|
},
|
|
"CheckDescription":{"type":"string"},
|
|
"CheckDetail":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Id":{
|
|
"shape":"CheckId",
|
|
"documentation":"<p>Trusted Advisor check ID.</p>"
|
|
},
|
|
"Name":{
|
|
"shape":"CheckName",
|
|
"documentation":"<p>Trusted Advisor check name.</p>"
|
|
},
|
|
"Description":{
|
|
"shape":"CheckDescription",
|
|
"documentation":"<p>Trusted Advisor check description.</p>"
|
|
},
|
|
"Provider":{
|
|
"shape":"CheckProvider",
|
|
"documentation":"<p>Provider of the check related to the best practice.</p>"
|
|
},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>Well-Architected Lens ARN associated to the check.</p>"
|
|
},
|
|
"PillarId":{"shape":"PillarId"},
|
|
"QuestionId":{"shape":"QuestionId"},
|
|
"ChoiceId":{"shape":"ChoiceId"},
|
|
"Status":{
|
|
"shape":"CheckStatus",
|
|
"documentation":"<p>Status associated to the check.</p>"
|
|
},
|
|
"AccountId":{"shape":"AwsAccountId"},
|
|
"FlaggedResources":{
|
|
"shape":"FlaggedResources",
|
|
"documentation":"<p>Count of flagged resources associated to the check.</p>"
|
|
},
|
|
"Reason":{
|
|
"shape":"CheckFailureReason",
|
|
"documentation":"<p>Reason associated to the check.</p>"
|
|
},
|
|
"UpdatedAt":{"shape":"Timestamp"}
|
|
},
|
|
"documentation":"<p>Account details for a Well-Architected best practice in relation to Trusted Advisor checks.</p>"
|
|
},
|
|
"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":"<p>Trusted Advisor check ID.</p>"
|
|
},
|
|
"Name":{
|
|
"shape":"CheckName",
|
|
"documentation":"<p>Trusted Advisor check name.</p>"
|
|
},
|
|
"Provider":{
|
|
"shape":"CheckProvider",
|
|
"documentation":"<p>Provider of the check related to the best practice.</p>"
|
|
},
|
|
"Description":{
|
|
"shape":"CheckDescription",
|
|
"documentation":"<p>Trusted Advisor check description.</p>"
|
|
},
|
|
"UpdatedAt":{"shape":"Timestamp"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>Well-Architected Lens ARN associated to the check.</p>"
|
|
},
|
|
"PillarId":{"shape":"PillarId"},
|
|
"QuestionId":{"shape":"QuestionId"},
|
|
"ChoiceId":{"shape":"ChoiceId"},
|
|
"Status":{
|
|
"shape":"CheckStatus",
|
|
"documentation":"<p>Status associated to the check.</p>"
|
|
},
|
|
"AccountSummary":{
|
|
"shape":"AccountSummary",
|
|
"documentation":"<p>Account summary associated to the check.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Trusted Advisor check summary.</p>"
|
|
},
|
|
"Choice":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ChoiceId":{"shape":"ChoiceId"},
|
|
"Title":{"shape":"ChoiceTitle"},
|
|
"Description":{"shape":"ChoiceDescription"},
|
|
"HelpfulResource":{
|
|
"shape":"ChoiceContent",
|
|
"documentation":"<p>The choice level helpful resource.</p>"
|
|
},
|
|
"ImprovementPlan":{
|
|
"shape":"ChoiceContent",
|
|
"documentation":"<p>The choice level improvement plan.</p>"
|
|
},
|
|
"AdditionalResources":{
|
|
"shape":"AdditionalResourcesList",
|
|
"documentation":"<p>The additional resources for a choice. A choice can have up to two additional resources: one of type <code>HELPFUL_RESOURCE</code>, one of type <code>IMPROVEMENT_PLAN</code>, or both.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A choice available to answer question.</p>"
|
|
},
|
|
"ChoiceAnswer":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ChoiceId":{"shape":"ChoiceId"},
|
|
"Status":{
|
|
"shape":"ChoiceStatus",
|
|
"documentation":"<p>The status of a choice.</p>"
|
|
},
|
|
"Reason":{
|
|
"shape":"ChoiceReason",
|
|
"documentation":"<p>The reason why a choice is non-applicable to a question in your workload.</p>"
|
|
},
|
|
"Notes":{
|
|
"shape":"ChoiceNotes",
|
|
"documentation":"<p>The notes associated with a choice.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A choice that has been answered on a question in your workload.</p>"
|
|
},
|
|
"ChoiceAnswerSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"ChoiceAnswerSummary"}
|
|
},
|
|
"ChoiceAnswerSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ChoiceId":{"shape":"ChoiceId"},
|
|
"Status":{
|
|
"shape":"ChoiceStatus",
|
|
"documentation":"<p>The status of a choice.</p>"
|
|
},
|
|
"Reason":{
|
|
"shape":"ChoiceReason",
|
|
"documentation":"<p>The reason why a choice is non-applicable to a question in your workload.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A choice summary that has been answered on a question in your workload.</p>"
|
|
},
|
|
"ChoiceAnswers":{
|
|
"type":"list",
|
|
"member":{"shape":"ChoiceAnswer"}
|
|
},
|
|
"ChoiceContent":{
|
|
"type":"structure",
|
|
"members":{
|
|
"DisplayText":{
|
|
"shape":"ChoiceContentDisplayText",
|
|
"documentation":"<p>The display text for the choice content.</p>"
|
|
},
|
|
"Url":{
|
|
"shape":"ChoiceContentUrl",
|
|
"documentation":"<p>The URL for the choice content.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The choice content.</p>"
|
|
},
|
|
"ChoiceContentDisplayText":{
|
|
"type":"string",
|
|
"max":1024,
|
|
"min":1
|
|
},
|
|
"ChoiceContentUrl":{
|
|
"type":"string",
|
|
"max":1024,
|
|
"min":1
|
|
},
|
|
"ChoiceDescription":{
|
|
"type":"string",
|
|
"documentation":"<p>The description of a choice.</p>",
|
|
"max":1024,
|
|
"min":1
|
|
},
|
|
"ChoiceId":{
|
|
"type":"string",
|
|
"documentation":"<p>The ID of a choice.</p>",
|
|
"max":64,
|
|
"min":1
|
|
},
|
|
"ChoiceImprovementPlan":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ChoiceId":{"shape":"ChoiceId"},
|
|
"DisplayText":{
|
|
"shape":"DisplayText",
|
|
"documentation":"<p>The display text for the improvement plan.</p>"
|
|
},
|
|
"ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"}
|
|
},
|
|
"documentation":"<p>The choice level improvement plan.</p>"
|
|
},
|
|
"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":"<p>The title of a choice.</p>",
|
|
"max":512,
|
|
"min":1
|
|
},
|
|
"ChoiceUpdate":{
|
|
"type":"structure",
|
|
"required":["Status"],
|
|
"members":{
|
|
"Status":{
|
|
"shape":"ChoiceStatus",
|
|
"documentation":"<p>The status of a choice.</p>"
|
|
},
|
|
"Reason":{
|
|
"shape":"ChoiceReason",
|
|
"documentation":"<p>The reason why a choice is non-applicable to a question in your workload.</p>"
|
|
},
|
|
"Notes":{
|
|
"shape":"ChoiceNotes",
|
|
"documentation":"<p>The notes associated with a choice.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A list of choices to be updated.</p>"
|
|
},
|
|
"ChoiceUpdates":{
|
|
"type":"map",
|
|
"key":{"shape":"ChoiceId"},
|
|
"value":{"shape":"ChoiceUpdate"}
|
|
},
|
|
"Choices":{
|
|
"type":"list",
|
|
"member":{"shape":"Choice"},
|
|
"documentation":"<p>List of choices available for a question.</p>"
|
|
},
|
|
"ClientRequestToken":{
|
|
"type":"string",
|
|
"documentation":"<p>A unique case-sensitive string used to ensure that this request is idempotent (executes only once).</p> <p>You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after it has completed successfully, the result of the original request is returned. </p> <important> <p>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.</p> </important>"
|
|
},
|
|
"ConflictException":{
|
|
"type":"structure",
|
|
"required":[
|
|
"Message",
|
|
"ResourceId",
|
|
"ResourceType"
|
|
],
|
|
"members":{
|
|
"Message":{"shape":"ExceptionMessage"},
|
|
"ResourceId":{"shape":"ExceptionResourceId"},
|
|
"ResourceType":{"shape":"ExceptionResourceType"}
|
|
},
|
|
"documentation":"<p>The resource already exists.</p>",
|
|
"error":{"httpStatusCode":409},
|
|
"exception":true
|
|
},
|
|
"Count":{
|
|
"type":"integer",
|
|
"documentation":"<p>A non-negative integer that denotes how many.</p>",
|
|
"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":"<p>The version of the lens being created.</p>"
|
|
},
|
|
"IsMajorVersion":{
|
|
"shape":"IsMajorVersion",
|
|
"documentation":"<p>Set to true if this new major lens version.</p>"
|
|
},
|
|
"ClientRequestToken":{
|
|
"shape":"ClientRequestToken",
|
|
"idempotencyToken":true
|
|
}
|
|
}
|
|
},
|
|
"CreateLensVersionOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"LensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The version of the lens.</p>"
|
|
}
|
|
}
|
|
},
|
|
"CreateMilestoneInput":{
|
|
"type":"structure",
|
|
"required":[
|
|
"WorkloadId",
|
|
"MilestoneName",
|
|
"ClientRequestToken"
|
|
],
|
|
"members":{
|
|
"WorkloadId":{
|
|
"shape":"WorkloadId",
|
|
"location":"uri",
|
|
"locationName":"WorkloadId"
|
|
},
|
|
"MilestoneName":{"shape":"MilestoneName"},
|
|
"ClientRequestToken":{
|
|
"shape":"ClientRequestToken",
|
|
"idempotencyToken":true
|
|
}
|
|
},
|
|
"documentation":"<p>Input for milestone creation.</p>"
|
|
},
|
|
"CreateMilestoneOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"MilestoneNumber":{"shape":"MilestoneNumber"}
|
|
},
|
|
"documentation":"<p>Output of a create milestone call.</p>"
|
|
},
|
|
"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":"<p>The tags to be associated with the workload.</p>"
|
|
},
|
|
"DiscoveryConfig":{
|
|
"shape":"WorkloadDiscoveryConfig",
|
|
"documentation":"<p>Well-Architected discovery configuration settings associated to the workload.</p>"
|
|
},
|
|
"Applications":{
|
|
"shape":"WorkloadApplications",
|
|
"documentation":"<p>List of AppRegistry application ARNs associated to the workload.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Input for workload creation.</p>"
|
|
},
|
|
"CreateWorkloadOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"WorkloadArn":{"shape":"WorkloadArn"}
|
|
},
|
|
"documentation":"<p>Output of a create workload call.</p>"
|
|
},
|
|
"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":"<p>Input for Create Workload Share</p>"
|
|
},
|
|
"CreateWorkloadShareOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"ShareId":{"shape":"ShareId"}
|
|
},
|
|
"documentation":"<p>Input for Create Workload Share</p>"
|
|
},
|
|
"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":"<p>The status of the lens to be deleted.</p>",
|
|
"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"
|
|
}
|
|
}
|
|
},
|
|
"DeleteWorkloadInput":{
|
|
"type":"structure",
|
|
"required":[
|
|
"WorkloadId",
|
|
"ClientRequestToken"
|
|
],
|
|
"members":{
|
|
"WorkloadId":{
|
|
"shape":"WorkloadId",
|
|
"location":"uri",
|
|
"locationName":"WorkloadId"
|
|
},
|
|
"ClientRequestToken":{
|
|
"shape":"ClientRequestToken",
|
|
"idempotencyToken":true,
|
|
"location":"querystring",
|
|
"locationName":"ClientRequestToken"
|
|
}
|
|
},
|
|
"documentation":"<p>Input for workload deletion.</p>"
|
|
},
|
|
"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":"<p>Input for Delete Workload Share</p>"
|
|
},
|
|
"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":"<p>Input to disassociate lens reviews.</p>"
|
|
},
|
|
"DisplayText":{
|
|
"type":"string",
|
|
"max":64,
|
|
"min":1
|
|
},
|
|
"ExceptionMessage":{
|
|
"type":"string",
|
|
"documentation":"<p>Description of the error.</p>"
|
|
},
|
|
"ExceptionResourceId":{
|
|
"type":"string",
|
|
"documentation":"<p>Identifier of the resource affected.</p>"
|
|
},
|
|
"ExceptionResourceType":{
|
|
"type":"string",
|
|
"documentation":"<p>Type of the resource affected.</p>"
|
|
},
|
|
"ExportLensInput":{
|
|
"type":"structure",
|
|
"required":["LensAlias"],
|
|
"members":{
|
|
"LensAlias":{
|
|
"shape":"LensAlias",
|
|
"location":"uri",
|
|
"locationName":"LensAlias"
|
|
},
|
|
"LensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The lens version to be exported.</p>",
|
|
"location":"querystring",
|
|
"locationName":"LensVersion"
|
|
}
|
|
}
|
|
},
|
|
"ExportLensOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensJSON":{
|
|
"shape":"LensJSON",
|
|
"documentation":"<p>The JSON for the lens.</p>"
|
|
}
|
|
}
|
|
},
|
|
"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":"<p>Input to get answer.</p>"
|
|
},
|
|
"GetAnswerOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"MilestoneNumber":{"shape":"MilestoneNumber"},
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"Answer":{"shape":"Answer"}
|
|
},
|
|
"documentation":"<p>Output of a get answer call.</p>"
|
|
},
|
|
"GetLensInput":{
|
|
"type":"structure",
|
|
"required":["LensAlias"],
|
|
"members":{
|
|
"LensAlias":{
|
|
"shape":"LensAlias",
|
|
"location":"uri",
|
|
"locationName":"LensAlias"
|
|
},
|
|
"LensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The lens version to be retrieved.</p>",
|
|
"location":"querystring",
|
|
"locationName":"LensVersion"
|
|
}
|
|
}
|
|
},
|
|
"GetLensOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Lens":{
|
|
"shape":"Lens",
|
|
"documentation":"<p>A lens return object.</p>"
|
|
}
|
|
}
|
|
},
|
|
"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":"<p>Input to get lens review.</p>"
|
|
},
|
|
"GetLensReviewOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"MilestoneNumber":{"shape":"MilestoneNumber"},
|
|
"LensReview":{"shape":"LensReview"}
|
|
},
|
|
"documentation":"<p>Output of a get lens review call.</p>"
|
|
},
|
|
"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":"<p>Input to get lens review report.</p>"
|
|
},
|
|
"GetLensReviewReportOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"MilestoneNumber":{"shape":"MilestoneNumber"},
|
|
"LensReviewReport":{"shape":"LensReviewReport"}
|
|
},
|
|
"documentation":"<p>Output of a get lens review report call.</p>"
|
|
},
|
|
"GetLensVersionDifferenceInput":{
|
|
"type":"structure",
|
|
"required":["LensAlias"],
|
|
"members":{
|
|
"LensAlias":{
|
|
"shape":"LensAlias",
|
|
"location":"uri",
|
|
"locationName":"LensAlias"
|
|
},
|
|
"BaseLensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The base version of the lens.</p>",
|
|
"location":"querystring",
|
|
"locationName":"BaseLensVersion"
|
|
},
|
|
"TargetLensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The lens version to target a difference for.</p>",
|
|
"location":"querystring",
|
|
"locationName":"TargetLensVersion"
|
|
}
|
|
}
|
|
},
|
|
"GetLensVersionDifferenceOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"BaseLensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The base version of the lens.</p>"
|
|
},
|
|
"TargetLensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The target lens version for the lens.</p>"
|
|
},
|
|
"LatestLensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The latest version of the lens.</p>"
|
|
},
|
|
"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":"<p>Input to get a milestone.</p>"
|
|
},
|
|
"GetMilestoneOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"Milestone":{"shape":"Milestone"}
|
|
},
|
|
"documentation":"<p>Output of a get milestone call.</p>"
|
|
},
|
|
"GetWorkloadInput":{
|
|
"type":"structure",
|
|
"required":["WorkloadId"],
|
|
"members":{
|
|
"WorkloadId":{
|
|
"shape":"WorkloadId",
|
|
"location":"uri",
|
|
"locationName":"WorkloadId"
|
|
}
|
|
},
|
|
"documentation":"<p>Input to get a workload.</p>"
|
|
},
|
|
"GetWorkloadOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Workload":{"shape":"Workload"}
|
|
},
|
|
"documentation":"<p>Output of a get workload call.</p>"
|
|
},
|
|
"HelpfulResourceUrl":{
|
|
"type":"string",
|
|
"documentation":"<p>The helpful resource URL for a question.</p>",
|
|
"max":2048,
|
|
"min":1
|
|
},
|
|
"ImportLensInput":{
|
|
"type":"structure",
|
|
"required":[
|
|
"JSONString",
|
|
"ClientRequestToken"
|
|
],
|
|
"members":{
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"JSONString":{
|
|
"shape":"LensJSON",
|
|
"documentation":"<p>The JSON representation of a lens.</p>"
|
|
},
|
|
"ClientRequestToken":{
|
|
"shape":"ClientRequestToken",
|
|
"idempotencyToken":true
|
|
},
|
|
"Tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>Tags to associate to a lens.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ImportLensOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"Status":{
|
|
"shape":"ImportLensStatus",
|
|
"documentation":"<p>The status of the imported lens.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ImportLensStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"IN_PROGRESS",
|
|
"COMPLETE",
|
|
"ERROR"
|
|
]
|
|
},
|
|
"ImprovementPlanUrl":{
|
|
"type":"string",
|
|
"documentation":"<p>The improvement plan URL for a question.</p> <p>This value is only available if the question has been answered.</p>",
|
|
"max":2048,
|
|
"min":1
|
|
},
|
|
"ImprovementSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"ImprovementSummary"},
|
|
"documentation":"<p>List of improvement summaries of lens review in a workload.</p>"
|
|
},
|
|
"ImprovementSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"QuestionId":{"shape":"QuestionId"},
|
|
"PillarId":{"shape":"PillarId"},
|
|
"QuestionTitle":{"shape":"QuestionTitle"},
|
|
"Risk":{"shape":"Risk"},
|
|
"ImprovementPlanUrl":{"shape":"ImprovementPlanUrl"},
|
|
"ImprovementPlans":{
|
|
"shape":"ChoiceImprovementPlans",
|
|
"documentation":"<p>The improvement plan details.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>An improvement summary of a lens review in a workload.</p>"
|
|
},
|
|
"InternalServerException":{
|
|
"type":"structure",
|
|
"required":["Message"],
|
|
"members":{
|
|
"Message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>There is a problem with the Well-Architected Tool API service.</p>",
|
|
"error":{"httpStatusCode":500},
|
|
"exception":true,
|
|
"fault":true
|
|
},
|
|
"IsApplicable":{
|
|
"type":"boolean",
|
|
"documentation":"<p>Defines whether this question is applicable to a lens review.</p>"
|
|
},
|
|
"IsMajorVersion":{"type":"boolean"},
|
|
"IsReviewOwnerUpdateAcknowledged":{"type":"boolean"},
|
|
"Lens":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN of a lens.</p>"
|
|
},
|
|
"LensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The version of a lens.</p>"
|
|
},
|
|
"Name":{"shape":"LensName"},
|
|
"Description":{"shape":"LensDescription"},
|
|
"Owner":{
|
|
"shape":"LensOwner",
|
|
"documentation":"<p>The Amazon Web Services account ID that owns the lens.</p>"
|
|
},
|
|
"ShareInvitationId":{
|
|
"shape":"ShareInvitationId",
|
|
"documentation":"<p>The ID assigned to the share invitation.</p>"
|
|
},
|
|
"Tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>The tags assigned to the lens.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A lens return object.</p>"
|
|
},
|
|
"LensAlias":{
|
|
"type":"string",
|
|
"documentation":"<p>The alias of the lens.</p> <p>For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2::lens/serverless</code>.</p> <p>For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1:123456789012:lens/my-lens</code>. </p> <p>Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>",
|
|
"max":128,
|
|
"min":1
|
|
},
|
|
"LensAliases":{
|
|
"type":"list",
|
|
"member":{"shape":"LensAlias"},
|
|
"documentation":"<p>List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.</p> <p>Identify a lens using its <a>LensSummary$LensAlias</a>.</p>",
|
|
"min":1
|
|
},
|
|
"LensArn":{"type":"string"},
|
|
"LensDescription":{
|
|
"type":"string",
|
|
"documentation":"<p>The description of the lens.</p>",
|
|
"max":1024,
|
|
"min":1
|
|
},
|
|
"LensJSON":{
|
|
"type":"string",
|
|
"max":500000,
|
|
"min":2
|
|
},
|
|
"LensName":{
|
|
"type":"string",
|
|
"documentation":"<p>The full name of the lens.</p>",
|
|
"max":128,
|
|
"min":1
|
|
},
|
|
"LensNamePrefix":{
|
|
"type":"string",
|
|
"max":100
|
|
},
|
|
"LensOwner":{"type":"string"},
|
|
"LensReview":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"LensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The version of the lens.</p>"
|
|
},
|
|
"LensName":{"shape":"LensName"},
|
|
"LensStatus":{
|
|
"shape":"LensStatus",
|
|
"documentation":"<p>The status of the lens.</p>"
|
|
},
|
|
"PillarReviewSummaries":{"shape":"PillarReviewSummaries"},
|
|
"UpdatedAt":{"shape":"Timestamp"},
|
|
"Notes":{"shape":"Notes"},
|
|
"RiskCounts":{"shape":"RiskCounts"},
|
|
"NextToken":{"shape":"NextToken"}
|
|
},
|
|
"documentation":"<p>A lens review of a question.</p>"
|
|
},
|
|
"LensReviewReport":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"Base64String":{"shape":"Base64String"}
|
|
},
|
|
"documentation":"<p>A report of a lens review.</p>"
|
|
},
|
|
"LensReviewSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"LensReviewSummary"},
|
|
"documentation":"<p>List of lens summaries of lens reviews of a workload.</p>"
|
|
},
|
|
"LensReviewSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"LensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The version of the lens.</p>"
|
|
},
|
|
"LensName":{"shape":"LensName"},
|
|
"LensStatus":{
|
|
"shape":"LensStatus",
|
|
"documentation":"<p>The status of the lens.</p>"
|
|
},
|
|
"UpdatedAt":{"shape":"Timestamp"},
|
|
"RiskCounts":{"shape":"RiskCounts"}
|
|
},
|
|
"documentation":"<p>A lens review summary of a workload.</p>"
|
|
},
|
|
"LensShareSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"LensShareSummary"}
|
|
},
|
|
"LensShareSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ShareId":{"shape":"ShareId"},
|
|
"SharedWith":{"shape":"SharedWith"},
|
|
"Status":{"shape":"ShareStatus"},
|
|
"StatusMessage":{
|
|
"shape":"StatusMessage",
|
|
"documentation":"<p>Optional message to compliment the Status field.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A lens share summary return object.</p>"
|
|
},
|
|
"LensStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"CURRENT",
|
|
"NOT_CURRENT",
|
|
"DEPRECATED",
|
|
"DELETED",
|
|
"UNSHARED"
|
|
]
|
|
},
|
|
"LensStatusType":{
|
|
"type":"string",
|
|
"enum":[
|
|
"ALL",
|
|
"DRAFT",
|
|
"PUBLISHED"
|
|
]
|
|
},
|
|
"LensSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"LensSummary"},
|
|
"documentation":"<p>List of lens summaries of available lenses.</p>"
|
|
},
|
|
"LensSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN of the lens.</p>"
|
|
},
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensName":{"shape":"LensName"},
|
|
"LensType":{
|
|
"shape":"LensType",
|
|
"documentation":"<p>The type of the lens.</p>"
|
|
},
|
|
"Description":{"shape":"LensDescription"},
|
|
"CreatedAt":{"shape":"Timestamp"},
|
|
"UpdatedAt":{"shape":"Timestamp"},
|
|
"LensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The version of the lens.</p>"
|
|
},
|
|
"Owner":{"shape":"AwsAccountId"},
|
|
"LensStatus":{
|
|
"shape":"LensStatus",
|
|
"documentation":"<p>The status of the lens.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A lens summary of a lens.</p>"
|
|
},
|
|
"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":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"CurrentLensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The current version of the lens.</p>"
|
|
},
|
|
"LatestLensVersion":{
|
|
"shape":"LensVersion",
|
|
"documentation":"<p>The latest version of the lens.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Lens upgrade summary return object.</p>"
|
|
},
|
|
"LensVersion":{
|
|
"type":"string",
|
|
"max":32,
|
|
"min":1
|
|
},
|
|
"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":"<p>The maximum number of results to return for this request.</p>",
|
|
"location":"querystring",
|
|
"locationName":"MaxResults"
|
|
}
|
|
},
|
|
"documentation":"<p>Input to list answers.</p>"
|
|
},
|
|
"ListAnswersMaxResults":{
|
|
"type":"integer",
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"ListAnswersOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"MilestoneNumber":{"shape":"MilestoneNumber"},
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"AnswerSummaries":{"shape":"AnswerSummaries"},
|
|
"NextToken":{"shape":"NextToken"}
|
|
},
|
|
"documentation":"<p>Output of a list answers call.</p>"
|
|
},
|
|
"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":"<p>Well-Architected Lens ARN.</p>"
|
|
},
|
|
"PillarId":{"shape":"PillarId"},
|
|
"QuestionId":{"shape":"QuestionId"},
|
|
"ChoiceId":{"shape":"ChoiceId"}
|
|
}
|
|
},
|
|
"ListCheckDetailsOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"CheckDetails":{
|
|
"shape":"CheckDetails",
|
|
"documentation":"<p>The details about the Trusted Advisor checks related to the Well-Architected best practice.</p>"
|
|
},
|
|
"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":"<p>Well-Architected Lens ARN.</p>"
|
|
},
|
|
"PillarId":{"shape":"PillarId"},
|
|
"QuestionId":{"shape":"QuestionId"},
|
|
"ChoiceId":{"shape":"ChoiceId"}
|
|
}
|
|
},
|
|
"ListCheckSummariesOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"CheckSummaries":{
|
|
"shape":"CheckSummaries",
|
|
"documentation":"<p>List of Trusted Advisor summaries related to the Well-Architected best practice.</p>"
|
|
},
|
|
"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":"<p>The maximum number of results to return for this request.</p>",
|
|
"location":"querystring",
|
|
"locationName":"MaxResults"
|
|
}
|
|
},
|
|
"documentation":"<p>Input to list lens review improvements.</p>"
|
|
},
|
|
"ListLensReviewImprovementsMaxResults":{
|
|
"type":"integer",
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"ListLensReviewImprovementsOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"MilestoneNumber":{"shape":"MilestoneNumber"},
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"ImprovementSummaries":{"shape":"ImprovementSummaries"},
|
|
"NextToken":{"shape":"NextToken"}
|
|
},
|
|
"documentation":"<p>Output of a list lens review improvements call.</p>"
|
|
},
|
|
"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":"<p>Input to list lens reviews.</p>"
|
|
},
|
|
"ListLensReviewsOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"MilestoneNumber":{"shape":"MilestoneNumber"},
|
|
"LensReviewSummaries":{"shape":"LensReviewSummaries"},
|
|
"NextToken":{"shape":"NextToken"}
|
|
},
|
|
"documentation":"<p>Output of a list lens reviews call.</p>"
|
|
},
|
|
"ListLensSharesInput":{
|
|
"type":"structure",
|
|
"required":["LensAlias"],
|
|
"members":{
|
|
"LensAlias":{
|
|
"shape":"LensAlias",
|
|
"location":"uri",
|
|
"locationName":"LensAlias"
|
|
},
|
|
"SharedWithPrefix":{
|
|
"shape":"SharedWithPrefix",
|
|
"documentation":"<p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.</p>",
|
|
"location":"querystring",
|
|
"locationName":"SharedWithPrefix"
|
|
},
|
|
"NextToken":{
|
|
"shape":"NextToken",
|
|
"location":"querystring",
|
|
"locationName":"NextToken"
|
|
},
|
|
"MaxResults":{
|
|
"shape":"ListWorkloadSharesMaxResults",
|
|
"documentation":"<p>The maximum number of results to return for this request.</p>",
|
|
"location":"querystring",
|
|
"locationName":"MaxResults"
|
|
},
|
|
"Status":{
|
|
"shape":"ShareStatus",
|
|
"location":"querystring",
|
|
"locationName":"Status"
|
|
}
|
|
}
|
|
},
|
|
"ListLensSharesOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensShareSummaries":{
|
|
"shape":"LensShareSummaries",
|
|
"documentation":"<p>A list of lens share summaries.</p>"
|
|
},
|
|
"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":"<p>The type of lenses to be returned.</p>",
|
|
"location":"querystring",
|
|
"locationName":"LensType"
|
|
},
|
|
"LensStatus":{
|
|
"shape":"LensStatusType",
|
|
"documentation":"<p>The status of lenses to be returned.</p>",
|
|
"location":"querystring",
|
|
"locationName":"LensStatus"
|
|
},
|
|
"LensName":{
|
|
"shape":"LensName",
|
|
"location":"querystring",
|
|
"locationName":"LensName"
|
|
}
|
|
},
|
|
"documentation":"<p>Input to list lenses.</p>"
|
|
},
|
|
"ListLensesOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"LensSummaries":{"shape":"LensSummaries"},
|
|
"NextToken":{"shape":"NextToken"}
|
|
},
|
|
"documentation":"<p>Output of a list lenses call.</p>"
|
|
},
|
|
"ListMilestonesInput":{
|
|
"type":"structure",
|
|
"required":["WorkloadId"],
|
|
"members":{
|
|
"WorkloadId":{
|
|
"shape":"WorkloadId",
|
|
"location":"uri",
|
|
"locationName":"WorkloadId"
|
|
},
|
|
"NextToken":{"shape":"NextToken"},
|
|
"MaxResults":{"shape":"MaxResults"}
|
|
},
|
|
"documentation":"<p>Input to list all milestones for a workload.</p>"
|
|
},
|
|
"ListMilestonesOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"MilestoneSummaries":{"shape":"MilestoneSummaries"},
|
|
"NextToken":{"shape":"NextToken"}
|
|
},
|
|
"documentation":"<p>Output of a list milestones call.</p>"
|
|
},
|
|
"ListNotificationsInput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"NextToken":{"shape":"NextToken"},
|
|
"MaxResults":{
|
|
"shape":"ListNotificationsMaxResults",
|
|
"documentation":"<p>The maximum number of results to return for this request.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListNotificationsMaxResults":{
|
|
"type":"integer",
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"ListNotificationsOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"NotificationSummaries":{
|
|
"shape":"NotificationSummaries",
|
|
"documentation":"<p>List of lens notification summaries in a workload.</p>"
|
|
},
|
|
"NextToken":{"shape":"NextToken"}
|
|
}
|
|
},
|
|
"ListShareInvitationsInput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadNamePrefix":{
|
|
"shape":"WorkloadNamePrefix",
|
|
"location":"querystring",
|
|
"locationName":"WorkloadNamePrefix"
|
|
},
|
|
"LensNamePrefix":{
|
|
"shape":"LensNamePrefix",
|
|
"documentation":"<p>An optional string added to the beginning of each lens name returned in the results.</p>",
|
|
"location":"querystring",
|
|
"locationName":"LensNamePrefix"
|
|
},
|
|
"ShareResourceType":{
|
|
"shape":"ShareResourceType",
|
|
"documentation":"<p>The type of share invitations to be returned.</p>",
|
|
"location":"querystring",
|
|
"locationName":"ShareResourceType"
|
|
},
|
|
"NextToken":{
|
|
"shape":"NextToken",
|
|
"location":"querystring",
|
|
"locationName":"NextToken"
|
|
},
|
|
"MaxResults":{
|
|
"shape":"ListShareInvitationsMaxResults",
|
|
"documentation":"<p>The maximum number of results to return for this request.</p>",
|
|
"location":"querystring",
|
|
"locationName":"MaxResults"
|
|
}
|
|
},
|
|
"documentation":"<p>Input for List Share Invitations</p>"
|
|
},
|
|
"ListShareInvitationsMaxResults":{
|
|
"type":"integer",
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"ListShareInvitationsOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ShareInvitationSummaries":{
|
|
"shape":"ShareInvitationSummaries",
|
|
"documentation":"<p>List of share invitation summaries in a workload.</p>"
|
|
},
|
|
"NextToken":{"shape":"NextToken"}
|
|
},
|
|
"documentation":"<p>Input for List Share Invitations</p>"
|
|
},
|
|
"ListTagsForResourceInput":{
|
|
"type":"structure",
|
|
"required":["WorkloadArn"],
|
|
"members":{
|
|
"WorkloadArn":{
|
|
"shape":"WorkloadArn",
|
|
"location":"uri",
|
|
"locationName":"WorkloadArn"
|
|
}
|
|
}
|
|
},
|
|
"ListTagsForResourceOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>The tags for the resource.</p>"
|
|
}
|
|
}
|
|
},
|
|
"ListWorkloadSharesInput":{
|
|
"type":"structure",
|
|
"required":["WorkloadId"],
|
|
"members":{
|
|
"WorkloadId":{
|
|
"shape":"WorkloadId",
|
|
"location":"uri",
|
|
"locationName":"WorkloadId"
|
|
},
|
|
"SharedWithPrefix":{
|
|
"shape":"SharedWithPrefix",
|
|
"documentation":"<p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.</p>",
|
|
"location":"querystring",
|
|
"locationName":"SharedWithPrefix"
|
|
},
|
|
"NextToken":{
|
|
"shape":"NextToken",
|
|
"location":"querystring",
|
|
"locationName":"NextToken"
|
|
},
|
|
"MaxResults":{
|
|
"shape":"ListWorkloadSharesMaxResults",
|
|
"documentation":"<p>The maximum number of results to return for this request.</p>",
|
|
"location":"querystring",
|
|
"locationName":"MaxResults"
|
|
},
|
|
"Status":{
|
|
"shape":"ShareStatus",
|
|
"location":"querystring",
|
|
"locationName":"Status"
|
|
}
|
|
},
|
|
"documentation":"<p>Input for List Workload Share</p>"
|
|
},
|
|
"ListWorkloadSharesMaxResults":{
|
|
"type":"integer",
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"ListWorkloadSharesOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"WorkloadShareSummaries":{"shape":"WorkloadShareSummaries"},
|
|
"NextToken":{"shape":"NextToken"}
|
|
},
|
|
"documentation":"<p>Input for List Workload Share</p>"
|
|
},
|
|
"ListWorkloadsInput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadNamePrefix":{"shape":"WorkloadNamePrefix"},
|
|
"NextToken":{"shape":"NextToken"},
|
|
"MaxResults":{
|
|
"shape":"ListWorkloadsMaxResults",
|
|
"documentation":"<p>The maximum number of results to return for this request.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Input to list all workloads.</p>"
|
|
},
|
|
"ListWorkloadsMaxResults":{
|
|
"type":"integer",
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"ListWorkloadsOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadSummaries":{"shape":"WorkloadSummaries"},
|
|
"NextToken":{"shape":"NextToken"}
|
|
},
|
|
"documentation":"<p>Output of a list workloads call.</p>"
|
|
},
|
|
"MaxResults":{
|
|
"type":"integer",
|
|
"documentation":"<p>The maximum number of results to return for this request.</p>",
|
|
"max":50,
|
|
"min":1
|
|
},
|
|
"Milestone":{
|
|
"type":"structure",
|
|
"members":{
|
|
"MilestoneNumber":{"shape":"MilestoneNumber"},
|
|
"MilestoneName":{"shape":"MilestoneName"},
|
|
"RecordedAt":{"shape":"Timestamp"},
|
|
"Workload":{"shape":"Workload"}
|
|
},
|
|
"documentation":"<p>A milestone return object.</p>"
|
|
},
|
|
"MilestoneName":{
|
|
"type":"string",
|
|
"documentation":"<p>The name of the milestone in a workload.</p> <p>Milestone names must be unique within a workload.</p>",
|
|
"max":100,
|
|
"min":3
|
|
},
|
|
"MilestoneNumber":{
|
|
"type":"integer",
|
|
"documentation":"<p>The milestone number.</p> <p>A workload can have a maximum of 100 milestones.</p>",
|
|
"max":100,
|
|
"min":1
|
|
},
|
|
"MilestoneSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"MilestoneSummary"},
|
|
"documentation":"<p>A list of milestone summaries.</p>"
|
|
},
|
|
"MilestoneSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"MilestoneNumber":{"shape":"MilestoneNumber"},
|
|
"MilestoneName":{"shape":"MilestoneName"},
|
|
"RecordedAt":{"shape":"Timestamp"},
|
|
"WorkloadSummary":{"shape":"WorkloadSummary"}
|
|
},
|
|
"documentation":"<p>A milestone summary return object.</p>"
|
|
},
|
|
"NextToken":{
|
|
"type":"string",
|
|
"documentation":"<p>The token to use to retrieve the next set of results.</p>"
|
|
},
|
|
"Notes":{
|
|
"type":"string",
|
|
"documentation":"<p>The notes associated with the workload.</p>",
|
|
"max":2084
|
|
},
|
|
"NotificationSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"NotificationSummary"}
|
|
},
|
|
"NotificationSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Type":{
|
|
"shape":"NotificationType",
|
|
"documentation":"<p>The type of notification.</p>"
|
|
},
|
|
"LensUpgradeSummary":{
|
|
"shape":"LensUpgradeSummary",
|
|
"documentation":"<p>Summary of lens upgrade.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A notification summary return object.</p>"
|
|
},
|
|
"NotificationType":{
|
|
"type":"string",
|
|
"enum":[
|
|
"LENS_VERSION_UPGRADED",
|
|
"LENS_VERSION_DEPRECATED"
|
|
]
|
|
},
|
|
"OrganizationSharingStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"ENABLED",
|
|
"DISABLED"
|
|
]
|
|
},
|
|
"PermissionType":{
|
|
"type":"string",
|
|
"documentation":"<p>Permission granted on a workload share.</p>",
|
|
"enum":[
|
|
"READONLY",
|
|
"CONTRIBUTOR"
|
|
]
|
|
},
|
|
"PillarDifference":{
|
|
"type":"structure",
|
|
"members":{
|
|
"PillarId":{"shape":"PillarId"},
|
|
"PillarName":{"shape":"PillarName"},
|
|
"DifferenceStatus":{
|
|
"shape":"DifferenceStatus",
|
|
"documentation":"<p>Indicates the type of change to the pillar.</p>"
|
|
},
|
|
"QuestionDifferences":{
|
|
"shape":"QuestionDifferences",
|
|
"documentation":"<p>List of question differences.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A pillar difference return object.</p>"
|
|
},
|
|
"PillarDifferences":{
|
|
"type":"list",
|
|
"member":{"shape":"PillarDifference"}
|
|
},
|
|
"PillarId":{
|
|
"type":"string",
|
|
"documentation":"<p>The ID used to identify a pillar, for example, <code>security</code>.</p> <p>A pillar is identified by its <a>PillarReviewSummary$PillarId</a>.</p>",
|
|
"max":64,
|
|
"min":1
|
|
},
|
|
"PillarName":{
|
|
"type":"string",
|
|
"documentation":"<p>The name of the pillar.</p>",
|
|
"max":128,
|
|
"min":1
|
|
},
|
|
"PillarNotes":{
|
|
"type":"map",
|
|
"key":{"shape":"PillarId"},
|
|
"value":{"shape":"Notes"},
|
|
"documentation":"<p>List of pillar notes of a lens review in a workload.</p>"
|
|
},
|
|
"PillarReviewSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"PillarReviewSummary"},
|
|
"documentation":"<p>List of pillar review summaries of lens review in a workload.</p>"
|
|
},
|
|
"PillarReviewSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"PillarId":{"shape":"PillarId"},
|
|
"PillarName":{"shape":"PillarName"},
|
|
"Notes":{"shape":"Notes"},
|
|
"RiskCounts":{"shape":"RiskCounts"}
|
|
},
|
|
"documentation":"<p>A pillar review summary of a lens review.</p>"
|
|
},
|
|
"QuestionDescription":{
|
|
"type":"string",
|
|
"documentation":"<p>The description of the question.</p>",
|
|
"max":1024,
|
|
"min":1
|
|
},
|
|
"QuestionDifference":{
|
|
"type":"structure",
|
|
"members":{
|
|
"QuestionId":{"shape":"QuestionId"},
|
|
"QuestionTitle":{"shape":"QuestionTitle"},
|
|
"DifferenceStatus":{
|
|
"shape":"DifferenceStatus",
|
|
"documentation":"<p>Indicates the type of change to the question.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A question difference return object.</p>"
|
|
},
|
|
"QuestionDifferences":{
|
|
"type":"list",
|
|
"member":{"shape":"QuestionDifference"}
|
|
},
|
|
"QuestionId":{
|
|
"type":"string",
|
|
"documentation":"<p>The ID of the question.</p>",
|
|
"max":128,
|
|
"min":1
|
|
},
|
|
"QuestionTitle":{
|
|
"type":"string",
|
|
"documentation":"<p>The title of the question.</p>",
|
|
"max":512,
|
|
"min":1
|
|
},
|
|
"QuotaCode":{
|
|
"type":"string",
|
|
"documentation":"<p>Service Quotas requirement to identify originating quota.</p>"
|
|
},
|
|
"ResourceNotFoundException":{
|
|
"type":"structure",
|
|
"required":[
|
|
"Message",
|
|
"ResourceId",
|
|
"ResourceType"
|
|
],
|
|
"members":{
|
|
"Message":{"shape":"ExceptionMessage"},
|
|
"ResourceId":{"shape":"ExceptionResourceId"},
|
|
"ResourceType":{"shape":"ExceptionResourceType"}
|
|
},
|
|
"documentation":"<p>The requested resource was not found.</p>",
|
|
"error":{"httpStatusCode":404},
|
|
"exception":true
|
|
},
|
|
"Risk":{
|
|
"type":"string",
|
|
"documentation":"<p>The risk for a given workload, lens review, pillar, or question.</p>",
|
|
"enum":[
|
|
"UNANSWERED",
|
|
"HIGH",
|
|
"MEDIUM",
|
|
"NONE",
|
|
"NOT_APPLICABLE"
|
|
]
|
|
},
|
|
"RiskCounts":{
|
|
"type":"map",
|
|
"key":{"shape":"Risk"},
|
|
"value":{"shape":"Count"},
|
|
"documentation":"<p>A map from risk names to the count of how questions have that rating.</p>"
|
|
},
|
|
"SelectedChoices":{
|
|
"type":"list",
|
|
"member":{"shape":"ChoiceId"},
|
|
"documentation":"<p>List of selected choice IDs in a question answer.</p> <p>The values entered replace the previously selected choices.</p>"
|
|
},
|
|
"ServiceCode":{
|
|
"type":"string",
|
|
"documentation":"<p>Service Quotas requirement to identify originating service.</p>"
|
|
},
|
|
"ServiceQuotaExceededException":{
|
|
"type":"structure",
|
|
"required":[
|
|
"Message",
|
|
"QuotaCode",
|
|
"ServiceCode"
|
|
],
|
|
"members":{
|
|
"Message":{"shape":"ExceptionMessage"},
|
|
"ResourceId":{"shape":"ExceptionResourceId"},
|
|
"ResourceType":{"shape":"ExceptionResourceType"},
|
|
"QuotaCode":{"shape":"QuotaCode"},
|
|
"ServiceCode":{"shape":"ServiceCode"}
|
|
},
|
|
"documentation":"<p>The user has reached their resource quota.</p>",
|
|
"error":{"httpStatusCode":402},
|
|
"exception":true
|
|
},
|
|
"ShareId":{
|
|
"type":"string",
|
|
"documentation":"<p>The ID associated with the workload share.</p>",
|
|
"pattern":"[0-9a-f]{32}"
|
|
},
|
|
"ShareInvitation":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ShareInvitationId":{
|
|
"shape":"ShareInvitationId",
|
|
"documentation":"<p>The ID assigned to the share invitation.</p>"
|
|
},
|
|
"ShareResourceType":{
|
|
"shape":"ShareResourceType",
|
|
"documentation":"<p>The resource type of the share invitation.</p>"
|
|
},
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The share invitation.</p>"
|
|
},
|
|
"ShareInvitationAction":{
|
|
"type":"string",
|
|
"documentation":"<p>Share invitation action taken by contributor.</p>",
|
|
"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":"<p>The ID assigned to the share invitation.</p>"
|
|
},
|
|
"SharedBy":{"shape":"AwsAccountId"},
|
|
"SharedWith":{"shape":"SharedWith"},
|
|
"PermissionType":{"shape":"PermissionType"},
|
|
"ShareResourceType":{
|
|
"shape":"ShareResourceType",
|
|
"documentation":"<p>The resource type of the share invitation.</p>"
|
|
},
|
|
"WorkloadName":{"shape":"WorkloadName"},
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"LensName":{"shape":"LensName"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A share invitation summary return object.</p>"
|
|
},
|
|
"ShareResourceType":{
|
|
"type":"string",
|
|
"enum":[
|
|
"WORKLOAD",
|
|
"LENS"
|
|
]
|
|
},
|
|
"ShareStatus":{
|
|
"type":"string",
|
|
"documentation":"<p>The status of a workload share.</p>",
|
|
"enum":[
|
|
"ACCEPTED",
|
|
"REJECTED",
|
|
"PENDING",
|
|
"REVOKED",
|
|
"EXPIRED",
|
|
"ASSOCIATING",
|
|
"ASSOCIATED",
|
|
"FAILED"
|
|
]
|
|
},
|
|
"SharedWith":{
|
|
"type":"string",
|
|
"documentation":"<p>The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.</p>",
|
|
"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":"<p>The tags for the resource.</p>"
|
|
}
|
|
}
|
|
},
|
|
"TagResourceOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
}
|
|
},
|
|
"TagValue":{
|
|
"type":"string",
|
|
"max":256,
|
|
"min":0
|
|
},
|
|
"ThrottlingException":{
|
|
"type":"structure",
|
|
"required":["Message"],
|
|
"members":{
|
|
"Message":{"shape":"ExceptionMessage"},
|
|
"QuotaCode":{"shape":"QuotaCode"},
|
|
"ServiceCode":{"shape":"ServiceCode"}
|
|
},
|
|
"documentation":"<p>Request was denied due to request throttling.</p>",
|
|
"error":{"httpStatusCode":429},
|
|
"exception":true
|
|
},
|
|
"Timestamp":{
|
|
"type":"timestamp",
|
|
"documentation":"<p>The date and time recorded.</p>"
|
|
},
|
|
"TrustedAdvisorIntegrationStatus":{
|
|
"type":"string",
|
|
"enum":[
|
|
"ENABLED",
|
|
"DISABLED"
|
|
]
|
|
},
|
|
"UntagResourceInput":{
|
|
"type":"structure",
|
|
"required":[
|
|
"WorkloadArn",
|
|
"TagKeys"
|
|
],
|
|
"members":{
|
|
"WorkloadArn":{
|
|
"shape":"WorkloadArn",
|
|
"location":"uri",
|
|
"locationName":"WorkloadArn"
|
|
},
|
|
"TagKeys":{
|
|
"shape":"TagKeyList",
|
|
"documentation":"<p>A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.</p>",
|
|
"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":"<p>A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.</p>"
|
|
},
|
|
"Notes":{"shape":"Notes"},
|
|
"IsApplicable":{"shape":"IsApplicable"},
|
|
"Reason":{
|
|
"shape":"AnswerReason",
|
|
"documentation":"<p>The reason why a question is not applicable to your workload.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Input to update answer.</p>"
|
|
},
|
|
"UpdateAnswerOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"LensAlias":{"shape":"LensAlias"},
|
|
"LensArn":{
|
|
"shape":"LensArn",
|
|
"documentation":"<p>The ARN for the lens.</p>"
|
|
},
|
|
"Answer":{"shape":"Answer"}
|
|
},
|
|
"documentation":"<p>Output of a update answer call.</p>"
|
|
},
|
|
"UpdateGlobalSettingsInput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"OrganizationSharingStatus":{
|
|
"shape":"OrganizationSharingStatus",
|
|
"documentation":"<p>The status of organization sharing settings.</p>"
|
|
}
|
|
}
|
|
},
|
|
"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":"<p>Input for update lens review.</p>"
|
|
},
|
|
"UpdateLensReviewOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"LensReview":{"shape":"LensReview"}
|
|
},
|
|
"documentation":"<p>Output of a update lens review call.</p>"
|
|
},
|
|
"UpdateShareInvitationInput":{
|
|
"type":"structure",
|
|
"required":[
|
|
"ShareInvitationId",
|
|
"ShareInvitationAction"
|
|
],
|
|
"members":{
|
|
"ShareInvitationId":{
|
|
"shape":"ShareInvitationId",
|
|
"documentation":"<p>The ID assigned to the share invitation.</p>",
|
|
"location":"uri",
|
|
"locationName":"ShareInvitationId"
|
|
},
|
|
"ShareInvitationAction":{"shape":"ShareInvitationAction"}
|
|
},
|
|
"documentation":"<p>Input for Update Share Invitation</p>"
|
|
},
|
|
"UpdateShareInvitationOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ShareInvitation":{
|
|
"shape":"ShareInvitation",
|
|
"documentation":"<p>The updated workload or custom lens share invitation.</p>"
|
|
}
|
|
}
|
|
},
|
|
"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":"<p>Flag indicating whether the workload owner has acknowledged that the <i>Review owner</i> field is required.</p> <p>If a <b>Review owner</b> is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.</p>"
|
|
},
|
|
"IndustryType":{"shape":"WorkloadIndustryType"},
|
|
"Industry":{"shape":"WorkloadIndustry"},
|
|
"Notes":{"shape":"Notes"},
|
|
"ImprovementStatus":{"shape":"WorkloadImprovementStatus"},
|
|
"DiscoveryConfig":{
|
|
"shape":"WorkloadDiscoveryConfig",
|
|
"documentation":"<p>Well-Architected discovery configuration settings to associate to the workload.</p>"
|
|
},
|
|
"Applications":{
|
|
"shape":"WorkloadApplications",
|
|
"documentation":"<p>List of AppRegistry application ARNs to associate to the workload.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Input to update a workload.</p>"
|
|
},
|
|
"UpdateWorkloadOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"Workload":{"shape":"Workload"}
|
|
},
|
|
"documentation":"<p>Output of an update workload call.</p>"
|
|
},
|
|
"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":"<p>Input for Update Workload Share</p>"
|
|
},
|
|
"UpdateWorkloadShareOutput":{
|
|
"type":"structure",
|
|
"members":{
|
|
"WorkloadId":{"shape":"WorkloadId"},
|
|
"WorkloadShare":{"shape":"WorkloadShare"}
|
|
},
|
|
"documentation":"<p>Input for Update Workload Share</p>"
|
|
},
|
|
"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"}
|
|
}
|
|
},
|
|
"Urls":{
|
|
"type":"list",
|
|
"member":{"shape":"ChoiceContent"}
|
|
},
|
|
"ValidationException":{
|
|
"type":"structure",
|
|
"required":["Message"],
|
|
"members":{
|
|
"Message":{"shape":"ExceptionMessage"},
|
|
"Reason":{"shape":"ValidationExceptionReason"},
|
|
"Fields":{"shape":"ValidationExceptionFieldList"}
|
|
},
|
|
"documentation":"<p>The user input is not valid.</p>",
|
|
"error":{"httpStatusCode":400},
|
|
"exception":true
|
|
},
|
|
"ValidationExceptionField":{
|
|
"type":"structure",
|
|
"required":[
|
|
"Name",
|
|
"Message"
|
|
],
|
|
"members":{
|
|
"Name":{"shape":"ValidationExceptionFieldName"},
|
|
"Message":{"shape":"ExceptionMessage"}
|
|
},
|
|
"documentation":"<p>Stores information about a field passed inside a request that resulted in an exception.</p>"
|
|
},
|
|
"ValidationExceptionFieldList":{
|
|
"type":"list",
|
|
"member":{"shape":"ValidationExceptionField"},
|
|
"documentation":"<p>The fields that caused the error, if applicable.</p>"
|
|
},
|
|
"ValidationExceptionFieldName":{
|
|
"type":"string",
|
|
"documentation":"<p>The field name for which validation failed.</p>"
|
|
},
|
|
"ValidationExceptionReason":{
|
|
"type":"string",
|
|
"documentation":"<p>The reason why the request failed validation.</p>",
|
|
"enum":[
|
|
"UNKNOWN_OPERATION",
|
|
"CANNOT_PARSE",
|
|
"FIELD_VALIDATION_FAILED",
|
|
"OTHER"
|
|
]
|
|
},
|
|
"VersionDifferences":{
|
|
"type":"structure",
|
|
"members":{
|
|
"PillarDifferences":{
|
|
"shape":"PillarDifferences",
|
|
"documentation":"<p>The differences between the base and latest versions of the lens.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>The differences between the base and latest versions of the lens.</p>"
|
|
},
|
|
"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":"<p>Flag indicating whether the workload owner has acknowledged that the <i>Review owner</i> field is required.</p> <p>If a <b>Review owner</b> is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.</p>"
|
|
},
|
|
"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":"<p>The ID assigned to the share invitation.</p>"
|
|
},
|
|
"Tags":{
|
|
"shape":"TagMap",
|
|
"documentation":"<p>The tags associated with the workload.</p>"
|
|
},
|
|
"DiscoveryConfig":{
|
|
"shape":"WorkloadDiscoveryConfig",
|
|
"documentation":"<p>Discovery configuration associated to the workload.</p>"
|
|
},
|
|
"Applications":{
|
|
"shape":"WorkloadApplications",
|
|
"documentation":"<p>List of AppRegistry application ARNs associated to the workload.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A workload return object.</p>"
|
|
},
|
|
"WorkloadAccountIds":{
|
|
"type":"list",
|
|
"member":{"shape":"AwsAccountId"},
|
|
"documentation":"<p>The list of Amazon Web Services account IDs associated with the workload.</p>",
|
|
"max":100
|
|
},
|
|
"WorkloadApplications":{
|
|
"type":"list",
|
|
"member":{"shape":"ApplicationArn"},
|
|
"max":1
|
|
},
|
|
"WorkloadArchitecturalDesign":{
|
|
"type":"string",
|
|
"documentation":"<p>The URL of the architectural design for the workload.</p>",
|
|
"max":2048,
|
|
"pattern":"^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$"
|
|
},
|
|
"WorkloadArn":{
|
|
"type":"string",
|
|
"documentation":"<p>The ARN for the workload.</p>"
|
|
},
|
|
"WorkloadAwsRegions":{
|
|
"type":"list",
|
|
"member":{"shape":"AwsRegion"},
|
|
"documentation":"<p>The list of Amazon Web Services Regions associated with the workload, for example, <code>us-east-2</code>, or <code>ca-central-1</code>.</p>",
|
|
"max":50
|
|
},
|
|
"WorkloadDescription":{
|
|
"type":"string",
|
|
"documentation":"<p>The description for the workload.</p>",
|
|
"max":250,
|
|
"min":3
|
|
},
|
|
"WorkloadDiscoveryConfig":{
|
|
"type":"structure",
|
|
"members":{
|
|
"TrustedAdvisorIntegrationStatus":{
|
|
"shape":"TrustedAdvisorIntegrationStatus",
|
|
"documentation":"<p>Discovery integration status in respect to Trusted Advisor for the workload.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>Discovery configuration associated to the workload.</p>"
|
|
},
|
|
"WorkloadEnvironment":{
|
|
"type":"string",
|
|
"documentation":"<p>The environment for the workload.</p>",
|
|
"enum":[
|
|
"PRODUCTION",
|
|
"PREPRODUCTION"
|
|
]
|
|
},
|
|
"WorkloadId":{
|
|
"type":"string",
|
|
"documentation":"<p>The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.</p>",
|
|
"pattern":"[0-9a-f]{32}"
|
|
},
|
|
"WorkloadImprovementStatus":{
|
|
"type":"string",
|
|
"documentation":"<p>The improvement status for a workload.</p>",
|
|
"enum":[
|
|
"NOT_APPLICABLE",
|
|
"NOT_STARTED",
|
|
"IN_PROGRESS",
|
|
"COMPLETE",
|
|
"RISK_ACKNOWLEDGED"
|
|
]
|
|
},
|
|
"WorkloadIndustry":{
|
|
"type":"string",
|
|
"documentation":"<p>The industry for the workload.</p>",
|
|
"max":100
|
|
},
|
|
"WorkloadIndustryType":{
|
|
"type":"string",
|
|
"documentation":"<p>The industry type for the workload.</p> <p>If specified, must be one of the following:</p> <ul> <li> <p> <code>Agriculture</code> </p> </li> <li> <p> <code>Automobile</code> </p> </li> <li> <p> <code>Defense</code> </p> </li> <li> <p> <code>Design and Engineering</code> </p> </li> <li> <p> <code>Digital Advertising</code> </p> </li> <li> <p> <code>Education</code> </p> </li> <li> <p> <code>Environmental Protection</code> </p> </li> <li> <p> <code>Financial Services</code> </p> </li> <li> <p> <code>Gaming</code> </p> </li> <li> <p> <code>General Public Services</code> </p> </li> <li> <p> <code>Healthcare</code> </p> </li> <li> <p> <code>Hospitality</code> </p> </li> <li> <p> <code>InfoTech</code> </p> </li> <li> <p> <code>Justice and Public Safety</code> </p> </li> <li> <p> <code>Life Sciences</code> </p> </li> <li> <p> <code>Manufacturing</code> </p> </li> <li> <p> <code>Media & Entertainment</code> </p> </li> <li> <p> <code>Mining & Resources</code> </p> </li> <li> <p> <code>Oil & Gas</code> </p> </li> <li> <p> <code>Power & Utilities</code> </p> </li> <li> <p> <code>Professional Services</code> </p> </li> <li> <p> <code>Real Estate & Construction</code> </p> </li> <li> <p> <code>Retail & Wholesale</code> </p> </li> <li> <p> <code>Social Protection</code> </p> </li> <li> <p> <code>Telecommunications</code> </p> </li> <li> <p> <code>Travel, Transportation & Logistics</code> </p> </li> <li> <p> <code>Other</code> </p> </li> </ul>",
|
|
"max":100
|
|
},
|
|
"WorkloadLenses":{
|
|
"type":"list",
|
|
"member":{"shape":"LensAlias"},
|
|
"documentation":"<p>The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.</p>"
|
|
},
|
|
"WorkloadName":{
|
|
"type":"string",
|
|
"documentation":"<p>The name of the workload.</p> <p>The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.</p>",
|
|
"max":100,
|
|
"min":3
|
|
},
|
|
"WorkloadNamePrefix":{
|
|
"type":"string",
|
|
"documentation":"<p>An optional string added to the beginning of each workload name returned in the results.</p>",
|
|
"max":100
|
|
},
|
|
"WorkloadNonAwsRegion":{
|
|
"type":"string",
|
|
"max":25,
|
|
"min":3
|
|
},
|
|
"WorkloadNonAwsRegions":{
|
|
"type":"list",
|
|
"member":{"shape":"WorkloadNonAwsRegion"},
|
|
"documentation":"<p> The list of non-Amazon Web Services Regions associated with the workload.</p>",
|
|
"max":5
|
|
},
|
|
"WorkloadPillarPriorities":{
|
|
"type":"list",
|
|
"member":{"shape":"PillarId"},
|
|
"documentation":"<p>The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its <a>PillarReviewSummary$PillarId</a>.</p>"
|
|
},
|
|
"WorkloadReviewOwner":{
|
|
"type":"string",
|
|
"documentation":"<p>The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.</p>",
|
|
"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":"<p>A workload share return object.</p>"
|
|
},
|
|
"WorkloadShareSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"WorkloadShareSummary"},
|
|
"documentation":"<p>A list of workload share summaries.</p>"
|
|
},
|
|
"WorkloadShareSummary":{
|
|
"type":"structure",
|
|
"members":{
|
|
"ShareId":{"shape":"ShareId"},
|
|
"SharedWith":{"shape":"SharedWith"},
|
|
"PermissionType":{"shape":"PermissionType"},
|
|
"Status":{"shape":"ShareStatus"},
|
|
"StatusMessage":{
|
|
"shape":"StatusMessage",
|
|
"documentation":"<p>Optional message to compliment the Status field.</p>"
|
|
}
|
|
},
|
|
"documentation":"<p>A workload share summary return object.</p>"
|
|
},
|
|
"WorkloadSummaries":{
|
|
"type":"list",
|
|
"member":{"shape":"WorkloadSummary"},
|
|
"documentation":"<p>A list of workload summaries.</p>"
|
|
},
|
|
"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"}
|
|
},
|
|
"documentation":"<p>A workload summary return object.</p>"
|
|
}
|
|
},
|
|
"documentation":"<fullname>Well-Architected Tool</fullname> <p>This is the <i>Well-Architected Tool API Reference</i>. The WA Tool API provides programmatic access to the <a href=\"http://aws.amazon.com/well-architected-tool\">Well-Architected Tool</a> in the <a href=\"https://console.aws.amazon.com/wellarchitected\">Amazon Web Services Management Console</a>. For information about the Well-Architected Tool, see the <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html\">Well-Architected Tool User Guide</a>.</p>"
|
|
}
|