View Source aws_wellarchitected (aws v1.0.4)
Well-Architected Tool
This is the Well-Architected Tool API Reference.
The WA Tool API provides programmatic access to the Well-Architected Tool: http://aws.amazon.com/well-architected-tool in the Amazon Web Services Management Console: https://console.aws.amazon.com/wellarchitected. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide: https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html.Summary
Functions
Associate a lens to a workload.
Create a lens share.
Create a new lens version.
Create a review template.
Create a review template share.
Create a new workload.
Create a workload share.
Delete an existing lens.
Delete a lens share.
Delete a profile.
Delete a review template.
Delete a review template share.
Disassociate a lens from a workload.
Export an existing lens.
Get a consolidated report of your workloads.
Import a new custom lens or update an existing custom lens.
List the share invitations.
List the tags for a resource.
Adds one or more tags to the specified resource.
Deletes specified tags from a resource.
Update a workload or custom lens share invitation.
Functions
Associate a lens to a workload.
Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.
Disclaimer
By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.Create a new lens version.
A lens can have up to 100 versions.
Use this operation to publish a new lens version after you have imported a lens. TheLensAlias is used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.
Create a review template.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload: https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html in the Well-Architected Tool User Guide.
Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload.
You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.
When creating a workload using a review template, you must have the following IAM permissions:
wellarchitected:GetReviewTemplatewellarchitected:GetReviewTemplateAnswerwellarchitected:ListReviewTemplateAnswerswellarchitected:GetReviewTemplateLensReview
Delete an existing lens.
Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.
Disclaimer
By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.Delete a profile.
Disclaimer
By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.Delete a review template.
Only the owner of a review template can delete it.
After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.Disassociate a lens from a workload.
Up to 10 lenses can be disassociated from a workload in a single API operation.
The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.
Export an existing lens.
Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.
Lenses are defined in JSON. For more information, see JSON format specification: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html in the Well-Architected Tool User Guide.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.get_answer(Client, LensAlias, QuestionId, WorkloadId, QueryMap, HeadersMap)
View Sourceget_answer(Client, LensAlias, QuestionId, WorkloadId, QueryMap, HeadersMap, Options0)
View SourceGet a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.get_consolidated_report(Client, Format, QueryMap, HeadersMap, Options0)
View Sourceget_lens_review(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)
View Sourceget_lens_review(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)
View Sourceget_lens_review_report(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)
View Sourceget_lens_review_report(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)
View Sourceget_lens_version_difference(Client, LensAlias, QueryMap, HeadersMap)
View Sourceget_lens_version_difference(Client, LensAlias, QueryMap, HeadersMap, Options0)
View Sourceget_milestone(Client, MilestoneNumber, WorkloadId, QueryMap, HeadersMap)
View Sourceget_milestone(Client, MilestoneNumber, WorkloadId, QueryMap, HeadersMap, Options0)
View Sourceget_review_template(Client, TemplateArn, QueryMap, HeadersMap, Options0)
View Sourceget_review_template_answer(Client, LensAlias, QuestionId, TemplateArn)
View Sourceget_review_template_answer(Client, LensAlias, QuestionId, TemplateArn, QueryMap, HeadersMap)
View Sourceget_review_template_answer(Client, LensAlias, QuestionId, TemplateArn, QueryMap, HeadersMap, Options0)
View Sourceget_review_template_lens_review(Client, LensAlias, TemplateArn, QueryMap, HeadersMap)
View Sourceget_review_template_lens_review(Client, LensAlias, TemplateArn, QueryMap, HeadersMap, Options0)
View SourceImport a new custom lens or update an existing custom lens.
To update an existing custom lens, specify its ARN as the LensAlias. If no ARN is specified, a new custom lens is created.
The new or updated lens will have a status of DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion.
Lenses are defined in JSON. For more information, see JSON format specification: https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html in the Well-Architected Tool User Guide.
A custom lens cannot exceed 500 KB in size.
Disclaimer
Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.list_answers(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)
View Sourcelist_lens_review_improvements(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)
View Sourcelist_lens_review_improvements(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)
View Sourcelist_lens_reviews(Client, WorkloadId, QueryMap, HeadersMap, Options0)
View Sourcelist_profile_notifications(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_review_template_answers(Client, LensAlias, TemplateArn, QueryMap, HeadersMap)
View Sourcelist_review_template_answers(Client, LensAlias, TemplateArn, QueryMap, HeadersMap, Options0)
View SourceList the tags for a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.list_tags_for_resource(Client, WorkloadArn, QueryMap, HeadersMap, Options0)
View SourceAdds one or more tags to the specified resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.Deletes specified tags from a resource.
The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2