Wellarchitected

associate_lenses(lens_aliases, workload_id)
associate_lenses(lens_aliases, workload_id, params::Dict{String,<:Any})

Associate a lens to a workload.

Arguments

• lens_aliases:
• workload_id:

create_milestone(client_request_token, milestone_name, workload_id)
create_milestone(client_request_token, milestone_name, workload_id, params::Dict{String,<:Any})

Create a milestone for an existing workload.

Arguments

• client_request_token:
• milestone_name:
• workload_id:

create_workload(client_request_token, description, environment, lenses, review_owner, workload_name)
create_workload(client_request_token, description, environment, lenses, review_owner, workload_name, params::Dict{String,<:Any})

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.

Arguments

• client_request_token:
• description:
• environment:
• lenses:
• review_owner:
• workload_name:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AccountIds":
• "ArchitecturalDesign":
• "AwsRegions":
• "Industry":
• "IndustryType":
• "NonAwsRegions":
• "Notes":
• "PillarPriorities":
• "Tags": The tags to be associated with the workload.

create_workload_share(client_request_token, permission_type, shared_with, workload_id)
create_workload_share(client_request_token, permission_type, shared_with, workload_id, params::Dict{String,<:Any})

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.

Arguments

• client_request_token:
• permission_type:
• shared_with:
• workload_id:

delete_workload(client_request_token, workload_id)
delete_workload(client_request_token, workload_id, params::Dict{String,<:Any})

Delete an existing workload.

Arguments

• client_request_token:
• workload_id:

delete_workload_share(client_request_token, share_id, workload_id)
delete_workload_share(client_request_token, share_id, workload_id, params::Dict{String,<:Any})

Delete a workload share.

Arguments

• client_request_token:
• share_id:
• workload_id:

disassociate_lenses(lens_aliases, workload_id)
disassociate_lenses(lens_aliases, workload_id, params::Dict{String,<:Any})

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

Arguments

• lens_aliases:
• workload_id:

get_answer(lens_alias, question_id, workload_id)
get_answer(lens_alias, question_id, workload_id, params::Dict{String,<:Any})

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

Arguments

• lens_alias:
• question_id:
• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MilestoneNumber":

get_lens_review(lens_alias, workload_id)
get_lens_review(lens_alias, workload_id, params::Dict{String,<:Any})

Get lens review.

Arguments

• lens_alias:
• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MilestoneNumber":

get_lens_review_report(lens_alias, workload_id)
get_lens_review_report(lens_alias, workload_id, params::Dict{String,<:Any})

Get lens review report.

Arguments

• lens_alias:
• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MilestoneNumber":

get_lens_version_difference(base_lens_version, lens_alias)
get_lens_version_difference(base_lens_version, lens_alias, params::Dict{String,<:Any})

Get lens version differences.

Arguments

• base_lens_version: The base version of the lens.
• lens_alias:

get_milestone(milestone_number, workload_id)
get_milestone(milestone_number, workload_id, params::Dict{String,<:Any})

Get a milestone for an existing workload.

Arguments

• milestone_number:
• workload_id:

get_workload(workload_id)
get_workload(workload_id, params::Dict{String,<:Any})

Get an existing workload.

Arguments

• workload_id:

list_answers(lens_alias, workload_id)
list_answers(lens_alias, workload_id, params::Dict{String,<:Any})

List of answers.

Arguments

• lens_alias:
• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return for this request.
• "MilestoneNumber":
• "NextToken":
• "PillarId":

list_lens_review_improvements(lens_alias, workload_id)
list_lens_review_improvements(lens_alias, workload_id, params::Dict{String,<:Any})

List lens review improvements.

Arguments

• lens_alias:
• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return for this request.
• "MilestoneNumber":
• "NextToken":
• "PillarId":

list_lens_reviews(workload_id)
list_lens_reviews(workload_id, params::Dict{String,<:Any})

List lens reviews.

Arguments

• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults":
• "MilestoneNumber":
• "NextToken":

list_lenses()
list_lenses(params::Dict{String,<:Any})

List the available lenses.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults":
• "NextToken":

list_milestones(workload_id)
list_milestones(workload_id, params::Dict{String,<:Any})

List all milestones for an existing workload.

Arguments

• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults":
• "NextToken":

list_notifications()
list_notifications(params::Dict{String,<:Any})

List lens notifications.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return for this request.
• "NextToken":
• "WorkloadId":

list_share_invitations()
list_share_invitations(params::Dict{String,<:Any})

List the workload invitations.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return for this request.
• "NextToken":
• "WorkloadNamePrefix":

list_tags_for_resource(workload_arn)
list_tags_for_resource(workload_arn, params::Dict{String,<:Any})

List the tags for a resource.

Arguments

• workload_arn:

list_workload_shares(workload_id)
list_workload_shares(workload_id, params::Dict{String,<:Any})

List the workload shares associated with the workload.

Arguments

• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return for this request.
• "NextToken":
• "SharedWithPrefix": The AWS account ID or IAM role with which the workload is shared.

list_workloads()
list_workloads(params::Dict{String,<:Any})

List workloads. Paginated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return for this request.
• "NextToken":
• "WorkloadNamePrefix":

tag_resource(tags, workload_arn)
tag_resource(tags, workload_arn, params::Dict{String,<:Any})

Adds one or more tags to the specified resource.

Arguments

• tags: The tags for the resource.
• workload_arn:

untag_resource(workload_arn, tag_keys)
untag_resource(workload_arn, tag_keys, params::Dict{String,<:Any})

Deletes specified tags from a resource. To specify multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

Arguments

• workload_arn:
• tag_keys: A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.

update_answer(lens_alias, question_id, workload_id)
update_answer(lens_alias, question_id, workload_id, params::Dict{String,<:Any})

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

Arguments

• lens_alias:
• question_id:
• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ChoiceUpdates": A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.
• "IsApplicable":
• "Notes":
• "Reason": The reason why a question is not applicable to your workload.
• "SelectedChoices":

update_lens_review(lens_alias, workload_id)
update_lens_review(lens_alias, workload_id, params::Dict{String,<:Any})

Update lens review.

Arguments

• lens_alias:
• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "LensNotes":
• "PillarNotes":

update_share_invitation(share_invitation_action, share_invitation_id)
update_share_invitation(share_invitation_action, share_invitation_id, params::Dict{String,<:Any})

Update a workload invitation.

Arguments

• share_invitation_action:
• share_invitation_id: The ID assigned to the share invitation.

update_workload(workload_id)
update_workload(workload_id, params::Dict{String,<:Any})

Update an existing workload.

Arguments

• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AccountIds":
• "ArchitecturalDesign":
• "AwsRegions":
• "Description":
• "Environment":
• "ImprovementStatus":
• "Industry":
• "IndustryType":
• "IsReviewOwnerUpdateAcknowledged": Flag indicating whether the workload owner has acknowledged that the Review owner field is required. If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.
• "NonAwsRegions":
• "Notes":
• "PillarPriorities":
• "ReviewOwner":
• "WorkloadName":

update_workload_share(permission_type, share_id, workload_id)
update_workload_share(permission_type, share_id, workload_id, params::Dict{String,<:Any})

Update a workload share.

Arguments

• permission_type:
• share_id:
• workload_id:

upgrade_lens_review(lens_alias, milestone_name, workload_id)
upgrade_lens_review(lens_alias, milestone_name, workload_id, params::Dict{String,<:Any})

Upgrade lens review.

Arguments

• lens_alias:
• milestone_name:
• workload_id:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "ClientRequestToken":