aws-elixir v0.9.0

AWS.WellArchitected (aws-elixir v0.9.0) View Source

AWS Well-Architected Tool

This is the AWS Well-Architected Tool API Reference.

The AWS Well-Architected Tool API provides programmatic access to the AWS Well-Architected Tool in the AWS Management Console. For information about the AWS Well-Architected Tool, see the AWS Well-Architected Tool User Guide.

Link to this section Summary

Functions

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

Associate a lens to a workload.

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

Create a milestone for an existing workload.

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

Create a new workload.

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

Create a workload share.

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.

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

Get lens version differences.

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

Get a milestone for an existing workload.

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

Get an existing workload.

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

List of answers.

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

List lens review improvements.

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

List lens reviews.

list_lenses(client, 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_share_invitations(client, max_results \\ nil, next_token \\ nil, workload_name_prefix \\ nil, options \\ [])

List the workload invitations.

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

List the tags for a resource.

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

List the workload shares associated with the workload.

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

List workloads.

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

Adds one or more tags to the specified resource.

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

Deletes specified tags from a resource.

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

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

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

Update lens review.

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

Update a workload invitation.

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.

Link to this section Functions

Link to this function

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

View Source

Associate a lens to a workload.

Link to this function

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

View Source

Create a milestone for an existing workload.

Link to this function

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

View Source

Create a new workload.

The owner of a workload can share the workload with other AWS accounts and IAM users in the same AWS Region. Only the owner of a workload can delete it.

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

Link to this function

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

View Source

Create a workload share.

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

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

Link to this function

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

View Source

Delete an existing workload.

Link to this function

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

View Source

Delete a workload share.

Link to this function

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

View Source

Disassociate a lens from a workload.

The AWS Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.

Link to this function

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

View Source

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

Link to this function

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

View Source

Get lens review.

Link to this function

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

View Source

Get lens review report.

Link to this function

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

View Source

Get lens version differences.

Link to this function

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

View Source

Get a milestone for an existing workload.

Link to this function

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

View Source

Get an existing workload.

Link to this function

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

View Source

List of answers.

Link to this function

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

View Source

List lens review improvements.

Link to this function

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

View Source

List lens reviews.

Link to this function

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

View Source

List the available lenses.

Link to this function

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

View Source

List all milestones for an existing workload.

Link to this function

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

View Source

List lens notifications.

Link to this function

list_share_invitations(client, max_results \\ nil, next_token \\ nil, workload_name_prefix \\ nil, options \\ [])

View Source

List the workload invitations.

Link to this function

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

View Source

List the tags for a resource.

Link to this function

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

View Source

List the workload shares associated with the workload.

Link to this function

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

View Source

List workloads.

Paginated.

Link to this function

metadata()

View Source
Link to this function

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

View Source

Adds one or more tags to the specified resource.

Link to this function

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

View Source

Deletes specified tags from a resource.

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

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

Link to this function

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

View Source

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

Link to this function

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

View Source

Update lens review.

Link to this function

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

View Source

Update a workload invitation.

Link to this function

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

View Source

Update an existing workload.

Link to this function

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

View Source

Update a workload share.

Link to this function

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

View Source

Upgrade lens review.