Skip to content

WellArchitectedClient#

Index > WellArchitected > WellArchitectedClient

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

WellArchitectedClient#

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

# WellArchitectedClient usage example

from boto3.session import Session
from types_boto3_wellarchitected.client import WellArchitectedClient

def get_wellarchitected_client() -> WellArchitectedClient:
    return Session().client("wellarchitected")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("wellarchitected")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_wellarchitected.client import Exceptions

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

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

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

associate_lenses#

Associate a lens to a workload.

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

# associate_lenses method definition

def associate_lenses(
    self,
    *,
    WorkloadId: str,
    LensAliases: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# associate_lenses method usage example with argument unpacking

kwargs: AssociateLensesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAliases": ...,
}

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

associate_profiles#

Associate a profile with a workload.

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

# associate_profiles method definition

def associate_profiles(
    self,
    *,
    WorkloadId: str,
    ProfileArns: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# associate_profiles method usage example with argument unpacking

kwargs: AssociateProfilesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "ProfileArns": ...,
}

parent.associate_profiles(**kwargs)
  1. See AssociateProfilesInputRequestTypeDef

create_lens_share#

Create a lens share.

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

# create_lens_share method definition

def create_lens_share(
    self,
    *,
    LensAlias: str,
    SharedWith: str,
    ClientRequestToken: str,
) -> CreateLensShareOutputTypeDef:  # (1)
    ...
  1. See CreateLensShareOutputTypeDef 
# create_lens_share method usage example with argument unpacking

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 boto3.client("wellarchitected").create_lens_version method. boto3 documentation

# create_lens_version method definition

def create_lens_version(
    self,
    *,
    LensAlias: str,
    LensVersion: str,
    ClientRequestToken: str,
    IsMajorVersion: bool = ...,
) -> CreateLensVersionOutputTypeDef:  # (1)
    ...
  1. See CreateLensVersionOutputTypeDef 
# create_lens_version method usage example with argument unpacking

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 boto3.client("wellarchitected").create_milestone method. boto3 documentation

# create_milestone method definition

def create_milestone(
    self,
    *,
    WorkloadId: str,
    MilestoneName: str,
    ClientRequestToken: str,
) -> CreateMilestoneOutputTypeDef:  # (1)
    ...
  1. See CreateMilestoneOutputTypeDef 
# create_milestone method usage example with argument unpacking

kwargs: CreateMilestoneInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "MilestoneName": ...,
    "ClientRequestToken": ...,
}

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

create_profile#

Create a profile.

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

# create_profile method definition

def create_profile(
    self,
    *,
    ProfileName: str,
    ProfileDescription: str,
    ProfileQuestions: Sequence[ProfileQuestionUpdateTypeDef],  # (1)
    ClientRequestToken: str,
    Tags: Mapping[str, str] = ...,
) -> CreateProfileOutputTypeDef:  # (2)
    ...
  1. See ProfileQuestionUpdateTypeDef
  2. See CreateProfileOutputTypeDef 
# create_profile method usage example with argument unpacking

kwargs: CreateProfileInputRequestTypeDef = {  # (1)
    "ProfileName": ...,
    "ProfileDescription": ...,
    "ProfileQuestions": ...,
    "ClientRequestToken": ...,
}

parent.create_profile(**kwargs)
  1. See CreateProfileInputRequestTypeDef

create_profile_share#

Create a profile share.

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

# create_profile_share method definition

def create_profile_share(
    self,
    *,
    ProfileArn: str,
    SharedWith: str,
    ClientRequestToken: str,
) -> CreateProfileShareOutputTypeDef:  # (1)
    ...
  1. See CreateProfileShareOutputTypeDef 
# create_profile_share method usage example with argument unpacking

kwargs: CreateProfileShareInputRequestTypeDef = {  # (1)
    "ProfileArn": ...,
    "SharedWith": ...,
    "ClientRequestToken": ...,
}

parent.create_profile_share(**kwargs)
  1. See CreateProfileShareInputRequestTypeDef

create_review_template#

Create a review template.

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

# create_review_template method definition

def create_review_template(
    self,
    *,
    TemplateName: str,
    Description: str,
    Lenses: Sequence[str],
    ClientRequestToken: str,
    Notes: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateReviewTemplateOutputTypeDef:  # (1)
    ...
  1. See CreateReviewTemplateOutputTypeDef 
# create_review_template method usage example with argument unpacking

kwargs: CreateReviewTemplateInputRequestTypeDef = {  # (1)
    "TemplateName": ...,
    "Description": ...,
    "Lenses": ...,
    "ClientRequestToken": ...,
}

parent.create_review_template(**kwargs)
  1. See CreateReviewTemplateInputRequestTypeDef

create_template_share#

Create a review template share.

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

# create_template_share method definition

def create_template_share(
    self,
    *,
    TemplateArn: str,
    SharedWith: str,
    ClientRequestToken: str,
) -> CreateTemplateShareOutputTypeDef:  # (1)
    ...
  1. See CreateTemplateShareOutputTypeDef 
# create_template_share method usage example with argument unpacking

kwargs: CreateTemplateShareInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
    "SharedWith": ...,
    "ClientRequestToken": ...,
}

parent.create_template_share(**kwargs)
  1. See CreateTemplateShareInputRequestTypeDef

create_workload#

Create a new workload.

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

# create_workload method definition

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] = ...,
    DiscoveryConfig: WorkloadDiscoveryConfigTypeDef = ...,  # (2)
    Applications: Sequence[str] = ...,
    ProfileArns: Sequence[str] = ...,
    ReviewTemplateArns: Sequence[str] = ...,
    JiraConfiguration: WorkloadJiraConfigurationInputTypeDef = ...,  # (3)
) -> CreateWorkloadOutputTypeDef:  # (4)
    ...
  1. See WorkloadEnvironmentType
  2. See WorkloadDiscoveryConfigTypeDef
  3. See WorkloadJiraConfigurationInputTypeDef
  4. See CreateWorkloadOutputTypeDef 
# create_workload method usage example with argument unpacking

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 boto3.client("wellarchitected").create_workload_share method. boto3 documentation

# create_workload_share method definition

def create_workload_share(
    self,
    *,
    WorkloadId: str,
    SharedWith: str,
    PermissionType: PermissionTypeType,  # (1)
    ClientRequestToken: str,
) -> CreateWorkloadShareOutputTypeDef:  # (2)
    ...
  1. See PermissionTypeType
  2. See CreateWorkloadShareOutputTypeDef 
# create_workload_share method usage example with argument unpacking

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 boto3.client("wellarchitected").delete_lens method. boto3 documentation

# delete_lens method definition

def delete_lens(
    self,
    *,
    LensAlias: str,
    ClientRequestToken: str,
    LensStatus: LensStatusTypeType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See LensStatusTypeType
  2. See EmptyResponseMetadataTypeDef 
# delete_lens method usage example with argument unpacking

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 boto3.client("wellarchitected").delete_lens_share method. boto3 documentation

# delete_lens_share method definition

def delete_lens_share(
    self,
    *,
    ShareId: str,
    LensAlias: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_lens_share method usage example with argument unpacking

kwargs: DeleteLensShareInputRequestTypeDef = {  # (1)
    "ShareId": ...,
    "LensAlias": ...,
    "ClientRequestToken": ...,
}

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

delete_profile#

Delete a profile.

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

# delete_profile method definition

def delete_profile(
    self,
    *,
    ProfileArn: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_profile method usage example with argument unpacking

kwargs: DeleteProfileInputRequestTypeDef = {  # (1)
    "ProfileArn": ...,
    "ClientRequestToken": ...,
}

parent.delete_profile(**kwargs)
  1. See DeleteProfileInputRequestTypeDef

delete_profile_share#

Delete a profile share.

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

# delete_profile_share method definition

def delete_profile_share(
    self,
    *,
    ShareId: str,
    ProfileArn: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_profile_share method usage example with argument unpacking

kwargs: DeleteProfileShareInputRequestTypeDef = {  # (1)
    "ShareId": ...,
    "ProfileArn": ...,
    "ClientRequestToken": ...,
}

parent.delete_profile_share(**kwargs)
  1. See DeleteProfileShareInputRequestTypeDef

delete_review_template#

Delete a review template.

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

# delete_review_template method definition

def delete_review_template(
    self,
    *,
    TemplateArn: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_review_template method usage example with argument unpacking

kwargs: DeleteReviewTemplateInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
    "ClientRequestToken": ...,
}

parent.delete_review_template(**kwargs)
  1. See DeleteReviewTemplateInputRequestTypeDef

delete_template_share#

Delete a review template share.

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

# delete_template_share method definition

def delete_template_share(
    self,
    *,
    ShareId: str,
    TemplateArn: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_template_share method usage example with argument unpacking

kwargs: DeleteTemplateShareInputRequestTypeDef = {  # (1)
    "ShareId": ...,
    "TemplateArn": ...,
    "ClientRequestToken": ...,
}

parent.delete_template_share(**kwargs)
  1. See DeleteTemplateShareInputRequestTypeDef

delete_workload#

Delete an existing workload.

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

# delete_workload method definition

def delete_workload(
    self,
    *,
    WorkloadId: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_workload method usage example with argument unpacking

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 boto3.client("wellarchitected").delete_workload_share method. boto3 documentation

# delete_workload_share method definition

def delete_workload_share(
    self,
    *,
    ShareId: str,
    WorkloadId: str,
    ClientRequestToken: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# delete_workload_share method usage example with argument unpacking

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 boto3.client("wellarchitected").disassociate_lenses method. boto3 documentation

# disassociate_lenses method definition

def disassociate_lenses(
    self,
    *,
    WorkloadId: str,
    LensAliases: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# disassociate_lenses method usage example with argument unpacking

kwargs: DisassociateLensesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAliases": ...,
}

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

disassociate_profiles#

Disassociate a profile from a workload.

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

# disassociate_profiles method definition

def disassociate_profiles(
    self,
    *,
    WorkloadId: str,
    ProfileArns: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# disassociate_profiles method usage example with argument unpacking

kwargs: DisassociateProfilesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "ProfileArns": ...,
}

parent.disassociate_profiles(**kwargs)
  1. See DisassociateProfilesInputRequestTypeDef

export_lens#

Export an existing lens.

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

# export_lens method definition

def export_lens(
    self,
    *,
    LensAlias: str,
    LensVersion: str = ...,
) -> ExportLensOutputTypeDef:  # (1)
    ...
  1. See ExportLensOutputTypeDef 
# export_lens method usage example with argument unpacking

kwargs: ExportLensInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
}

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

get_answer#

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

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

# get_answer method definition

def get_answer(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    QuestionId: str,
    MilestoneNumber: int = ...,
) -> GetAnswerOutputTypeDef:  # (1)
    ...
  1. See GetAnswerOutputTypeDef 
# get_answer method usage example with argument unpacking

kwargs: GetAnswerInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
    "QuestionId": ...,
}

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

get_consolidated_report#

Get a consolidated report of your workloads.

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

# get_consolidated_report method definition

def get_consolidated_report(
    self,
    *,
    Format: ReportFormatType,  # (1)
    IncludeSharedResources: bool = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> GetConsolidatedReportOutputTypeDef:  # (2)
    ...
  1. See ReportFormatType
  2. See GetConsolidatedReportOutputTypeDef 
# get_consolidated_report method usage example with argument unpacking

kwargs: GetConsolidatedReportInputRequestTypeDef = {  # (1)
    "Format": ...,
}

parent.get_consolidated_report(**kwargs)
  1. See GetConsolidatedReportInputRequestTypeDef

get_global_settings#

Global settings for all workloads.

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

# get_global_settings method definition

def get_global_settings(
    self,
) -> GetGlobalSettingsOutputTypeDef:  # (1)
    ...
  1. See GetGlobalSettingsOutputTypeDef

get_lens#

Get an existing lens.

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

# get_lens method definition

def get_lens(
    self,
    *,
    LensAlias: str,
    LensVersion: str = ...,
) -> GetLensOutputTypeDef:  # (1)
    ...
  1. See GetLensOutputTypeDef 
# get_lens method usage example with argument unpacking

kwargs: GetLensInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
}

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

get_lens_review#

Get lens review.

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

# get_lens_review method definition

def get_lens_review(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    MilestoneNumber: int = ...,
) -> GetLensReviewOutputTypeDef:  # (1)
    ...
  1. See GetLensReviewOutputTypeDef 
# get_lens_review method usage example with argument unpacking

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 boto3.client("wellarchitected").get_lens_review_report method. boto3 documentation

# get_lens_review_report method definition

def get_lens_review_report(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    MilestoneNumber: int = ...,
) -> GetLensReviewReportOutputTypeDef:  # (1)
    ...
  1. See GetLensReviewReportOutputTypeDef 
# get_lens_review_report method usage example with argument unpacking

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 boto3.client("wellarchitected").get_lens_version_difference method. boto3 documentation

# get_lens_version_difference method definition

def get_lens_version_difference(
    self,
    *,
    LensAlias: str,
    BaseLensVersion: str = ...,
    TargetLensVersion: str = ...,
) -> GetLensVersionDifferenceOutputTypeDef:  # (1)
    ...
  1. See GetLensVersionDifferenceOutputTypeDef 
# get_lens_version_difference method usage example with argument unpacking

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 boto3.client("wellarchitected").get_milestone method. boto3 documentation

# get_milestone method definition

def get_milestone(
    self,
    *,
    WorkloadId: str,
    MilestoneNumber: int,
) -> GetMilestoneOutputTypeDef:  # (1)
    ...
  1. See GetMilestoneOutputTypeDef 
# get_milestone method usage example with argument unpacking

kwargs: GetMilestoneInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "MilestoneNumber": ...,
}

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

get_profile#

Get profile information.

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

# get_profile method definition

def get_profile(
    self,
    *,
    ProfileArn: str,
    ProfileVersion: str = ...,
) -> GetProfileOutputTypeDef:  # (1)
    ...
  1. See GetProfileOutputTypeDef 
# get_profile method usage example with argument unpacking

kwargs: GetProfileInputRequestTypeDef = {  # (1)
    "ProfileArn": ...,
}

parent.get_profile(**kwargs)
  1. See GetProfileInputRequestTypeDef

get_profile_template#

Get profile template.

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

# get_profile_template method definition

def get_profile_template(
    self,
) -> GetProfileTemplateOutputTypeDef:  # (1)
    ...
  1. See GetProfileTemplateOutputTypeDef

get_review_template#

Get review template.

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

# get_review_template method definition

def get_review_template(
    self,
    *,
    TemplateArn: str,
) -> GetReviewTemplateOutputTypeDef:  # (1)
    ...
  1. See GetReviewTemplateOutputTypeDef 
# get_review_template method usage example with argument unpacking

kwargs: GetReviewTemplateInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
}

parent.get_review_template(**kwargs)
  1. See GetReviewTemplateInputRequestTypeDef

get_review_template_answer#

Get review template answer.

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

# get_review_template_answer method definition

def get_review_template_answer(
    self,
    *,
    TemplateArn: str,
    LensAlias: str,
    QuestionId: str,
) -> GetReviewTemplateAnswerOutputTypeDef:  # (1)
    ...
  1. See GetReviewTemplateAnswerOutputTypeDef 
# get_review_template_answer method usage example with argument unpacking

kwargs: GetReviewTemplateAnswerInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
    "LensAlias": ...,
    "QuestionId": ...,
}

parent.get_review_template_answer(**kwargs)
  1. See GetReviewTemplateAnswerInputRequestTypeDef

get_review_template_lens_review#

Get a lens review associated with a review template.

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

# get_review_template_lens_review method definition

def get_review_template_lens_review(
    self,
    *,
    TemplateArn: str,
    LensAlias: str,
) -> GetReviewTemplateLensReviewOutputTypeDef:  # (1)
    ...
  1. See GetReviewTemplateLensReviewOutputTypeDef 
# get_review_template_lens_review method usage example with argument unpacking

kwargs: GetReviewTemplateLensReviewInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
    "LensAlias": ...,
}

parent.get_review_template_lens_review(**kwargs)
  1. See GetReviewTemplateLensReviewInputRequestTypeDef

get_workload#

Get an existing workload.

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

# get_workload method definition

def get_workload(
    self,
    *,
    WorkloadId: str,
) -> GetWorkloadOutputTypeDef:  # (1)
    ...
  1. See GetWorkloadOutputTypeDef 
# get_workload method usage example with argument unpacking

kwargs: GetWorkloadInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

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

import_lens#

Import a new custom lens or update an existing custom lens.

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

# import_lens method definition

def import_lens(
    self,
    *,
    JSONString: str,
    ClientRequestToken: str,
    LensAlias: str = ...,
    Tags: Mapping[str, str] = ...,
) -> ImportLensOutputTypeDef:  # (1)
    ...
  1. See ImportLensOutputTypeDef 
# import_lens method usage example with argument unpacking

kwargs: ImportLensInputRequestTypeDef = {  # (1)
    "JSONString": ...,
    "ClientRequestToken": ...,
}

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

list_answers#

List of answers for a particular workload and lens.

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

# list_answers method definition

def list_answers(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    PillarId: str = ...,
    MilestoneNumber: int = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    QuestionPriority: QuestionPriorityType = ...,  # (1)
) -> ListAnswersOutputTypeDef:  # (2)
    ...
  1. See QuestionPriorityType
  2. See ListAnswersOutputTypeDef 
# list_answers method usage example with argument unpacking

kwargs: ListAnswersInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
}

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

list_check_details#

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

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

# list_check_details method definition

def list_check_details(
    self,
    *,
    WorkloadId: str,
    LensArn: str,
    PillarId: str,
    QuestionId: str,
    ChoiceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCheckDetailsOutputTypeDef:  # (1)
    ...
  1. See ListCheckDetailsOutputTypeDef 
# list_check_details method usage example with argument unpacking

kwargs: ListCheckDetailsInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensArn": ...,
    "PillarId": ...,
    "QuestionId": ...,
    "ChoiceId": ...,
}

parent.list_check_details(**kwargs)
  1. See ListCheckDetailsInputRequestTypeDef

list_check_summaries#

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

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

# list_check_summaries method definition

def list_check_summaries(
    self,
    *,
    WorkloadId: str,
    LensArn: str,
    PillarId: str,
    QuestionId: str,
    ChoiceId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCheckSummariesOutputTypeDef:  # (1)
    ...
  1. See ListCheckSummariesOutputTypeDef 
# list_check_summaries method usage example with argument unpacking

kwargs: ListCheckSummariesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensArn": ...,
    "PillarId": ...,
    "QuestionId": ...,
    "ChoiceId": ...,
}

parent.list_check_summaries(**kwargs)
  1. See ListCheckSummariesInputRequestTypeDef

list_lens_review_improvements#

List the improvements of a particular lens review.

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

# list_lens_review_improvements method definition

def list_lens_review_improvements(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    PillarId: str = ...,
    MilestoneNumber: int = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    QuestionPriority: QuestionPriorityType = ...,  # (1)
) -> ListLensReviewImprovementsOutputTypeDef:  # (2)
    ...
  1. See QuestionPriorityType
  2. See ListLensReviewImprovementsOutputTypeDef 
# list_lens_review_improvements method usage example with argument unpacking

kwargs: ListLensReviewImprovementsInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
}

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

list_lens_reviews#

List lens reviews for a particular workload.

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

# list_lens_reviews method definition

def list_lens_reviews(
    self,
    *,
    WorkloadId: str,
    MilestoneNumber: int = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListLensReviewsOutputTypeDef:  # (1)
    ...
  1. See ListLensReviewsOutputTypeDef 
# list_lens_reviews method usage example with argument unpacking

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 boto3.client("wellarchitected").list_lens_shares method. boto3 documentation

# list_lens_shares method definition

def list_lens_shares(
    self,
    *,
    LensAlias: str,
    SharedWithPrefix: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: ShareStatusType = ...,  # (1)
) -> ListLensSharesOutputTypeDef:  # (2)
    ...
  1. See ShareStatusType
  2. See ListLensSharesOutputTypeDef 
# list_lens_shares method usage example with argument unpacking

kwargs: ListLensSharesInputRequestTypeDef = {  # (1)
    "LensAlias": ...,
}

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

list_lenses#

List the available lenses.

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

# list_lenses method definition

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 
# list_lenses method usage example with argument unpacking

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 boto3.client("wellarchitected").list_milestones method. boto3 documentation

# list_milestones method definition

def list_milestones(
    self,
    *,
    WorkloadId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMilestonesOutputTypeDef:  # (1)
    ...
  1. See ListMilestonesOutputTypeDef 
# list_milestones method usage example with argument unpacking

kwargs: ListMilestonesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

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

list_notifications#

List lens notifications.

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

# list_notifications method definition

def list_notifications(
    self,
    *,
    WorkloadId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    ResourceArn: str = ...,
) -> ListNotificationsOutputTypeDef:  # (1)
    ...
  1. See ListNotificationsOutputTypeDef 
# list_notifications method usage example with argument unpacking

kwargs: ListNotificationsInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

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

list_profile_notifications#

List profile notifications.

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

# list_profile_notifications method definition

def list_profile_notifications(
    self,
    *,
    WorkloadId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProfileNotificationsOutputTypeDef:  # (1)
    ...
  1. See ListProfileNotificationsOutputTypeDef 
# list_profile_notifications method usage example with argument unpacking

kwargs: ListProfileNotificationsInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

parent.list_profile_notifications(**kwargs)
  1. See ListProfileNotificationsInputRequestTypeDef

list_profile_shares#

List profile shares.

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

# list_profile_shares method definition

def list_profile_shares(
    self,
    *,
    ProfileArn: str,
    SharedWithPrefix: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: ShareStatusType = ...,  # (1)
) -> ListProfileSharesOutputTypeDef:  # (2)
    ...
  1. See ShareStatusType
  2. See ListProfileSharesOutputTypeDef 
# list_profile_shares method usage example with argument unpacking

kwargs: ListProfileSharesInputRequestTypeDef = {  # (1)
    "ProfileArn": ...,
}

parent.list_profile_shares(**kwargs)
  1. See ListProfileSharesInputRequestTypeDef

list_profiles#

List profiles.

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

# list_profiles method definition

def list_profiles(
    self,
    *,
    ProfileNamePrefix: str = ...,
    ProfileOwnerType: ProfileOwnerTypeType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProfilesOutputTypeDef:  # (2)
    ...
  1. See ProfileOwnerTypeType
  2. See ListProfilesOutputTypeDef 
# list_profiles method usage example with argument unpacking

kwargs: ListProfilesInputRequestTypeDef = {  # (1)
    "ProfileNamePrefix": ...,
}

parent.list_profiles(**kwargs)
  1. See ListProfilesInputRequestTypeDef

list_review_template_answers#

List the answers of a review template.

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

# list_review_template_answers method definition

def list_review_template_answers(
    self,
    *,
    TemplateArn: str,
    LensAlias: str,
    PillarId: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListReviewTemplateAnswersOutputTypeDef:  # (1)
    ...
  1. See ListReviewTemplateAnswersOutputTypeDef 
# list_review_template_answers method usage example with argument unpacking

kwargs: ListReviewTemplateAnswersInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
    "LensAlias": ...,
}

parent.list_review_template_answers(**kwargs)
  1. See ListReviewTemplateAnswersInputRequestTypeDef

list_review_templates#

List review templates.

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

# list_review_templates method definition

def list_review_templates(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListReviewTemplatesOutputTypeDef:  # (1)
    ...
  1. See ListReviewTemplatesOutputTypeDef 
# list_review_templates method usage example with argument unpacking

kwargs: ListReviewTemplatesInputRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_review_templates(**kwargs)
  1. See ListReviewTemplatesInputRequestTypeDef

list_share_invitations#

List the share invitations.

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

# list_share_invitations method definition

def list_share_invitations(
    self,
    *,
    WorkloadNamePrefix: str = ...,
    LensNamePrefix: str = ...,
    ShareResourceType: ShareResourceTypeType = ...,  # (1)
    NextToken: str = ...,
    MaxResults: int = ...,
    ProfileNamePrefix: str = ...,
    TemplateNamePrefix: str = ...,
) -> ListShareInvitationsOutputTypeDef:  # (2)
    ...
  1. See ShareResourceTypeType
  2. See ListShareInvitationsOutputTypeDef 
# list_share_invitations method usage example with argument unpacking

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 boto3.client("wellarchitected").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    WorkloadArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...
  1. See ListTagsForResourceOutputTypeDef 
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "WorkloadArn": ...,
}

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

list_template_shares#

List review template shares.

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

# list_template_shares method definition

def list_template_shares(
    self,
    *,
    TemplateArn: str,
    SharedWithPrefix: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: ShareStatusType = ...,  # (1)
) -> ListTemplateSharesOutputTypeDef:  # (2)
    ...
  1. See ShareStatusType
  2. See ListTemplateSharesOutputTypeDef 
# list_template_shares method usage example with argument unpacking

kwargs: ListTemplateSharesInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
}

parent.list_template_shares(**kwargs)
  1. See ListTemplateSharesInputRequestTypeDef

list_workload_shares#

List the workload shares associated with the workload.

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

# list_workload_shares method definition

def list_workload_shares(
    self,
    *,
    WorkloadId: str,
    SharedWithPrefix: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    Status: ShareStatusType = ...,  # (1)
) -> ListWorkloadSharesOutputTypeDef:  # (2)
    ...
  1. See ShareStatusType
  2. See ListWorkloadSharesOutputTypeDef 
# list_workload_shares method usage example with argument unpacking

kwargs: ListWorkloadSharesInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

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

list_workloads#

Paginated list of workloads.

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

# list_workloads method definition

def list_workloads(
    self,
    *,
    WorkloadNamePrefix: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListWorkloadsOutputTypeDef:  # (1)
    ...
  1. See ListWorkloadsOutputTypeDef 
# list_workloads method usage example with argument unpacking

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 boto3.client("wellarchitected").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    WorkloadArn: str,
    Tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

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 boto3.client("wellarchitected").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    WorkloadArn: str,
    TagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

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 boto3.client("wellarchitected").update_answer method. boto3 documentation

# update_answer method definition

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 
# update_answer method usage example with argument unpacking

kwargs: UpdateAnswerInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
    "QuestionId": ...,
}

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

update_global_settings#

Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

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

# update_global_settings method definition

def update_global_settings(
    self,
    *,
    OrganizationSharingStatus: OrganizationSharingStatusType = ...,  # (1)
    DiscoveryIntegrationStatus: DiscoveryIntegrationStatusType = ...,  # (2)
    JiraConfiguration: AccountJiraConfigurationInputTypeDef = ...,  # (3)
) -> EmptyResponseMetadataTypeDef:  # (4)
    ...
  1. See OrganizationSharingStatusType
  2. See DiscoveryIntegrationStatusType
  3. See AccountJiraConfigurationInputTypeDef
  4. See EmptyResponseMetadataTypeDef 
# update_global_settings method usage example with argument unpacking

kwargs: UpdateGlobalSettingsInputRequestTypeDef = {  # (1)
    "OrganizationSharingStatus": ...,
}

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

update_integration#

Update integration features.

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

# update_integration method definition

def update_integration(
    self,
    *,
    WorkloadId: str,
    ClientRequestToken: str,
    IntegratingService: IntegratingServiceType,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See IntegratingServiceType
  2. See EmptyResponseMetadataTypeDef 
# update_integration method usage example with argument unpacking

kwargs: UpdateIntegrationInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "ClientRequestToken": ...,
    "IntegratingService": ...,
}

parent.update_integration(**kwargs)
  1. See UpdateIntegrationInputRequestTypeDef

update_lens_review#

Update lens review for a particular workload.

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

# update_lens_review method definition

def update_lens_review(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    LensNotes: str = ...,
    PillarNotes: Mapping[str, str] = ...,
    JiraConfiguration: JiraSelectedQuestionConfigurationTypeDef = ...,  # (1)
) -> UpdateLensReviewOutputTypeDef:  # (2)
    ...
  1. See JiraSelectedQuestionConfigurationTypeDef
  2. See UpdateLensReviewOutputTypeDef 
# update_lens_review method usage example with argument unpacking

kwargs: UpdateLensReviewInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
}

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

update_profile#

Update a profile.

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

# update_profile method definition

def update_profile(
    self,
    *,
    ProfileArn: str,
    ProfileDescription: str = ...,
    ProfileQuestions: Sequence[ProfileQuestionUpdateTypeDef] = ...,  # (1)
) -> UpdateProfileOutputTypeDef:  # (2)
    ...
  1. See ProfileQuestionUpdateTypeDef
  2. See UpdateProfileOutputTypeDef 
# update_profile method usage example with argument unpacking

kwargs: UpdateProfileInputRequestTypeDef = {  # (1)
    "ProfileArn": ...,
}

parent.update_profile(**kwargs)
  1. See UpdateProfileInputRequestTypeDef

update_review_template#

Update a review template.

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

# update_review_template method definition

def update_review_template(
    self,
    *,
    TemplateArn: str,
    TemplateName: str = ...,
    Description: str = ...,
    Notes: str = ...,
    LensesToAssociate: Sequence[str] = ...,
    LensesToDisassociate: Sequence[str] = ...,
) -> UpdateReviewTemplateOutputTypeDef:  # (1)
    ...
  1. See UpdateReviewTemplateOutputTypeDef 
# update_review_template method usage example with argument unpacking

kwargs: UpdateReviewTemplateInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
}

parent.update_review_template(**kwargs)
  1. See UpdateReviewTemplateInputRequestTypeDef

update_review_template_answer#

Update a review template answer.

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

# update_review_template_answer method definition

def update_review_template_answer(
    self,
    *,
    TemplateArn: str,
    LensAlias: str,
    QuestionId: str,
    SelectedChoices: Sequence[str] = ...,
    ChoiceUpdates: Mapping[str, ChoiceUpdateTypeDef] = ...,  # (1)
    Notes: str = ...,
    IsApplicable: bool = ...,
    Reason: AnswerReasonType = ...,  # (2)
) -> UpdateReviewTemplateAnswerOutputTypeDef:  # (3)
    ...
  1. See ChoiceUpdateTypeDef
  2. See AnswerReasonType
  3. See UpdateReviewTemplateAnswerOutputTypeDef 
# update_review_template_answer method usage example with argument unpacking

kwargs: UpdateReviewTemplateAnswerInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
    "LensAlias": ...,
    "QuestionId": ...,
}

parent.update_review_template_answer(**kwargs)
  1. See UpdateReviewTemplateAnswerInputRequestTypeDef

update_review_template_lens_review#

Update a lens review associated with a review template.

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

# update_review_template_lens_review method definition

def update_review_template_lens_review(
    self,
    *,
    TemplateArn: str,
    LensAlias: str,
    LensNotes: str = ...,
    PillarNotes: Mapping[str, str] = ...,
) -> UpdateReviewTemplateLensReviewOutputTypeDef:  # (1)
    ...
  1. See UpdateReviewTemplateLensReviewOutputTypeDef 
# update_review_template_lens_review method usage example with argument unpacking

kwargs: UpdateReviewTemplateLensReviewInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
    "LensAlias": ...,
}

parent.update_review_template_lens_review(**kwargs)
  1. See UpdateReviewTemplateLensReviewInputRequestTypeDef

update_share_invitation#

Update a workload or custom lens share invitation.

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

# update_share_invitation method definition

def update_share_invitation(
    self,
    *,
    ShareInvitationId: str,
    ShareInvitationAction: ShareInvitationActionType,  # (1)
) -> UpdateShareInvitationOutputTypeDef:  # (2)
    ...
  1. See ShareInvitationActionType
  2. See UpdateShareInvitationOutputTypeDef 
# update_share_invitation method usage example with argument unpacking

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 boto3.client("wellarchitected").update_workload method. boto3 documentation

# update_workload method definition

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)
    DiscoveryConfig: WorkloadDiscoveryConfigTypeDef = ...,  # (3)
    Applications: Sequence[str] = ...,
    JiraConfiguration: WorkloadJiraConfigurationInputTypeDef = ...,  # (4)
) -> UpdateWorkloadOutputTypeDef:  # (5)
    ...
  1. See WorkloadEnvironmentType
  2. See WorkloadImprovementStatusType
  3. See WorkloadDiscoveryConfigTypeDef
  4. See WorkloadJiraConfigurationInputTypeDef
  5. See UpdateWorkloadOutputTypeDef 
# update_workload method usage example with argument unpacking

kwargs: UpdateWorkloadInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
}

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

update_workload_share#

Update a workload share.

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

# update_workload_share method definition

def update_workload_share(
    self,
    *,
    ShareId: str,
    WorkloadId: str,
    PermissionType: PermissionTypeType,  # (1)
) -> UpdateWorkloadShareOutputTypeDef:  # (2)
    ...
  1. See PermissionTypeType
  2. See UpdateWorkloadShareOutputTypeDef 
# update_workload_share method usage example with argument unpacking

kwargs: UpdateWorkloadShareInputRequestTypeDef = {  # (1)
    "ShareId": ...,
    "WorkloadId": ...,
    "PermissionType": ...,
}

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

upgrade_lens_review#

Upgrade lens review for a particular workload.

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

# upgrade_lens_review method definition

def upgrade_lens_review(
    self,
    *,
    WorkloadId: str,
    LensAlias: str,
    MilestoneName: str,
    ClientRequestToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# upgrade_lens_review method usage example with argument unpacking

kwargs: UpgradeLensReviewInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "LensAlias": ...,
    "MilestoneName": ...,
}

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

upgrade_profile_version#

Upgrade a profile.

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

# upgrade_profile_version method definition

def upgrade_profile_version(
    self,
    *,
    WorkloadId: str,
    ProfileArn: str,
    MilestoneName: str = ...,
    ClientRequestToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# upgrade_profile_version method usage example with argument unpacking

kwargs: UpgradeProfileVersionInputRequestTypeDef = {  # (1)
    "WorkloadId": ...,
    "ProfileArn": ...,
}

parent.upgrade_profile_version(**kwargs)
  1. See UpgradeProfileVersionInputRequestTypeDef

upgrade_review_template_lens_review#

Upgrade the lens review of a review template.

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

# upgrade_review_template_lens_review method definition

def upgrade_review_template_lens_review(
    self,
    *,
    TemplateArn: str,
    LensAlias: str,
    ClientRequestToken: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef 
# upgrade_review_template_lens_review method usage example with argument unpacking

kwargs: UpgradeReviewTemplateLensReviewInputRequestTypeDef = {  # (1)
    "TemplateArn": ...,
    "LensAlias": ...,
}

parent.upgrade_review_template_lens_review(**kwargs)
  1. See UpgradeReviewTemplateLensReviewInputRequestTypeDef