WellArchitectedClient#
Index > WellArchitected > WellArchitectedClient
Auto-generated documentation for WellArchitected type annotations stubs module mypy-boto3-wellarchitected.
WellArchitectedClient#
Type annotations and code completion for boto3.client("wellarchitected")
.
boto3 documentation
# WellArchitectedClient usage example
from boto3.session import Session
from mypy_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 mypy_boto3_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 boto3.client("wellarchitected").associate_lenses
method.
boto3 documentation
# associate_lenses method definition
def associate_lenses(
self,
*,
WorkloadId: str,
LensAliases: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# associate_lenses method usage example with argument unpacking
kwargs: AssociateLensesInputRequestTypeDef = { # (1)
"WorkloadId": ...,
"LensAliases": ...,
}
parent.associate_lenses(**kwargs)
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)
...
# associate_profiles method usage example with argument unpacking
kwargs: AssociateProfilesInputRequestTypeDef = { # (1)
"WorkloadId": ...,
"ProfileArns": ...,
}
parent.associate_profiles(**kwargs)
can_paginate#
Check if an operation can be paginated.
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:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("wellarchitected").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
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)
...
# create_lens_share method usage example with argument unpacking
kwargs: CreateLensShareInputRequestTypeDef = { # (1)
"LensAlias": ...,
"SharedWith": ...,
"ClientRequestToken": ...,
}
parent.create_lens_share(**kwargs)
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)
...
# create_lens_version method usage example with argument unpacking
kwargs: CreateLensVersionInputRequestTypeDef = { # (1)
"LensAlias": ...,
"LensVersion": ...,
"ClientRequestToken": ...,
}
parent.create_lens_version(**kwargs)
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)
...
# create_milestone method usage example with argument unpacking
kwargs: CreateMilestoneInputRequestTypeDef = { # (1)
"WorkloadId": ...,
"MilestoneName": ...,
"ClientRequestToken": ...,
}
parent.create_milestone(**kwargs)
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)
...
# create_profile method usage example with argument unpacking
kwargs: CreateProfileInputRequestTypeDef = { # (1)
"ProfileName": ...,
"ProfileDescription": ...,
"ProfileQuestions": ...,
"ClientRequestToken": ...,
}
parent.create_profile(**kwargs)
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)
...
# create_profile_share method usage example with argument unpacking
kwargs: CreateProfileShareInputRequestTypeDef = { # (1)
"ProfileArn": ...,
"SharedWith": ...,
"ClientRequestToken": ...,
}
parent.create_profile_share(**kwargs)
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)
...
# create_review_template method usage example with argument unpacking
kwargs: CreateReviewTemplateInputRequestTypeDef = { # (1)
"TemplateName": ...,
"Description": ...,
"Lenses": ...,
"ClientRequestToken": ...,
}
parent.create_review_template(**kwargs)
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)
...
# create_template_share method usage example with argument unpacking
kwargs: CreateTemplateShareInputRequestTypeDef = { # (1)
"TemplateArn": ...,
"SharedWith": ...,
"ClientRequestToken": ...,
}
parent.create_template_share(**kwargs)
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] = ...,
) -> CreateWorkloadOutputTypeDef: # (3)
...
# create_workload method usage example with argument unpacking
kwargs: CreateWorkloadInputRequestTypeDef = { # (1)
"WorkloadName": ...,
"Description": ...,
"Environment": ...,
"Lenses": ...,
"ClientRequestToken": ...,
}
parent.create_workload(**kwargs)
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)
...
# create_workload_share method usage example with argument unpacking
kwargs: CreateWorkloadShareInputRequestTypeDef = { # (1)
"WorkloadId": ...,
"SharedWith": ...,
"PermissionType": ...,
"ClientRequestToken": ...,
}
parent.create_workload_share(**kwargs)
delete_lens#
Delete an existing lens.
Type annotations and code completion for boto3.client("wellarchitected").delete_lens
method.