aws v0.3.1

View Source aws_wellarchitected (aws v0.3.1)

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, WorkloadId, Input)
Associate a lens to a workload.
associate_lenses(Client, WorkloadId, Input0, Options0)
create_milestone(Client, WorkloadId, Input)
Create a milestone for an existing workload.
create_milestone(Client, WorkloadId, Input0, Options0)
create_workload(Client, Input)

Create a new workload.

create_workload(Client, Input0, Options0)
create_workload_share(Client, WorkloadId, Input)

Create a workload share.

create_workload_share(Client, WorkloadId, Input0, Options0)
delete_workload(Client, WorkloadId, Input)
Delete an existing workload.
delete_workload(Client, WorkloadId, Input0, Options0)
delete_workload_share(Client, ShareId, WorkloadId, Input)
Delete a workload share.
delete_workload_share(Client, ShareId, WorkloadId, Input0, Options0)
disassociate_lenses(Client, WorkloadId, Input)

Disassociate a lens from a workload.

disassociate_lenses(Client, WorkloadId, Input0, Options0)
get_answer(Client, LensAlias, QuestionId, WorkloadId)
Get lens review.
get_answer(Client, LensAlias, QuestionId, WorkloadId, QueryMap, HeadersMap)
get_answer(Client, LensAlias, QuestionId, WorkloadId, QueryMap, HeadersMap, Options0)
get_lens_review(Client, LensAlias, WorkloadId)
Get lens review.
get_lens_review(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)
get_lens_review(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)
get_lens_review_report(Client, LensAlias, WorkloadId)
Get lens review report.
get_lens_review_report(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)
get_lens_review_report(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)
get_lens_version_difference(Client, LensAlias, BaseLensVersion)
Get lens version differences.
get_lens_version_difference(Client, LensAlias, BaseLensVersion, QueryMap, HeadersMap)
get_lens_version_difference(Client, LensAlias, BaseLensVersion, QueryMap, HeadersMap, Options0)
get_milestone(Client, MilestoneNumber, WorkloadId)
Get a milestone for an existing workload.
get_milestone(Client, MilestoneNumber, WorkloadId, QueryMap, HeadersMap)
get_milestone(Client, MilestoneNumber, WorkloadId, QueryMap, HeadersMap, Options0)
get_workload(Client, WorkloadId)
Get an existing workload.
get_workload(Client, WorkloadId, QueryMap, HeadersMap)
get_workload(Client, WorkloadId, QueryMap, HeadersMap, Options0)
list_answers(Client, LensAlias, WorkloadId)
List of answers.
list_answers(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)
list_answers(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)
list_lens_review_improvements(Client, LensAlias, WorkloadId)
List lens review improvements.
list_lens_review_improvements(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)
list_lens_review_improvements(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)
list_lens_reviews(Client, WorkloadId)
List lens reviews.
list_lens_reviews(Client, WorkloadId, QueryMap, HeadersMap)
list_lens_reviews(Client, WorkloadId, QueryMap, HeadersMap, Options0)
list_lenses(Client)
List the available lenses.
list_lenses(Client, QueryMap, HeadersMap)
list_lenses(Client, QueryMap, HeadersMap, Options0)
list_milestones(Client, WorkloadId, Input)
List all milestones for an existing workload.
list_milestones(Client, WorkloadId, Input0, Options0)
list_notifications(Client, Input)
List lens notifications.
list_notifications(Client, Input0, Options0)
list_share_invitations(Client)
List the workload invitations.
list_share_invitations(Client, QueryMap, HeadersMap)
list_share_invitations(Client, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, WorkloadArn)
List the tags for a resource.
list_tags_for_resource(Client, WorkloadArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, WorkloadArn, QueryMap, HeadersMap, Options0)
list_workload_shares(Client, WorkloadId)
List the workload shares associated with the workload.
list_workload_shares(Client, WorkloadId, QueryMap, HeadersMap)
list_workload_shares(Client, WorkloadId, QueryMap, HeadersMap, Options0)
list_workloads(Client, Input)

List workloads.

list_workloads(Client, Input0, Options0)
tag_resource(Client, WorkloadArn, Input)
Adds one or more tags to the specified resource.
tag_resource(Client, WorkloadArn, Input0, Options0)
untag_resource(Client, WorkloadArn, Input)
Deletes specified tags from a resource.
untag_resource(Client, WorkloadArn, Input0, Options0)
update_answer(Client, LensAlias, QuestionId, WorkloadId, Input)
Update the answer to a specific question in a workload review.
update_answer(Client, LensAlias, QuestionId, WorkloadId, Input0, Options0)
update_lens_review(Client, LensAlias, WorkloadId, Input)
Update lens review.
update_lens_review(Client, LensAlias, WorkloadId, Input0, Options0)
update_share_invitation(Client, ShareInvitationId, Input)
Update a workload invitation.
update_share_invitation(Client, ShareInvitationId, Input0, Options0)
update_workload(Client, WorkloadId, Input)
Update an existing workload.
update_workload(Client, WorkloadId, Input0, Options0)
update_workload_share(Client, ShareId, WorkloadId, Input)
Update a workload share.
update_workload_share(Client, ShareId, WorkloadId, Input0, Options0)
upgrade_lens_review(Client, LensAlias, WorkloadId, Input)
Upgrade lens review.
upgrade_lens_review(Client, LensAlias, WorkloadId, Input0, Options0)

Link to this section Functions

Link to this function

associate_lenses(Client, WorkloadId, Input)

View Source
Associate a lens to a workload.
Link to this function

associate_lenses(Client, WorkloadId, Input0, Options0)

View Source
Link to this function

create_milestone(Client, WorkloadId, Input)

View Source
Create a milestone for an existing workload.
Link to this function

create_milestone(Client, WorkloadId, Input0, Options0)

View Source
Link to this function

create_workload(Client, Input)

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(Client, Input0, Options0)

View Source
Link to this function

create_workload_share(Client, WorkloadId, Input)

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

create_workload_share(Client, WorkloadId, Input0, Options0)

View Source
Link to this function

delete_workload(Client, WorkloadId, Input)

View Source
Delete an existing workload.
Link to this function

delete_workload(Client, WorkloadId, Input0, Options0)

View Source
Link to this function

delete_workload_share(Client, ShareId, WorkloadId, Input)

View Source
Delete a workload share.
Link to this function

delete_workload_share(Client, ShareId, WorkloadId, Input0, Options0)

View Source
Link to this function

disassociate_lenses(Client, WorkloadId, Input)

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

disassociate_lenses(Client, WorkloadId, Input0, Options0)

View Source
Link to this function

get_answer(Client, LensAlias, QuestionId, WorkloadId)

View Source
Get lens review.
Link to this function

get_answer(Client, LensAlias, QuestionId, WorkloadId, QueryMap, HeadersMap)

View Source
Link to this function

get_answer(Client, LensAlias, QuestionId, WorkloadId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_lens_review(Client, LensAlias, WorkloadId)

View Source
Get lens review.
Link to this function

get_lens_review(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)

View Source
Link to this function

get_lens_review(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_lens_review_report(Client, LensAlias, WorkloadId)

View Source
Get lens review report.
Link to this function

get_lens_review_report(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)

View Source
Link to this function

get_lens_review_report(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_lens_version_difference(Client, LensAlias, BaseLensVersion)

View Source
Get lens version differences.
Link to this function

get_lens_version_difference(Client, LensAlias, BaseLensVersion, QueryMap, HeadersMap)

View Source
Link to this function

get_lens_version_difference(Client, LensAlias, BaseLensVersion, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_milestone(Client, MilestoneNumber, WorkloadId)

View Source
Get a milestone for an existing workload.
Link to this function

get_milestone(Client, MilestoneNumber, WorkloadId, QueryMap, HeadersMap)

View Source
Link to this function

get_milestone(Client, MilestoneNumber, WorkloadId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_workload(Client, WorkloadId)

View Source
Get an existing workload.
Link to this function

get_workload(Client, WorkloadId, QueryMap, HeadersMap)

View Source
Link to this function

get_workload(Client, WorkloadId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_answers(Client, LensAlias, WorkloadId)

View Source
List of answers.
Link to this function

list_answers(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)

View Source
Link to this function

list_answers(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_lens_review_improvements(Client, LensAlias, WorkloadId)

View Source
List lens review improvements.
Link to this function

list_lens_review_improvements(Client, LensAlias, WorkloadId, QueryMap, HeadersMap)

View Source
Link to this function

list_lens_review_improvements(Client, LensAlias, WorkloadId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_lens_reviews(Client, WorkloadId)

View Source
List lens reviews.
Link to this function

list_lens_reviews(Client, WorkloadId, QueryMap, HeadersMap)

View Source
Link to this function

list_lens_reviews(Client, WorkloadId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_lenses(Client)

View Source
List the available lenses.
Link to this function

list_lenses(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_lenses(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_milestones(Client, WorkloadId, Input)

View Source
List all milestones for an existing workload.
Link to this function

list_milestones(Client, WorkloadId, Input0, Options0)

View Source
Link to this function

list_notifications(Client, Input)

View Source
List lens notifications.
Link to this function

list_notifications(Client, Input0, Options0)

View Source
Link to this function

list_share_invitations(Client)

View Source
List the workload invitations.
Link to this function

list_share_invitations(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_share_invitations(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, WorkloadArn)

View Source
List the tags for a resource.
Link to this function

list_tags_for_resource(Client, WorkloadArn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, WorkloadArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_workload_shares(Client, WorkloadId)

View Source
List the workload shares associated with the workload.
Link to this function

list_workload_shares(Client, WorkloadId, QueryMap, HeadersMap)

View Source
Link to this function

list_workload_shares(Client, WorkloadId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_workloads(Client, Input)

View Source

List workloads.

Paginated.
Link to this function

list_workloads(Client, Input0, Options0)

View Source
Link to this function

tag_resource(Client, WorkloadArn, Input)

View Source
Adds one or more tags to the specified resource.
Link to this function

tag_resource(Client, WorkloadArn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, WorkloadArn, Input)

View Source
Deletes specified tags from a resource.
Link to this function

untag_resource(Client, WorkloadArn, Input0, Options0)

View Source
Link to this function

update_answer(Client, LensAlias, QuestionId, WorkloadId, Input)

View Source
Update the answer to a specific question in a workload review.
Link to this function

update_answer(Client, LensAlias, QuestionId, WorkloadId, Input0, Options0)

View Source
Link to this function

update_lens_review(Client, LensAlias, WorkloadId, Input)

View Source
Update lens review.
Link to this function

update_lens_review(Client, LensAlias, WorkloadId, Input0, Options0)

View Source
Link to this function

update_share_invitation(Client, ShareInvitationId, Input)

View Source
Update a workload invitation.
Link to this function

update_share_invitation(Client, ShareInvitationId, Input0, Options0)

View Source
Link to this function

update_workload(Client, WorkloadId, Input)

View Source
Update an existing workload.
Link to this function

update_workload(Client, WorkloadId, Input0, Options0)

View Source
Link to this function

update_workload_share(Client, ShareId, WorkloadId, Input)

View Source
Update a workload share.
Link to this function

update_workload_share(Client, ShareId, WorkloadId, Input0, Options0)

View Source
Link to this function

upgrade_lens_review(Client, LensAlias, WorkloadId, Input)

View Source
Upgrade lens review.
Link to this function

upgrade_lens_review(Client, LensAlias, WorkloadId, Input0, Options0)

View Source