View Source AWS.WellArchitected (aws-elixir v1.0.4)

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.

associate_profiles(client, workload_id, input, options \\ [])

Associate a profile with a workload.

create_lens_share(client, lens_alias, input, options \\ [])

Create a lens share.

The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.

Shared access to a lens is not removed until the lens invitation is deleted.

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

For more information, see Sharing a custom lens in the Well-Architected Tool User Guide.

disclaimer
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.

create_lens_version(client, lens_alias, input, options \\ [])

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_milestone(client, workload_id, input, options \\ [])

Create a milestone for an existing workload.

create_profile(client, input, options \\ [])

Create a profile.

create_profile_share(client, profile_arn, input, options \\ [])

Create a profile share.

create_review_template(client, input, options \\ [])

Create a review template.

disclaimer
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_template_share(client, template_arn, input, options \\ [])

Create a review template share.

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

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

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

disclaimer
Disclaimer

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

create_workload(client, input, options \\ [])

Create a new workload.

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

For more information, see Defining a Workload in the Well-Architected Tool User Guide.

Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload.

You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.

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

wellarchitected:GetReviewTemplate

wellarchitected:GetReviewTemplateAnswer

wellarchitected:ListReviewTemplateAnswers

wellarchitected:GetReviewTemplateLensReview

create_workload_share(client, workload_id, input, options \\ [])

Create a workload share.

The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.

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

For more information, see Sharing a workload in the Well-Architected Tool User Guide.

delete_lens(client, lens_alias, input, options \\ [])

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

delete_lens_share(client, lens_alias, share_id, input, options \\ [])

Delete a lens share.

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

disclaimer
Disclaimer

delete_profile(client, profile_arn, input, options \\ [])

Delete a profile.

disclaimer
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_profile_share(client, profile_arn, share_id, input, options \\ [])

Delete a profile share.

delete_review_template(client, template_arn, input, options \\ [])

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.

delete_template_share(client, share_id, template_arn, input, options \\ [])

Delete a review template share.

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

delete_workload(client, workload_id, input, options \\ [])

Delete an existing workload.

delete_workload_share(client, share_id, workload_id, input, options \\ [])

Delete a workload share.

disassociate_lenses(client, workload_id, input, options \\ [])

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.

disassociate_profiles(client, workload_id, input, options \\ [])

Disassociate a profile from a workload.

export_lens(client, lens_alias, lens_version \\ nil, options \\ [])

Export an existing lens.

Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.

disclaimer
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 \\ [])

Get 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 \\ [])

Get a consolidated report of your workloads.

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

get_global_settings(client, options \\ [])

Global settings for all workloads.

get_lens(client, lens_alias, lens_version \\ nil, options \\ [])

Get an existing lens.

get_lens_review(client, lens_alias, workload_id, milestone_number \\ nil, options \\ [])

Get lens review.

get_lens_review_report(client, lens_alias, workload_id, milestone_number \\ nil, options \\ [])

Get lens review report.

get_lens_version_difference(client, lens_alias, base_lens_version \\ nil, target_lens_version \\ nil, options \\ [])

Get lens version differences.

get_milestone(client, milestone_number, workload_id, options \\ [])

Get a milestone for an existing workload.

get_profile(client, profile_arn, profile_version \\ nil, options \\ [])

Get profile information.

get_profile_template(client, options \\ [])

Get profile template.

get_review_template(client, template_arn, options \\ [])

Get review template.

get_review_template_answer(client, lens_alias, question_id, template_arn, options \\ [])

Get review template answer.

get_review_template_lens_review(client, lens_alias, template_arn, options \\ [])

Get a lens review associated with a review template.

get_workload(client, workload_id, options \\ [])

Get an existing workload.

import_lens(client, input, options \\ [])

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

list_answers(client, lens_alias, workload_id, max_results \\ nil, milestone_number \\ nil, next_token \\ nil, pillar_id \\ nil, question_priority \\ nil, options \\ [])

List of answers for a particular workload and lens.

list_check_details(client, workload_id, input, options \\ [])

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

list_check_summaries(client, workload_id, input, options \\ [])

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, question_priority \\ nil, options \\ [])

List the improvements of a particular lens review.

list_lens_reviews(client, workload_id, max_results \\ nil, milestone_number \\ nil, next_token \\ nil, options \\ [])

List lens reviews for a particular workload.

list_lens_shares(client, lens_alias, max_results \\ nil, next_token \\ nil, shared_with_prefix \\ nil, status \\ nil, options \\ [])

List the lens shares associated with the lens.

list_lenses(client, lens_name \\ nil, lens_status \\ nil, lens_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

List the available lenses.

list_milestones(client, workload_id, input, options \\ [])

List all milestones for an existing workload.

list_notifications(client, input, options \\ [])

List lens notifications.

list_profile_notifications(client, max_results \\ nil, next_token \\ nil, workload_id \\ nil, options \\ [])

List profile notifications.

list_profile_shares(client, profile_arn, max_results \\ nil, next_token \\ nil, shared_with_prefix \\ nil, status \\ nil, options \\ [])

List profile shares.

list_profiles(client, max_results \\ nil, next_token \\ nil, profile_name_prefix \\ nil, profile_owner_type \\ nil, options \\ [])

List profiles.

list_review_template_answers(client, lens_alias, template_arn, max_results \\ nil, next_token \\ nil, pillar_id \\ nil, options \\ [])

List the answers of a review template.

list_review_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

List review templates.

list_share_invitations(client, lens_name_prefix \\ nil, max_results \\ nil, next_token \\ nil, profile_name_prefix \\ nil, share_resource_type \\ nil, template_name_prefix \\ nil, workload_name_prefix \\ nil, options \\ [])

List the share invitations.

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

list_tags_for_resource(client, workload_arn, options \\ [])

List the tags for a resource.

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

list_template_shares(client, template_arn, max_results \\ nil, next_token \\ nil, shared_with_prefix \\ nil, status \\ nil, options \\ [])

List review template shares.

list_workload_shares(client, workload_id, max_results \\ nil, next_token \\ nil, shared_with_prefix \\ nil, status \\ nil, options \\ [])

List the workload shares associated with the workload.

list_workloads(client, input, options \\ [])

Paginated list of workloads.

metadata()

tag_resource(client, workload_arn, input, options \\ [])

Adds one or more tags to the specified resource.

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

untag_resource(client, workload_arn, input, options \\ [])

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

update_answer(client, lens_alias, question_id, workload_id, input, options \\ [])

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

update_global_settings(client, input, options \\ [])

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

update_integration(client, workload_id, input, options \\ [])

Update integration features.

update_lens_review(client, lens_alias, workload_id, input, options \\ [])

Update lens review for a particular workload.

update_profile(client, profile_arn, input, options \\ [])

Update a profile.

update_review_template(client, template_arn, input, options \\ [])

Update a review template.

update_review_template_answer(client, lens_alias, question_id, template_arn, input, options \\ [])

Update a review template answer.

update_review_template_lens_review(client, lens_alias, template_arn, input, options \\ [])

Update a lens review associated with a review template.

update_share_invitation(client, share_invitation_id, input, options \\ [])

Update a workload or custom lens share invitation.

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

update_workload(client, workload_id, input, options \\ [])

Update an existing workload.

update_workload_share(client, share_id, workload_id, input, options \\ [])

Update a workload share.

upgrade_lens_review(client, lens_alias, workload_id, input, options \\ [])

Upgrade lens review for a particular workload.

upgrade_profile_version(client, profile_arn, workload_id, input, options \\ [])

Upgrade a profile.

upgrade_review_template_lens_review(client, lens_alias, template_arn, input, options \\ [])

Upgrade the lens review of a review template.

Settings View Source AWS.WellArchitected (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

associate_lenses(client, workload_id, input, options \\ [])

disclaimer Disclaimer

associate_profiles(client, workload_id, input, options \\ [])

create_lens_share(client, lens_alias, input, options \\ [])

disclaimer Disclaimer

create_lens_version(client, lens_alias, input, options \\ [])

create_milestone(client, workload_id, input, options \\ [])

create_profile(client, input, options \\ [])

create_profile_share(client, profile_arn, input, options \\ [])

create_review_template(client, input, options \\ [])

disclaimer Disclaimer

create_template_share(client, template_arn, input, options \\ [])

disclaimer Disclaimer

create_workload(client, input, options \\ [])

create_workload_share(client, workload_id, input, options \\ [])

delete_lens(client, lens_alias, input, options \\ [])

disclaimer Disclaimer

delete_lens_share(client, lens_alias, share_id, input, options \\ [])

disclaimer Disclaimer

delete_profile(client, profile_arn, input, options \\ [])

disclaimer Disclaimer

delete_profile_share(client, profile_arn, share_id, input, options \\ [])

delete_review_template(client, template_arn, input, options \\ [])

delete_template_share(client, share_id, template_arn, input, options \\ [])

delete_workload(client, workload_id, input, options \\ [])

delete_workload_share(client, share_id, workload_id, input, options \\ [])

disassociate_lenses(client, workload_id, input, options \\ [])

disassociate_profiles(client, workload_id, input, options \\ [])

export_lens(client, lens_alias, lens_version \\ nil, options \\ [])

disclaimer Disclaimer

get_answer(client, lens_alias, question_id, workload_id, milestone_number \\ nil, options \\ [])

get_consolidated_report(client, format, include_shared_resources \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

get_global_settings(client, options \\ [])

get_lens(client, lens_alias, lens_version \\ nil, options \\ [])

get_lens_review(client, lens_alias, workload_id, milestone_number \\ nil, options \\ [])

get_lens_review_report(client, lens_alias, workload_id, milestone_number \\ nil, options \\ [])

get_lens_version_difference(client, lens_alias, base_lens_version \\ nil, target_lens_version \\ nil, options \\ [])

get_milestone(client, milestone_number, workload_id, options \\ [])

get_profile(client, profile_arn, profile_version \\ nil, options \\ [])

get_profile_template(client, options \\ [])

get_review_template(client, template_arn, options \\ [])

get_review_template_answer(client, lens_alias, question_id, template_arn, options \\ [])

get_review_template_lens_review(client, lens_alias, template_arn, options \\ [])

get_workload(client, workload_id, options \\ [])

import_lens(client, input, options \\ [])

disclaimer Disclaimer

list_answers(client, lens_alias, workload_id, max_results \\ nil, milestone_number \\ nil, next_token \\ nil, pillar_id \\ nil, question_priority \\ nil, options \\ [])

list_check_details(client, workload_id, input, options \\ [])

list_check_summaries(client, workload_id, input, options \\ [])

list_lens_review_improvements(client, lens_alias, workload_id, max_results \\ nil, milestone_number \\ nil, next_token \\ nil, pillar_id \\ nil, question_priority \\ nil, options \\ [])

list_lens_reviews(client, workload_id, max_results \\ nil, milestone_number \\ nil, next_token \\ nil, options \\ [])

list_lens_shares(client, lens_alias, max_results \\ nil, next_token \\ nil, shared_with_prefix \\ nil, status \\ nil, options \\ [])

list_lenses(client, lens_name \\ nil, lens_status \\ nil, lens_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

list_milestones(client, workload_id, input, options \\ [])

list_notifications(client, input, options \\ [])

list_profile_notifications(client, max_results \\ nil, next_token \\ nil, workload_id \\ nil, options \\ [])

list_profile_shares(client, profile_arn, max_results \\ nil, next_token \\ nil, shared_with_prefix \\ nil, status \\ nil, options \\ [])

list_profiles(client, max_results \\ nil, next_token \\ nil, profile_name_prefix \\ nil, profile_owner_type \\ nil, options \\ [])

list_review_template_answers(client, lens_alias, template_arn, max_results \\ nil, next_token \\ nil, pillar_id \\ nil, options \\ [])

list_review_templates(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_share_invitations(client, lens_name_prefix \\ nil, max_results \\ nil, next_token \\ nil, profile_name_prefix \\ nil, share_resource_type \\ nil, template_name_prefix \\ nil, workload_name_prefix \\ nil, options \\ [])

list_tags_for_resource(client, workload_arn, options \\ [])

list_template_shares(client, template_arn, max_results \\ nil, next_token \\ nil, shared_with_prefix \\ nil, status \\ nil, options \\ [])

list_workload_shares(client, workload_id, max_results \\ nil, next_token \\ nil, shared_with_prefix \\ nil, status \\ nil, options \\ [])

list_workloads(client, input, options \\ [])

metadata()

tag_resource(client, workload_arn, input, options \\ [])

untag_resource(client, workload_arn, input, options \\ [])

update_answer(client, lens_alias, question_id, workload_id, input, options \\ [])

update_global_settings(client, input, options \\ [])

update_integration(client, workload_id, input, options \\ [])

update_lens_review(client, lens_alias, workload_id, input, options \\ [])

update_profile(client, profile_arn, input, options \\ [])

update_review_template(client, template_arn, input, options \\ [])

update_review_template_answer(client, lens_alias, question_id, template_arn, input, options \\ [])

update_review_template_lens_review(client, lens_alias, template_arn, input, options \\ [])

View Source AWS.WellArchitected (aws-elixir v1.0.4)

disclaimer
Disclaimer

disclaimer
Disclaimer

disclaimer
Disclaimer

disclaimer
Disclaimer

disclaimer
Disclaimer

disclaimer
Disclaimer

disclaimer
Disclaimer

disclaimer
Disclaimer

disclaimer
Disclaimer