Skip to content

Type definitions#

Index > WellArchitected > Type definitions

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

ChoiceContentTypeDef#

# ChoiceContentTypeDef definition

class ChoiceContentTypeDef(TypedDict):
    DisplayText: NotRequired[str],
    Url: NotRequired[str],

ChoiceAnswerSummaryTypeDef#

# ChoiceAnswerSummaryTypeDef definition

class ChoiceAnswerSummaryTypeDef(TypedDict):
    ChoiceId: NotRequired[str],
    Status: NotRequired[ChoiceStatusType],  # (1)
    Reason: NotRequired[ChoiceReasonType],  # (2)
  1. See ChoiceStatusType
  2. See ChoiceReasonType

ChoiceAnswerTypeDef#

# ChoiceAnswerTypeDef definition

class ChoiceAnswerTypeDef(TypedDict):
    ChoiceId: NotRequired[str],
    Status: NotRequired[ChoiceStatusType],  # (1)
    Reason: NotRequired[ChoiceReasonType],  # (2)
    Notes: NotRequired[str],
  1. See ChoiceStatusType
  2. See ChoiceReasonType

AssociateLensesInputRequestTypeDef#

# AssociateLensesInputRequestTypeDef definition

class AssociateLensesInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    LensAliases: Sequence[str],

AssociateProfilesInputRequestTypeDef#

# AssociateProfilesInputRequestTypeDef definition

class AssociateProfilesInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    ProfileArns: Sequence[str],

BestPracticeTypeDef#

# BestPracticeTypeDef definition

class BestPracticeTypeDef(TypedDict):
    ChoiceId: NotRequired[str],
    ChoiceTitle: NotRequired[str],

CheckDetailTypeDef#

# CheckDetailTypeDef definition

class CheckDetailTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    Provider: NotRequired[CheckProviderType],  # (1)
    LensArn: NotRequired[str],
    PillarId: NotRequired[str],
    QuestionId: NotRequired[str],
    ChoiceId: NotRequired[str],
    Status: NotRequired[CheckStatusType],  # (2)
    AccountId: NotRequired[str],
    FlaggedResources: NotRequired[int],
    Reason: NotRequired[CheckFailureReasonType],  # (3)
    UpdatedAt: NotRequired[datetime],
  1. See CheckProviderType
  2. See CheckStatusType
  3. See CheckFailureReasonType

CheckSummaryTypeDef#

# CheckSummaryTypeDef definition

class CheckSummaryTypeDef(TypedDict):
    Id: NotRequired[str],
    Name: NotRequired[str],
    Provider: NotRequired[CheckProviderType],  # (1)
    Description: NotRequired[str],
    UpdatedAt: NotRequired[datetime],
    LensArn: NotRequired[str],
    PillarId: NotRequired[str],
    QuestionId: NotRequired[str],
    ChoiceId: NotRequired[str],
    Status: NotRequired[CheckStatusType],  # (2)
    AccountSummary: NotRequired[Dict[CheckStatusType, int]],  # (3)
  1. See CheckProviderType
  2. See CheckStatusType
  3. See CheckStatusType

ChoiceImprovementPlanTypeDef#

# ChoiceImprovementPlanTypeDef definition

class ChoiceImprovementPlanTypeDef(TypedDict):
    ChoiceId: NotRequired[str],
    DisplayText: NotRequired[str],
    ImprovementPlanUrl: NotRequired[str],

ChoiceUpdateTypeDef#

# ChoiceUpdateTypeDef definition

class ChoiceUpdateTypeDef(TypedDict):
    Status: ChoiceStatusType,  # (1)
    Reason: NotRequired[ChoiceReasonType],  # (2)
    Notes: NotRequired[str],
  1. See ChoiceStatusType
  2. See ChoiceReasonType

CreateLensShareInputRequestTypeDef#

# CreateLensShareInputRequestTypeDef definition

class CreateLensShareInputRequestTypeDef(TypedDict):
    LensAlias: str,
    SharedWith: str,
    ClientRequestToken: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CreateLensVersionInputRequestTypeDef#

# CreateLensVersionInputRequestTypeDef definition

class CreateLensVersionInputRequestTypeDef(TypedDict):
    LensAlias: str,
    LensVersion: str,
    ClientRequestToken: str,
    IsMajorVersion: NotRequired[bool],

CreateMilestoneInputRequestTypeDef#

# CreateMilestoneInputRequestTypeDef definition

class CreateMilestoneInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    MilestoneName: str,
    ClientRequestToken: str,

ProfileQuestionUpdateTypeDef#

# ProfileQuestionUpdateTypeDef definition

class ProfileQuestionUpdateTypeDef(TypedDict):
    QuestionId: NotRequired[str],
    SelectedChoiceIds: NotRequired[Sequence[str]],

CreateProfileShareInputRequestTypeDef#

# CreateProfileShareInputRequestTypeDef definition

class CreateProfileShareInputRequestTypeDef(TypedDict):
    ProfileArn: str,
    SharedWith: str,
    ClientRequestToken: str,

CreateReviewTemplateInputRequestTypeDef#

# CreateReviewTemplateInputRequestTypeDef definition

class CreateReviewTemplateInputRequestTypeDef(TypedDict):
    TemplateName: str,
    Description: str,
    Lenses: Sequence[str],
    ClientRequestToken: str,
    Notes: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],

CreateTemplateShareInputRequestTypeDef#

# CreateTemplateShareInputRequestTypeDef definition

class CreateTemplateShareInputRequestTypeDef(TypedDict):
    TemplateArn: str,
    SharedWith: str,
    ClientRequestToken: str,

WorkloadDiscoveryConfigTypeDef#

# WorkloadDiscoveryConfigTypeDef definition

class WorkloadDiscoveryConfigTypeDef(TypedDict):
    TrustedAdvisorIntegrationStatus: NotRequired[TrustedAdvisorIntegrationStatusType],  # (1)
    WorkloadResourceDefinition: NotRequired[Sequence[DefinitionTypeType]],  # (2)
  1. See TrustedAdvisorIntegrationStatusType
  2. See DefinitionTypeType

CreateWorkloadShareInputRequestTypeDef#

# CreateWorkloadShareInputRequestTypeDef definition

class CreateWorkloadShareInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    SharedWith: str,
    PermissionType: PermissionTypeType,  # (1)
    ClientRequestToken: str,
  1. See PermissionTypeType

DeleteLensInputRequestTypeDef#

# DeleteLensInputRequestTypeDef definition

class DeleteLensInputRequestTypeDef(TypedDict):
    LensAlias: str,
    ClientRequestToken: str,
    LensStatus: LensStatusTypeType,  # (1)
  1. See LensStatusTypeType

DeleteLensShareInputRequestTypeDef#

# DeleteLensShareInputRequestTypeDef definition

class DeleteLensShareInputRequestTypeDef(TypedDict):
    ShareId: str,
    LensAlias: str,
    ClientRequestToken: str,

DeleteProfileInputRequestTypeDef#

# DeleteProfileInputRequestTypeDef definition

class DeleteProfileInputRequestTypeDef(TypedDict):
    ProfileArn: str,
    ClientRequestToken: str,

DeleteProfileShareInputRequestTypeDef#

# DeleteProfileShareInputRequestTypeDef definition

class DeleteProfileShareInputRequestTypeDef(TypedDict):
    ShareId: str,
    ProfileArn: str,
    ClientRequestToken: str,

DeleteReviewTemplateInputRequestTypeDef#

# DeleteReviewTemplateInputRequestTypeDef definition

class DeleteReviewTemplateInputRequestTypeDef(TypedDict):
    TemplateArn: str,
    ClientRequestToken: str,

DeleteTemplateShareInputRequestTypeDef#

# DeleteTemplateShareInputRequestTypeDef definition

class DeleteTemplateShareInputRequestTypeDef(TypedDict):
    ShareId: str,
    TemplateArn: str,
    ClientRequestToken: str,

DeleteWorkloadInputRequestTypeDef#

# DeleteWorkloadInputRequestTypeDef definition

class DeleteWorkloadInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    ClientRequestToken: str,

DeleteWorkloadShareInputRequestTypeDef#

# DeleteWorkloadShareInputRequestTypeDef definition

class DeleteWorkloadShareInputRequestTypeDef(TypedDict):
    ShareId: str,
    WorkloadId: str,
    ClientRequestToken: str,

DisassociateLensesInputRequestTypeDef#

# DisassociateLensesInputRequestTypeDef definition

class DisassociateLensesInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    LensAliases: Sequence[str],

DisassociateProfilesInputRequestTypeDef#

# DisassociateProfilesInputRequestTypeDef definition

class DisassociateProfilesInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    ProfileArns: Sequence[str],

ExportLensInputRequestTypeDef#

# ExportLensInputRequestTypeDef definition

class ExportLensInputRequestTypeDef(TypedDict):
    LensAlias: str,
    LensVersion: NotRequired[str],

GetAnswerInputRequestTypeDef#

# GetAnswerInputRequestTypeDef definition

class GetAnswerInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    LensAlias: str,
    QuestionId: str,
    MilestoneNumber: NotRequired[int],

GetConsolidatedReportInputRequestTypeDef#

# GetConsolidatedReportInputRequestTypeDef definition

class GetConsolidatedReportInputRequestTypeDef(TypedDict):
    Format: ReportFormatType,  # (1)
    IncludeSharedResources: NotRequired[bool],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
  1. See ReportFormatType

GetLensInputRequestTypeDef#

# GetLensInputRequestTypeDef definition

class GetLensInputRequestTypeDef(TypedDict):
    LensAlias: str,
    LensVersion: NotRequired[str],

LensTypeDef#

# LensTypeDef definition

class LensTypeDef(TypedDict):
    LensArn: NotRequired[str],
    LensVersion: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    Owner: NotRequired[str],
    ShareInvitationId: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],

GetLensReviewInputRequestTypeDef#

# GetLensReviewInputRequestTypeDef definition

class GetLensReviewInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    LensAlias: str,
    MilestoneNumber: NotRequired[int],

GetLensReviewReportInputRequestTypeDef#

# GetLensReviewReportInputRequestTypeDef definition

class GetLensReviewReportInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    LensAlias: str,
    MilestoneNumber: NotRequired[int],

LensReviewReportTypeDef#

# LensReviewReportTypeDef definition

class LensReviewReportTypeDef(TypedDict):
    LensAlias: NotRequired[str],
    LensArn: NotRequired[str],
    Base64String: NotRequired[str],

GetLensVersionDifferenceInputRequestTypeDef#

# GetLensVersionDifferenceInputRequestTypeDef definition

class GetLensVersionDifferenceInputRequestTypeDef(TypedDict):
    LensAlias: str,
    BaseLensVersion: NotRequired[str],
    TargetLensVersion: NotRequired[str],

GetMilestoneInputRequestTypeDef#

# GetMilestoneInputRequestTypeDef definition

class GetMilestoneInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    MilestoneNumber: int,

GetProfileInputRequestTypeDef#

# GetProfileInputRequestTypeDef definition

class GetProfileInputRequestTypeDef(TypedDict):
    ProfileArn: str,
    ProfileVersion: NotRequired[str],

GetReviewTemplateAnswerInputRequestTypeDef#

# GetReviewTemplateAnswerInputRequestTypeDef definition

class GetReviewTemplateAnswerInputRequestTypeDef(TypedDict):
    TemplateArn: str,
    LensAlias: str,
    QuestionId: str,

GetReviewTemplateInputRequestTypeDef#

# GetReviewTemplateInputRequestTypeDef definition

class GetReviewTemplateInputRequestTypeDef(TypedDict):
    TemplateArn: str,

GetReviewTemplateLensReviewInputRequestTypeDef#

# GetReviewTemplateLensReviewInputRequestTypeDef definition

class GetReviewTemplateLensReviewInputRequestTypeDef(TypedDict):
    TemplateArn: str,
    LensAlias: str,

ReviewTemplateTypeDef#

# ReviewTemplateTypeDef definition

class ReviewTemplateTypeDef(TypedDict):
    Description: NotRequired[str],
    Lenses: NotRequired[List[str]],
    Notes: NotRequired[str],
    QuestionCounts: NotRequired[Dict[QuestionType, int]],  # (1)
    Owner: NotRequired[str],
    UpdatedAt: NotRequired[datetime],
    TemplateArn: NotRequired[str],
    TemplateName: NotRequired[str],
    Tags: NotRequired[Dict[str, str]],
    UpdateStatus: NotRequired[ReviewTemplateUpdateStatusType],  # (2)
    ShareInvitationId: NotRequired[str],
  1. See QuestionType
  2. See ReviewTemplateUpdateStatusType

GetWorkloadInputRequestTypeDef#

# GetWorkloadInputRequestTypeDef definition

class GetWorkloadInputRequestTypeDef(TypedDict):
    WorkloadId: str,

ImportLensInputRequestTypeDef#

# ImportLensInputRequestTypeDef definition

class ImportLensInputRequestTypeDef(TypedDict):
    JSONString: str,
    ClientRequestToken: str,
    LensAlias: NotRequired[str],
    Tags: NotRequired[Mapping[str, str]],

WorkloadProfileTypeDef#

# WorkloadProfileTypeDef definition

class WorkloadProfileTypeDef(TypedDict):
    ProfileArn: NotRequired[str],
    ProfileVersion: NotRequired[str],

PillarReviewSummaryTypeDef#

# PillarReviewSummaryTypeDef definition

class PillarReviewSummaryTypeDef(TypedDict):
    PillarId: NotRequired[str],
    PillarName: NotRequired[str],
    Notes: NotRequired[str],
    RiskCounts: NotRequired[Dict[RiskType, int]],  # (1)
    PrioritizedRiskCounts: NotRequired[Dict[RiskType, int]],  # (1)
  1. See RiskType
  2. See RiskType

LensShareSummaryTypeDef#

# LensShareSummaryTypeDef definition

class LensShareSummaryTypeDef(TypedDict):
    ShareId: NotRequired[str],
    SharedWith: NotRequired[str],
    Status: NotRequired[ShareStatusType],  # (1)
    StatusMessage: NotRequired[str],
  1. See ShareStatusType

LensSummaryTypeDef#

# LensSummaryTypeDef definition

class LensSummaryTypeDef(TypedDict):
    LensArn: NotRequired[str],
    LensAlias: NotRequired[str],
    LensName: NotRequired[str],
    LensType: NotRequired[LensTypeType],  # (1)
    Description: NotRequired[str],
    CreatedAt: NotRequired[datetime],
    UpdatedAt: NotRequired[datetime],
    LensVersion: NotRequired[str],
    Owner: NotRequired[str],
    LensStatus: NotRequired[LensStatusType],  # (2)
  1. See LensTypeType
  2. See LensStatusType

LensUpgradeSummaryTypeDef#

# LensUpgradeSummaryTypeDef definition

class LensUpgradeSummaryTypeDef(TypedDict):
    WorkloadId: NotRequired[str],
    WorkloadName: NotRequired[str],
    LensAlias: NotRequired[str],
    LensArn: NotRequired[str],
    CurrentLensVersion: NotRequired[str],
    LatestLensVersion: NotRequired[str],
    ResourceArn: NotRequired[str],
    ResourceName: NotRequired[str],

ListAnswersInputRequestTypeDef#

# ListAnswersInputRequestTypeDef definition

class ListAnswersInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    LensAlias: str,
    PillarId: NotRequired[str],
    MilestoneNumber: NotRequired[int],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    QuestionPriority: NotRequired[QuestionPriorityType],  # (1)
  1. See QuestionPriorityType

ListCheckDetailsInputRequestTypeDef#

# ListCheckDetailsInputRequestTypeDef definition

class ListCheckDetailsInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    LensArn: str,
    PillarId: str,
    QuestionId: str,
    ChoiceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListCheckSummariesInputRequestTypeDef#

# ListCheckSummariesInputRequestTypeDef definition

class ListCheckSummariesInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    LensArn: str,
    PillarId: str,
    QuestionId: str,
    ChoiceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListLensReviewImprovementsInputRequestTypeDef#

# ListLensReviewImprovementsInputRequestTypeDef definition

class ListLensReviewImprovementsInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    LensAlias: str,
    PillarId: NotRequired[str],
    MilestoneNumber: NotRequired[int],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    QuestionPriority: NotRequired[QuestionPriorityType],  # (1)
  1. See QuestionPriorityType

ListLensReviewsInputRequestTypeDef#

# ListLensReviewsInputRequestTypeDef definition

class ListLensReviewsInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    MilestoneNumber: NotRequired[int],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListLensSharesInputRequestTypeDef#

# ListLensSharesInputRequestTypeDef definition

class ListLensSharesInputRequestTypeDef(TypedDict):
    LensAlias: str,
    SharedWithPrefix: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Status: NotRequired[ShareStatusType],  # (1)
  1. See ShareStatusType

ListLensesInputRequestTypeDef#

# ListLensesInputRequestTypeDef definition

class ListLensesInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    LensType: NotRequired[LensTypeType],  # (1)
    LensStatus: NotRequired[LensStatusTypeType],  # (2)
    LensName: NotRequired[str],
  1. See LensTypeType
  2. See LensStatusTypeType

ListMilestonesInputRequestTypeDef#

# ListMilestonesInputRequestTypeDef definition

class ListMilestonesInputRequestTypeDef(TypedDict):
    WorkloadId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListNotificationsInputRequestTypeDef#

# ListNotificationsInputRequestTypeDef definition

class ListNotificationsInputRequestTypeDef(TypedDict):
    WorkloadId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    ResourceArn: NotRequired[str],

ListProfileNotificationsInputRequestTypeDef#

# ListProfileNotificationsInputRequestTypeDef definition

class ListProfileNotificationsInputRequestTypeDef(TypedDict):
    WorkloadId: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ProfileNotificationSummaryTypeDef#

# ProfileNotificationSummaryTypeDef definition

class ProfileNotificationSummaryTypeDef(TypedDict):
    CurrentProfileVersion: NotRequired[str],
    LatestProfileVersion: NotRequired[str],
    Type: NotRequired[ProfileNotificationTypeType],  # (1)
    ProfileArn: NotRequired[str],
    ProfileName: NotRequired[str],
    WorkloadId: NotRequired[str],
    WorkloadName: NotRequired[str],
  1. See ProfileNotificationTypeType

ListProfileSharesInputRequestTypeDef#

# ListProfileSharesInputRequestTypeDef definition

class ListProfileSharesInputRequestTypeDef(TypedDict):
    ProfileArn: str,
    SharedWithPrefix: NotRequired[str],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Status: NotRequired[ShareStatusType],  # (1)
  1. See ShareStatusType

ProfileShareSummaryTypeDef#

# ProfileShareSummaryTypeDef definition

class ProfileShareSummaryTypeDef(TypedDict):
    ShareId: NotRequired[str],
    SharedWith: NotRequired[str],
    Status: NotRequired[ShareStatusType],  # (1)
    StatusMessage: NotRequired[str],
  1. See ShareStatusType

ListProfilesInputRequestTypeDef#

# Li