View Source AWS.WellArchitected (aws-elixir v0.13.3)
Well-Architected Tool
This is the Well-Architected Tool API Reference.
The WA Tool API provides programmatic access to the Well-Architected Tool in the Amazon Web Services Management Console. For information about the Well-Architected Tool, see the Well-Architected Tool User Guide.
Link to this section Summary
Functions
Associate a lens to a workload.
Create a lens share.
Create a new lens version.
Create a milestone for an existing workload.
Create a new workload.
Create a workload share.
Delete an existing lens.
Delete a lens share.
Delete an existing workload.
Delete a workload share.
Disassociate a lens from a workload.
Export an existing lens.
Get the answer to a specific question in a workload review.
Get a consolidated report of your workloads.
Get an existing lens.
Get lens review.
Get lens review report.
Get lens version differences.
Get a milestone for an existing workload.
Get an existing workload.
Import a new custom lens or update an existing custom lens.
List of answers for a particular workload and lens.
List of Trusted Advisor check details by account related to the workload.
List of Trusted Advisor checks summarized for all accounts related to the workload.
List lens review improvements.
List lens reviews for a particular workload.
List the lens shares associated with the lens.
List the available lenses.
List all milestones for an existing workload.
List lens notifications.
List the workload invitations.
List the tags for a resource.
List the workload shares associated with the workload.
Paginated list of workloads.
Adds one or more tags to the specified resource.
Deletes specified tags from a resource.
Update the answer to a specific question in a workload review.
Updates whether the Amazon Web Services account is opted into organization sharing features.
Update lens review for a particular workload.
Update a workload or custom lens share invitation.
Update an existing workload.
Update a workload share.
Upgrade lens review for a particular workload.
Link to this section 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
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.
The LensAlias
is used to identify the lens to be published. The owner of a
lens can share the lens with other Amazon Web Services accounts and users in the
same Amazon Web Services Region. Only the owner of a lens can delete it.
Create a milestone for an existing workload.
Create a new workload.
The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.
For more information, see Defining a Workload in the Well-Architected Tool User Guide.
Either AwsRegions
, NonAwsRegions
, or both must be specified when creating a
workload.
You also must specify ReviewOwner
, even though the parameter is listed as not
being required in the following section.
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
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 an existing workload.
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_lens(client, lens_alias, lens_version \\ nil, options \\ [])
View SourceExport an existing lens.
Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
disclaimer
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, lens_alias, question_id, workload_id, milestone_number \\ nil, options \\ [])
View SourceGet the answer to a specific question in a workload review.
get_consolidated_report(client, format, include_shared_resources \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceGet a consolidated report of your workloads.
You can optionally choose to include workloads that have been shared with you.
Get an existing lens.
get_lens_review(client, lens_alias, workload_id, milestone_number \\ nil, options \\ [])
View SourceGet lens review.
get_lens_review_report(client, lens_alias, workload_id, milestone_number \\ nil, options \\ [])
View SourceGet lens review report.
get_lens_version_difference(client, lens_alias, base_lens_version \\ nil, target_lens_version \\ nil, options \\ [])
View SourceGet lens version differences.
get_milestone(client, milestone_number, workload_id, options \\ [])
View SourceGet a milestone for an existing workload.
Get an existing workload.
Import a new custom lens or update an existing custom lens.
To update an existing custom lens, specify its ARN as the LensAlias
. If no ARN
is specified, a new custom lens is created.
The new or updated lens will have a status of DRAFT
. The lens cannot be
applied to workloads or shared with other Amazon Web Services accounts until
it's published with CreateLensVersion
.
Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.
A custom lens cannot exceed 500 KB in size.
disclaimer
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, lens_alias, workload_id, max_results \\ nil, milestone_number \\ nil, next_token \\ nil, pillar_id \\ nil, options \\ [])
View SourceList of answers for a particular workload and lens.
List of Trusted Advisor check details by account related to the workload.
List of Trusted Advisor checks summarized for all accounts related to the workload.
list_lens_review_improvements(client, lens_alias, workload_id, max_results \\ nil, milestone_number \\ nil, next_token \\ nil, pillar_id \\ nil, options \\ [])
View SourceList lens review improvements.
list_lens_reviews(client, workload_id, max_results \\ nil, milestone_number \\ nil, next_token \\ nil, options \\ [])
View SourceList lens reviews for a particular workload.
list_lenses(client, lens_name \\ nil, lens_status \\ nil, lens_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList the available lenses.
List all milestones for an existing workload.
List lens notifications.
List the tags for a resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
Paginated list of workloads.
Adds one or more tags to the specified resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
Deletes specified tags from a resource.
The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.
To specify multiple tags, use separate tagKeys parameters, for example:
DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
update_answer(client, lens_alias, question_id, workload_id, input, options \\ [])
View SourceUpdate the answer to a specific question in a workload review.
Updates whether the Amazon Web Services account is opted into organization sharing features.
update_lens_review(client, lens_alias, workload_id, input, options \\ [])
View SourceUpdate lens review for a particular workload.
Update an existing workload.
upgrade_lens_review(client, lens_alias, workload_id, input, options \\ [])
View SourceUpgrade lens review for a particular workload.