Skip to content

WellArchitectedClient

Index > WellArchitected > WellArchitectedClient

Auto-generated documentation for WellArchitected type annotations stubs module types-aiobotocore-wellarchitected.

WellArchitectedClient

Type annotations and code completion for session.client("wellarchitected") boto3 documentation

Usage example
from aioboto3.session import Session
from types_aiobotocore_wellarchitected.client import WellArchitectedClient

session = Session()
async with session.client("wellarchitected") as client:
    client: WellArchitectedClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("wellarchitected").exceptions structure.

Usage example
async with session.client("wellarchitected") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.ConflictException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ServiceQuotaExceededException,
        client.ThrottlingException,
        client.ValidationException,
    ) as e:
        print(e)
Type checking example
from types_aiobotocore_wellarchitected.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

associate_lenses

Associate a lens to a workload.

Type annotations and code completion for session.client("wellarchitected").associate_lenses method. boto3 documentation

Method definition
await def associate_lenses(
    self,
    *,
    WorkloadId: str,
    LensAliases: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: AssociateLensesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAliases": ...,
}

parent.associate_lenses(**kwargs)
  1. See AssociateLensesInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.client("wellarchitected").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for session.client("wellarchitected").close method. boto3 documentation

Method definition
await def close(
    self,
) -> None:
    ...

create_lens_share

Create a lens share.

Type annotations and code completion for session.client("wellarchitected").create_lens_share method. boto3 documentation

Method definition
await def create_lens_share(
    self,
    *,
    LensAlias: str,
    SharedWith: str,
    ClientRequestToken: str,
) -> CreateLensShareOutputTypeDef:  # (1)
    ...
  1. See CreateLensShareOutputTypeDef
Usage example with kwargs
kwargs: CreateLensShareInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
    "SharedWith": ...,
    "ClientRequestToken": ...,
}

parent.create_lens_share(**kwargs)
  1. See CreateLensShareInputRequestTypeDef

create_lens_version

Create a new lens version.

Type annotations and code completion for session.client("wellarchitected").create_lens_version method. boto3 documentation

Method definition
await def create_lens_version(
    self,
    *,
    LensAlias: str,
    LensVersion: str,
    ClientRequestToken: str,
    IsMajorVersion: bool = ...,
) -> CreateLensVersionOutputTypeDef:  # (1)
    ...
  1. See CreateLensVersionOutputTypeDef
Usage example with kwargs
kwargs: CreateLensVersionInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
    "LensVersion": ...,
    "ClientRequestToken": ...,
}

parent.create_lens_version(**kwargs)
  1. See CreateLensVersionInputRequestTypeDef

create_milestone

Create a milestone for an existing workload.

Type annotations and code completion for session.client("wellarchitected").create_milestone method. boto3 documentation

Method definition
await def create_milestone(
    self,
    *,
    WorkloadId: str,
    MilestoneName: str,
    ClientRequestToken: str,
) -> CreateMilestoneOutputTypeDef:  # (1)
    ...
  1. See CreateMilestoneOutputTypeDef
Usage example with kwargs
kwargs: CreateMilestoneInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "MilestoneName": ...,
    "ClientRequestToken": ...,
}

parent.create_milestone(**kwargs)
  1. See CreateMilestoneInputRequestTypeDef

create_workload

Create a new workload.

Type annotations and code completion for session.client("wellarchitected").create_workload method. boto3 documentation

Method definition
await def create_workload(
    self,
    *,
    WorkloadName: str,
    Description: str,
    Environment: WorkloadEnvironmentType,  # (1)
    Lenses: Sequence[str],
    ClientRequestToken: str,
    AccountIds: Sequence[str] = ...,
    AwsRegions: Sequence[str] = ...,
    NonAwsRegions: Sequence[str] = ...,
    PillarPriorities: Sequence[str] = ...,
    ArchitecturalDesign: str = ...,
    ReviewOwner: str = ...,
    IndustryType: str = ...,
    Industry: str = ...,
    Notes: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateWorkloadOutputTypeDef:  # (2)
    ...
  1. See WorkloadEnvironmentType
  2. See CreateWorkloadOutputTypeDef
Usage example with kwargs
kwargs: CreateWorkloadInputRequestTypeDef = {  # (1)
    "WorkloadName": ...,
    "Description": ...,
    "Environment": ...,
    "Lenses": ...,
    "ClientRequestToken": ...,
}

parent.create_workload(**kwargs)
  1. See CreateWorkloadInputRequestTypeDef

create_workload_share

Create a workload share.

Type annotations and code completion for session.client("wellarchitected").create_workload_share method. boto3 documentation

Method definition
await def create_workload_share(
    self,
    *,
    WorkloadId: str,
    SharedWith: str,
    PermissionType: PermissionTypeType,  # (1)
    ClientRequestToken: str,
) -> CreateWorkloadShareOutputTypeDef:  # (2)
    ...
  1. See PermissionTypeType
  2. See CreateWorkloadShareOutputTypeDef
Usage example with kwargs
kwargs: CreateWorkloadShareInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "SharedWith": ...,
    "PermissionType": ...,
    "ClientRequestToken": ...,
}

parent.create_workload_share(**kwargs)
  1. See CreateWorkloadShareInputRequestTypeDef

delete_lens

Delete an existing lens.

Type annotations and code completion for session.client("wellarchitected").delete_lens method. boto3 documentation

Method definition
await def delete_lens(
    self,
    *,
    LensAlias: str,
    ClientRequestToken: str,
    LensStatus: LensStatusTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See LensStatusTypeType
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteLensInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
    "ClientRequestToken": ...,
    "LensStatus": ...,
}

parent.delete_lens(**kwargs)
  1. See DeleteLensInputRequestTypeDef

delete_lens_share

Delete a lens share.

Type annotations and code completion for session.client("wellarchitected").delete_lens_share method. boto3 documentation

Method definition
await def delete_lens_share(
    self,
    *,
    ShareId: str,
    LensAlias: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteLensShareInputRequestTypeDef = {  # (1)
    "ShareId": ...,
    "LensAlias": ...,
    "ClientRequestToken": ...,
}

parent.delete_lens_share(**kwargs)
  1. See DeleteLensShareInputRequestTypeDef

delete_workload

Delete an existing workload.

Type annotations and code completion for session.client("wellarchitected").delete_workload method. boto3 documentation

Method definition
await def delete_workload(
    self,
    *,
    WorkloadId: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteWorkloadInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "ClientRequestToken": ...,
}

parent.delete_workload(**kwargs)
  1. See DeleteWorkloadInputRequestTypeDef

delete_workload_share

Delete a workload share.

Type annotations and code completion for session.client("wellarchitected").delete_workload_share method. boto3 documentation

Method definition
await def delete_workload_share(
    self,
    *,
    ShareId: str,
    WorkloadId: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DeleteWorkloadShareInputRequestTypeDef = {  # (1)
    "ShareId": ...,
    "WorkloadId": ...,
    "ClientRequestToken": ...,
}

parent.delete_workload_share(**kwargs)
  1. See DeleteWorkloadShareInputRequestTypeDef

disassociate_lenses

Disassociate a lens from a workload.

Type annotations and code completion for session.client("wellarchitected").disassociate_lenses method. boto3 documentation

Method definition
await def disassociate_lenses(
    self,
    *,
    WorkloadId: str,
    LensAliases: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: DisassociateLensesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAliases": ...,
}

parent.disassociate_lenses(**kwargs)
  1. See DisassociateLensesInputRequestTypeDef

export_lens

Export an existing lens.

Type annotations and code completion for session.client("wellarchitected").export_lens method. boto3 documentation

Method definition
await def export_lens(
    self,
    *,
    LensAlias: str,
    LensVersion: str = ...,
) -> ExportLensOutputTypeDef:  # (1)
    ...
  1. See ExportLensOutputTypeDef
Usage example with kwargs
kwargs: ExportLensInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
}

parent.export_lens(**kwargs)
  1. See ExportLensInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for session.client("wellarchitected").generate_presigned_url method. boto3 documentation

Method definition
await def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_answer

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

Type annotations and code completion for session.client("wellarchitected").get_answer method. boto3 documentation

Method definition
await def get_answer(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    QuestionId: str,
    MilestoneNumber: int = ...,
) -> GetAnswerOutputTypeDef:  # (1)
    ...
  1. See GetAnswerOutputTypeDef
Usage example with kwargs
kwargs: GetAnswerInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
    "QuestionId": ...,
}

parent.get_answer(**kwargs)
  1. See GetAnswerInputRequestTypeDef

get_lens

Get an existing lens.

Type annotations and code completion for session.client("wellarchitected").get_lens method. boto3 documentation

Method definition
await def get_lens(
    self,
    *,
    LensAlias: str,
    LensVersion: str = ...,
) -> GetLensOutputTypeDef:  # (1)
    ...
  1. See GetLensOutputTypeDef
Usage example with kwargs
kwargs: GetLensInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
}

parent.get_lens(**kwargs)
  1. See GetLensInputRequestTypeDef

get_lens_review

Get lens review.

Type annotations and code completion for session.client("wellarchitected").get_lens_review method. boto3 documentation

Method definition
await def get_lens_review(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    MilestoneNumber: int = ...,
) -> GetLensReviewOutputTypeDef:  # (1)
    ...
  1. See GetLensReviewOutputTypeDef
Usage example with kwargs
kwargs: GetLensReviewInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
}

parent.get_lens_review(**kwargs)
  1. See GetLensReviewInputRequestTypeDef

get_lens_review_report

Get lens review report.

Type annotations and code completion for session.client("wellarchitected").get_lens_review_report method. boto3 documentation

Method definition
await def get_lens_review_report(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    MilestoneNumber: int = ...,
) -> GetLensReviewReportOutputTypeDef:  # (1)
    ...
  1. See GetLensReviewReportOutputTypeDef
Usage example with kwargs
kwargs: GetLensReviewReportInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
}

parent.get_lens_review_report(**kwargs)
  1. See GetLensReviewReportInputRequestTypeDef

get_lens_version_difference

Get lens version differences.

Type annotations and code completion for session.client("wellarchitected").get_lens_version_difference method. boto3 documentation

Method definition
await def get_lens_version_difference(
    self,
    *,
    LensAlias: str,
    BaseLensVersion: str = ...,
    TargetLensVersion: str = ...,
) -> GetLensVersionDifferenceOutputTypeDef:  # (1)
    ...
  1. See GetLensVersionDifferenceOutputTypeDef
Usage example with kwargs
kwargs: GetLensVersionDifferenceInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
}

parent.get_lens_version_difference(**kwargs)
  1. See GetLensVersionDifferenceInputRequestTypeDef

get_milestone

Get a milestone for an existing workload.

Type annotations and code completion for session.client("wellarchitected").get_milestone method. boto3 documentation

Method definition
await def get_milestone(
    self,
    *,
    WorkloadId: str,
    MilestoneNumber: int,
) -> GetMilestoneOutputTypeDef:  # (1)
    ...
  1. See GetMilestoneOutputTypeDef
Usage example with kwargs
kwargs: GetMilestoneInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "MilestoneNumber": ...,
}

parent.get_milestone(**kwargs)
  1. See GetMilestoneInputRequestTypeDef

get_workload

Get an existing workload.

Type annotations and code completion for session.client("wellarchitected").get_workload method. boto3 documentation

Method definition
await def get_workload(
    self,
    *,
    WorkloadId: str,
) -> GetWorkloadOutputTypeDef:  # (1)
    ...
  1. See GetWorkloadOutputTypeDef
Usage example with kwargs
kwargs: GetWorkloadInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

parent.get_workload(**kwargs)
  1. See GetWorkloadInputRequestTypeDef

import_lens

Import a new lens.

Type annotations and code completion for session.client("wellarchitected").import_lens method. boto3 documentation

Method definition
await def import_lens(
    self,
    *,
    JSONString: str,
    ClientRequestToken: str,
    LensAlias: str = ...,
    Tags: Mapping[str, str] = ...,
) -> ImportLensOutputTypeDef:  # (1)
    ...
  1. See ImportLensOutputTypeDef
Usage example with kwargs
kwargs: ImportLensInputRequestTypeDef = {  # (1)
    "JSONString": ...,
    "ClientRequestToken": ...,
}

parent.import_lens(**kwargs)
  1. See ImportLensInputRequestTypeDef

list_answers

List of answers.

Type annotations and code completion for session.client("wellarchitected").list_answers method. boto3 documentation

Method definition
await def list_answers(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    PillarId: str = ...,
    MilestoneNumber: int = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListAnswersOutputTypeDef:  # (1)
    ...
  1. See ListAnswersOutputTypeDef
Usage example with kwargs
kwargs: ListAnswersInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
}

parent.list_answers(**kwargs)
  1. See ListAnswersInputRequestTypeDef

list_lens_review_improvements

List lens review improvements.

Type annotations and code completion for session.client("wellarchitected").list_lens_review_improvements method. boto3 documentation

Method definition
await def list_lens_review_improvements(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    PillarId: str = ...,
    MilestoneNumber: int = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListLensReviewImprovementsOutputTypeDef:  # (1)
    ...
  1. See ListLensReviewImprovementsOutputTypeDef
Usage example with kwargs
kwargs: ListLensReviewImprovementsInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
}

parent.list_lens_review_improvements(**kwargs)
  1. See ListLensReviewImprovementsInputRequestTypeDef

list_lens_reviews

List lens reviews.

Type annotations and code completion for session.client("wellarchitected").list_lens_reviews method. boto3 documentation

Method definition
await def list_lens_reviews(
    self,
    *,
    WorkloadId: str,
    MilestoneNumber: int = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListLensReviewsOutputTypeDef:  # (1)
    ...
  1. See ListLensReviewsOutputTypeDef
Usage example with kwargs
kwargs: ListLensReviewsInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

parent.list_lens_reviews(**kwargs)
  1. See ListLensReviewsInputRequestTypeDef

list_lens_shares

List the lens shares associated with the lens.

Type annotations and code completion for session.client("wellarchitected").list_lens_shares method. boto3 documentation

Method definition
await def list_lens_shares(
    self,
    *,
    LensAlias: str,
    SharedWithPrefix: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: ShareStatusType = ...,  # (1)
) -> ListLensSharesOutputTypeDef:  # (2)
    ...
  1. See ShareStatusType
  2. See ListLensSharesOutputTypeDef
Usage example with kwargs
kwargs: ListLensSharesInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
}

parent.list_lens_shares(**kwargs)
  1. See ListLensSharesInputRequestTypeDef

list_lenses

List the available lenses.

Type annotations and code completion for session.client("wellarchitected").list_lenses method. boto3 documentation

Method definition
await def list_lenses(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    LensType: LensTypeType = ...,  # (1)
    LensStatus: LensStatusTypeType = ...,  # (2)
    LensName: str = ...,
) -> ListLensesOutputTypeDef:  # (3)
    ...
  1. See LensTypeType
  2. See LensStatusTypeType
  3. See ListLensesOutputTypeDef
Usage example with kwargs
kwargs: ListLensesInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_lenses(**kwargs)
  1. See ListLensesInputRequestTypeDef

list_milestones

List all milestones for an existing workload.

Type annotations and code completion for session.client("wellarchitected").list_milestones method. boto3 documentation

Method definition
await def list_milestones(
    self,
    *,
    WorkloadId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMilestonesOutputTypeDef:  # (1)
    ...
  1. See ListMilestonesOutputTypeDef
Usage example with kwargs
kwargs: ListMilestonesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

parent.list_milestones(**kwargs)
  1. See ListMilestonesInputRequestTypeDef

list_notifications

List lens notifications.

Type annotations and code completion for session.client("wellarchitected").list_notifications method. boto3 documentation

Method definition
await def list_notifications(
    self,
    *,
    WorkloadId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListNotificationsOutputTypeDef:  # (1)
    ...
  1. See ListNotificationsOutputTypeDef
Usage example with kwargs
kwargs: ListNotificationsInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

parent.list_notifications(**kwargs)
  1. See ListNotificationsInputRequestTypeDef

list_share_invitations

List the workload invitations.

Type annotations and code completion for session.client("wellarchitected").list_share_invitations method. boto3 documentation

Method definition
await def list_share_invitations(
    self,
    *,
    WorkloadNamePrefix: str = ...,
    LensNamePrefix: str = ...,
    ShareResourceType: ShareResourceTypeType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListShareInvitationsOutputTypeDef:  # (2)
    ...
  1. See ShareResourceTypeType
  2. See ListShareInvitationsOutputTypeDef
Usage example with kwargs
kwargs: ListShareInvitationsInputRequestTypeDef = {  # (1)
    "WorkloadNamePrefix": ...,
}

parent.list_share_invitations(**kwargs)
  1. See ListShareInvitationsInputRequestTypeDef

list_tags_for_resource

List the tags for a resource.

Type annotations and code completion for session.client("wellarchitected").list_tags_for_resource method. boto3 documentation

Method definition
await def list_tags_for_resource(
    self,
    *,
    WorkloadArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef
Usage example with kwargs
kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "WorkloadArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceInputRequestTypeDef

list_workload_shares

List the workload shares associated with the workload.

Type annotations and code completion for session.client("wellarchitected").list_workload_shares method. boto3 documentation

Method definition
await def list_workload_shares(
    self,
    *,
    WorkloadId: str,
    SharedWithPrefix: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: ShareStatusType = ...,  # (1)
) -> ListWorkloadSharesOutputTypeDef:  # (2)
    ...
  1. See ShareStatusType
  2. See ListWorkloadSharesOutputTypeDef
Usage example with kwargs
kwargs: ListWorkloadSharesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

parent.list_workload_shares(**kwargs)
  1. See ListWorkloadSharesInputRequestTypeDef

list_workloads

List workloads.

Type annotations and code completion for session.client("wellarchitected").list_workloads method. boto3 documentation

Method definition
await def list_workloads(
    self,
    *,
    WorkloadNamePrefix: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWorkloadsOutputTypeDef:  # (1)
    ...
  1. See ListWorkloadsOutputTypeDef
Usage example with kwargs
kwargs: ListWorkloadsInputRequestTypeDef = {  # (1)
    "WorkloadNamePrefix": ...,
}

parent.list_workloads(**kwargs)
  1. See ListWorkloadsInputRequestTypeDef

tag_resource

Adds one or more tags to the specified resource.

Type annotations and code completion for session.client("wellarchitected").tag_resource method. boto3 documentation

Method definition
await def tag_resource(
    self,
    *,
    WorkloadArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "WorkloadArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceInputRequestTypeDef

untag_resource

Deletes specified tags from a resource.

Type annotations and code completion for session.client("wellarchitected").untag_resource method. boto3 documentation

Method definition
await def untag_resource(
    self,
    *,
    WorkloadArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "WorkloadArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceInputRequestTypeDef

update_answer

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

Type annotations and code completion for session.client("wellarchitected").update_answer method. boto3 documentation

Method definition
await def update_answer(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    QuestionId: str,
    SelectedChoices: Sequence[str] = ...,
    ChoiceUpdates: Mapping[str, ChoiceUpdateTypeDef] = ...,  # (1)
    Notes: str = ...,
    IsApplicable: bool = ...,
    Reason: AnswerReasonType = ...,  # (2)
) -> UpdateAnswerOutputTypeDef:  # (3)
    ...
  1. See ChoiceUpdateTypeDef
  2. See AnswerReasonType
  3. See UpdateAnswerOutputTypeDef
Usage example with kwargs
kwargs: UpdateAnswerInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
    "QuestionId": ...,
}

parent.update_answer(**kwargs)
  1. See UpdateAnswerInputRequestTypeDef

update_global_settings

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

Type annotations and code completion for session.client("wellarchitected").update_global_settings method. boto3 documentation

Method definition
await def update_global_settings(
    self,
    *,
    OrganizationSharingStatus: OrganizationSharingStatusType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See OrganizationSharingStatusType
  2. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: UpdateGlobalSettingsInputRequestTypeDef = {  # (1)
    "OrganizationSharingStatus": ...,
}

parent.update_global_settings(**kwargs)
  1. See UpdateGlobalSettingsInputRequestTypeDef

update_lens_review

Update lens review.

Type annotations and code completion for session.client("wellarchitected").update_lens_review method. boto3 documentation

Method definition
await def update_lens_review(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    LensNotes: str = ...,
    PillarNotes: Mapping[str, str] = ...,
) -> UpdateLensReviewOutputTypeDef:  # (1)
    ...
  1. See UpdateLensReviewOutputTypeDef
Usage example with kwargs
kwargs: UpdateLensReviewInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
}

parent.update_lens_review(**kwargs)
  1. See UpdateLensReviewInputRequestTypeDef

update_share_invitation

Update a workload invitation.

Type annotations and code completion for session.client("wellarchitected").update_share_invitation method. boto3 documentation

Method definition
await def update_share_invitation(
    self,
    *,
    ShareInvitationId: str,
    ShareInvitationAction: ShareInvitationActionType,  # (1)
) -> UpdateShareInvitationOutputTypeDef:  # (2)
    ...
  1. See ShareInvitationActionType
  2. See UpdateShareInvitationOutputTypeDef
Usage example with kwargs
kwargs: UpdateShareInvitationInputRequestTypeDef = {  # (1)
    "ShareInvitationId": ...,
    "ShareInvitationAction": ...,
}

parent.update_share_invitation(**kwargs)
  1. See UpdateShareInvitationInputRequestTypeDef

update_workload

Update an existing workload.

Type annotations and code completion for session.client("wellarchitected").update_workload method. boto3 documentation

Method definition
await def update_workload(
    self,
    *,
    WorkloadId: str,
    WorkloadName: str = ...,
    Description: str = ...,
    Environment: WorkloadEnvironmentType = ...,  # (1)
    AccountIds: Sequence[str] = ...,
    AwsRegions: Sequence[str] = ...,
    NonAwsRegions: Sequence[str] = ...,
    PillarPriorities: Sequence[str] = ...,
    ArchitecturalDesign: str = ...,
    ReviewOwner: str = ...,
    IsReviewOwnerUpdateAcknowledged: bool = ...,
    IndustryType: str = ...,
    Industry: str = ...,
    Notes: str = ...,
    ImprovementStatus: WorkloadImprovementStatusType = ...,  # (2)
) -> UpdateWorkloadOutputTypeDef:  # (3)
    ...
  1. See WorkloadEnvironmentType
  2. See WorkloadImprovementStatusType
  3. See UpdateWorkloadOutputTypeDef
Usage example with kwargs
kwargs: UpdateWorkloadInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

parent.update_workload(**kwargs)
  1. See UpdateWorkloadInputRequestTypeDef

update_workload_share

Update a workload share.

Type annotations and code completion for session.client("wellarchitected").update_workload_share method. boto3 documentation

Method definition
await def update_workload_share(
    self,
    *,
    ShareId: str,
    WorkloadId: str,
    PermissionType: PermissionTypeType,  # (1)
) -> UpdateWorkloadShareOutputTypeDef:  # (2)
    ...
  1. See PermissionTypeType
  2. See UpdateWorkloadShareOutputTypeDef
Usage example with kwargs
kwargs: UpdateWorkloadShareInputRequestTypeDef = {  # (1)
    "ShareId": ...,
    "WorkloadId": ...,
    "PermissionType": ...,
}

parent.update_workload_share(**kwargs)
  1. See UpdateWorkloadShareInputRequestTypeDef

upgrade_lens_review

Upgrade lens review.

Type annotations and code completion for session.client("wellarchitected").upgrade_lens_review method. boto3 documentation

Method definition
await def upgrade_lens_review(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    MilestoneName: str,
    ClientRequestToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
Usage example with kwargs
kwargs: UpgradeLensReviewInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
    "MilestoneName": ...,
}

parent.upgrade_lens_review(**kwargs)
  1. See UpgradeLensReviewInputRequestTypeDef

__aenter__

Type annotations and code completion for session.client("wellarchitected").__aenter__ method. boto3 documentation

Method definition
await def __aenter__(
    self,
) -> WellArchitectedClient:
    ...

__aexit__

Type annotations and code completion for session.client("wellarchitected").__aexit__ method. boto3 documentation

Method definition
await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...