Wellarchitected

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

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

Arguments

• lens_aliases:
• workload_id:

create_lens_share(client_request_token, lens_alias, shared_with)
create_lens_share(client_request_token, lens_alias, shared_with, params::Dict{String,<:Any})

Create a lens share. The owner of a lens can share it with other Amazon Web Services accounts, IAM users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Shared access to a lens is not removed until the lens invitation is deleted. 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.

Arguments

• client_request_token:
• lens_alias:
• shared_with:

create_lens_version(client_request_token, lens_alias, lens_version)
create_lens_version(client_request_token, lens_alias, lens_version, params::Dict{String,<:Any})

Create a new lens version. A lens can have up to 100 versions. After a lens has been imported, create a new lens version to publish it. The owner of a lens can share the lens with other Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Only the owner of a lens can delete it.

Arguments

• client_request_token:
• lens_alias:
• lens_version: The version of the lens being created.

Optional Parameters

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

• "IsMajorVersion": Set to true if this new major lens version.

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, workload_name)
create_workload(client_request_token, description, environment, lenses, workload_name, params::Dict{String,<:Any})

Create a new workload. The owner of a workload can share the workload with other Amazon Web Services accounts, IAM 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.

Arguments

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

Optional Parameters

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

• "AccountIds":
• "Applications": List of AppRegistry application ARNs associated to the workload.
• "ArchitecturalDesign":
• "AwsRegions":
• "DiscoveryConfig": Well-Architected discovery configuration settings associated to the workload.
• "Industry":
• "IndustryType":
• "NonAwsRegions":
• "Notes":
• "PillarPriorities":
• "ReviewOwner":
• "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 Amazon Web Services accounts and IAM users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted. For more information, see Sharing a Workload in the Well-Architected Tool User Guide.

Arguments

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

delete_lens(client_request_token, lens_alias, lens_status)
delete_lens(client_request_token, lens_alias, lens_status, params::Dict{String,<:Any})

Delete an existing lens. Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and IAM 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 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.

Arguments

• client_request_token:
• lens_alias:
• lens_status: The status of the lens to be deleted.

delete_lens_share(client_request_token, lens_alias, share_id)
delete_lens_share(client_request_token, lens_alias, share_id, params::Dict{String,<:Any})

Delete a lens share. After the lens share is deleted, Amazon Web Services accounts, IAM 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 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.

Arguments

• client_request_token:
• lens_alias:
• share_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. 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.

Arguments

• lens_aliases:
• workload_id:

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

Export an existing lens. Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide. Only the owner of a lens can export it. 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.

Arguments

• lens_alias:

Optional Parameters

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

• "LensVersion": The lens version to be exported.

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(lens_alias)
get_lens(lens_alias, params::Dict{String,<:Any})

Get an existing lens.

Arguments

• lens_alias:

Optional Parameters

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

• "LensVersion": The lens version to be retrieved.

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(lens_alias)
get_lens_version_difference(lens_alias, params::Dict{String,<:Any})

Get lens version differences.

Arguments

• lens_alias:

Optional Parameters

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

• "BaseLensVersion": The base version of the lens.
• "TargetLensVersion": The lens version to target a difference for.

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:

import_lens(client_request_token, jsonstring)
import_lens(client_request_token, jsonstring, params::Dict{String,<:Any})

Import a new lens. 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 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.

Arguments

• client_request_token:
• jsonstring: The JSON representation of a lens.

Optional Parameters

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

• "LensAlias":
• "Tags": Tags to associate to a lens.

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_check_details(choice_id, lens_arn, pillar_id, question_id, workload_id)
list_check_details(choice_id, lens_arn, pillar_id, question_id, workload_id, params::Dict{String,<:Any})

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

Arguments

• choice_id:
• lens_arn: Well-Architected Lens ARN.
• pillar_id:
• question_id:
• workload_id:

Optional Parameters

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

• "MaxResults":
• "NextToken":

list_check_summaries(choice_id, lens_arn, pillar_id, question_id, workload_id)
list_check_summaries(choice_id, lens_arn, pillar_id, question_id, workload_id, params::Dict{String,<:Any})

List of Trusted Advisor checks summarized for all accounts related to the workload.

Arguments

• choice_id:
• lens_arn: Well-Architected Lens ARN.
• pillar_id:
• question_id:
• workload_id:

Optional Parameters

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

• "MaxResults":
• "NextToken":

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_lens_shares(lens_alias)
list_lens_shares(lens_alias, params::Dict{String,<:Any})

List the lens shares associated with the lens.

Arguments

• lens_alias:

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 Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.
• "Status":

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:

• "LensName":
• "LensStatus": The status of lenses to be returned.
• "LensType": The type of lenses to be returned.
• "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:

• "LensNamePrefix": An optional string added to the beginning of each lens name returned in the results.
• "MaxResults": The maximum number of results to return for this request.
• "NextToken":
• "ShareResourceType": The type of share invitations to be returned.
• "WorkloadNamePrefix":

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

List the tags for a resource. The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

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 Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.
• "Status":

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. The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

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

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_global_settings()
update_global_settings(params::Dict{String,<:Any})

Updates whether the Amazon Web Services account is opted into organization sharing features.

Optional Parameters

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

• "OrganizationSharingStatus": The status of organization sharing settings.

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

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":
• "Applications": List of AppRegistry application ARNs to associate to the workload.
• "ArchitecturalDesign":
• "AwsRegions":
• "Description":
• "DiscoveryConfig": Well-Architected discovery configuration settings to associate to the workload.
• "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":