Typed dictionaries#
Index > WellArchitected > Typed dictionaries
Auto-generated documentation for WellArchitected type annotations stubs module mypy-boto3-wellarchitected.
ChoiceContentTypeDef#
# ChoiceContentTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ChoiceContentTypeDef
def get_value() -> ChoiceContentTypeDef:
return {
"DisplayText": ...,
}
# ChoiceContentTypeDef definition
class ChoiceContentTypeDef(TypedDict):
DisplayText: NotRequired[str],
Url: NotRequired[str],
ChoiceAnswerSummaryTypeDef#
# ChoiceAnswerSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ChoiceAnswerSummaryTypeDef
def get_value() -> ChoiceAnswerSummaryTypeDef:
return {
"ChoiceId": ...,
}
# ChoiceAnswerSummaryTypeDef definition
class ChoiceAnswerSummaryTypeDef(TypedDict):
ChoiceId: NotRequired[str],
Status: NotRequired[ChoiceStatusType], # (1)
Reason: NotRequired[ChoiceReasonType], # (2)
- See ChoiceStatusType
- See ChoiceReasonType
ChoiceAnswerTypeDef#
# ChoiceAnswerTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ChoiceAnswerTypeDef
def get_value() -> ChoiceAnswerTypeDef:
return {
"ChoiceId": ...,
}
# ChoiceAnswerTypeDef definition
class ChoiceAnswerTypeDef(TypedDict):
ChoiceId: NotRequired[str],
Status: NotRequired[ChoiceStatusType], # (1)
Reason: NotRequired[ChoiceReasonType], # (2)
Notes: NotRequired[str],
- See ChoiceStatusType
- See ChoiceReasonType
AssociateLensesInputRequestTypeDef#
# AssociateLensesInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import AssociateLensesInputRequestTypeDef
def get_value() -> AssociateLensesInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAliases": ...,
}
# AssociateLensesInputRequestTypeDef definition
class AssociateLensesInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAliases: Sequence[str],
BestPracticeTypeDef#
# BestPracticeTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import BestPracticeTypeDef
def get_value() -> BestPracticeTypeDef:
return {
"ChoiceId": ...,
}
# BestPracticeTypeDef definition
class BestPracticeTypeDef(TypedDict):
ChoiceId: NotRequired[str],
ChoiceTitle: NotRequired[str],
CheckDetailTypeDef#
# CheckDetailTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CheckDetailTypeDef
def get_value() -> CheckDetailTypeDef:
return {
"Id": ...,
}
# 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],
- See CheckProviderType
- See CheckStatusType
- See CheckFailureReasonType
CheckSummaryTypeDef#
# CheckSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CheckSummaryTypeDef
def get_value() -> CheckSummaryTypeDef:
return {
"Id": ...,
}
# 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)
- See CheckProviderType
- See CheckStatusType
- See CheckStatusType
ChoiceImprovementPlanTypeDef#
# ChoiceImprovementPlanTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ChoiceImprovementPlanTypeDef
def get_value() -> ChoiceImprovementPlanTypeDef:
return {
"ChoiceId": ...,
}
# ChoiceImprovementPlanTypeDef definition
class ChoiceImprovementPlanTypeDef(TypedDict):
ChoiceId: NotRequired[str],
DisplayText: NotRequired[str],
ImprovementPlanUrl: NotRequired[str],
ChoiceUpdateTypeDef#
# ChoiceUpdateTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ChoiceUpdateTypeDef
def get_value() -> ChoiceUpdateTypeDef:
return {
"Status": ...,
}
# ChoiceUpdateTypeDef definition
class ChoiceUpdateTypeDef(TypedDict):
Status: ChoiceStatusType, # (1)
Reason: NotRequired[ChoiceReasonType], # (2)
Notes: NotRequired[str],
- See ChoiceStatusType
- See ChoiceReasonType
CreateLensShareInputRequestTypeDef#
# CreateLensShareInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateLensShareInputRequestTypeDef
def get_value() -> CreateLensShareInputRequestTypeDef:
return {
"LensAlias": ...,
"SharedWith": ...,
"ClientRequestToken": ...,
}
# CreateLensShareInputRequestTypeDef definition
class CreateLensShareInputRequestTypeDef(TypedDict):
LensAlias: str,
SharedWith: str,
ClientRequestToken: str,
CreateLensShareOutputTypeDef#
# CreateLensShareOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateLensShareOutputTypeDef
def get_value() -> CreateLensShareOutputTypeDef:
return {
"ShareId": ...,
"ResponseMetadata": ...,
}
# CreateLensShareOutputTypeDef definition
class CreateLensShareOutputTypeDef(TypedDict):
ShareId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateLensVersionInputRequestTypeDef#
# CreateLensVersionInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateLensVersionInputRequestTypeDef
def get_value() -> CreateLensVersionInputRequestTypeDef:
return {
"LensAlias": ...,
"LensVersion": ...,
"ClientRequestToken": ...,
}
# CreateLensVersionInputRequestTypeDef definition
class CreateLensVersionInputRequestTypeDef(TypedDict):
LensAlias: str,
LensVersion: str,
ClientRequestToken: str,
IsMajorVersion: NotRequired[bool],
CreateLensVersionOutputTypeDef#
# CreateLensVersionOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateLensVersionOutputTypeDef
def get_value() -> CreateLensVersionOutputTypeDef:
return {
"LensArn": ...,
"LensVersion": ...,
"ResponseMetadata": ...,
}
# CreateLensVersionOutputTypeDef definition
class CreateLensVersionOutputTypeDef(TypedDict):
LensArn: str,
LensVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateMilestoneInputRequestTypeDef#
# CreateMilestoneInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateMilestoneInputRequestTypeDef
def get_value() -> CreateMilestoneInputRequestTypeDef:
return {
"WorkloadId": ...,
"MilestoneName": ...,
"ClientRequestToken": ...,
}
# CreateMilestoneInputRequestTypeDef definition
class CreateMilestoneInputRequestTypeDef(TypedDict):
WorkloadId: str,
MilestoneName: str,
ClientRequestToken: str,
CreateMilestoneOutputTypeDef#
# CreateMilestoneOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateMilestoneOutputTypeDef
def get_value() -> CreateMilestoneOutputTypeDef:
return {
"WorkloadId": ...,
"MilestoneNumber": ...,
"ResponseMetadata": ...,
}
# CreateMilestoneOutputTypeDef definition
class CreateMilestoneOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
WorkloadDiscoveryConfigTypeDef#
# WorkloadDiscoveryConfigTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import WorkloadDiscoveryConfigTypeDef
def get_value() -> WorkloadDiscoveryConfigTypeDef:
return {
"TrustedAdvisorIntegrationStatus": ...,
}
# WorkloadDiscoveryConfigTypeDef definition
class WorkloadDiscoveryConfigTypeDef(TypedDict):
TrustedAdvisorIntegrationStatus: NotRequired[TrustedAdvisorIntegrationStatusType], # (1)
WorkloadResourceDefinition: NotRequired[Sequence[DefinitionTypeType]], # (2)
CreateWorkloadOutputTypeDef#
# CreateWorkloadOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateWorkloadOutputTypeDef
def get_value() -> CreateWorkloadOutputTypeDef:
return {
"WorkloadId": ...,
"WorkloadArn": ...,
"ResponseMetadata": ...,
}
# CreateWorkloadOutputTypeDef definition
class CreateWorkloadOutputTypeDef(TypedDict):
WorkloadId: str,
WorkloadArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWorkloadShareInputRequestTypeDef#
# CreateWorkloadShareInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateWorkloadShareInputRequestTypeDef
def get_value() -> CreateWorkloadShareInputRequestTypeDef:
return {
"WorkloadId": ...,
"SharedWith": ...,
"PermissionType": ...,
"ClientRequestToken": ...,
}
# CreateWorkloadShareInputRequestTypeDef definition
class CreateWorkloadShareInputRequestTypeDef(TypedDict):
WorkloadId: str,
SharedWith: str,
PermissionType: PermissionTypeType, # (1)
ClientRequestToken: str,
CreateWorkloadShareOutputTypeDef#
# CreateWorkloadShareOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateWorkloadShareOutputTypeDef
def get_value() -> CreateWorkloadShareOutputTypeDef:
return {
"WorkloadId": ...,
"ShareId": ...,
"ResponseMetadata": ...,
}
# CreateWorkloadShareOutputTypeDef definition
class CreateWorkloadShareOutputTypeDef(TypedDict):
WorkloadId: str,
ShareId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteLensInputRequestTypeDef#
# DeleteLensInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import DeleteLensInputRequestTypeDef
def get_value() -> DeleteLensInputRequestTypeDef:
return {
"LensAlias": ...,
"ClientRequestToken": ...,
"LensStatus": ...,
}
# DeleteLensInputRequestTypeDef definition
class DeleteLensInputRequestTypeDef(TypedDict):
LensAlias: str,
ClientRequestToken: str,
LensStatus: LensStatusTypeType, # (1)
DeleteLensShareInputRequestTypeDef#
# DeleteLensShareInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import DeleteLensShareInputRequestTypeDef
def get_value() -> DeleteLensShareInputRequestTypeDef:
return {
"ShareId": ...,
"LensAlias": ...,
"ClientRequestToken": ...,
}
# DeleteLensShareInputRequestTypeDef definition
class DeleteLensShareInputRequestTypeDef(TypedDict):
ShareId: str,
LensAlias: str,
ClientRequestToken: str,
DeleteWorkloadInputRequestTypeDef#
# DeleteWorkloadInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import DeleteWorkloadInputRequestTypeDef
def get_value() -> DeleteWorkloadInputRequestTypeDef:
return {
"WorkloadId": ...,
"ClientRequestToken": ...,
}
# DeleteWorkloadInputRequestTypeDef definition
class DeleteWorkloadInputRequestTypeDef(TypedDict):
WorkloadId: str,
ClientRequestToken: str,
DeleteWorkloadShareInputRequestTypeDef#
# DeleteWorkloadShareInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import DeleteWorkloadShareInputRequestTypeDef
def get_value() -> DeleteWorkloadShareInputRequestTypeDef:
return {
"ShareId": ...,
"WorkloadId": ...,
"ClientRequestToken": ...,
}
# DeleteWorkloadShareInputRequestTypeDef definition
class DeleteWorkloadShareInputRequestTypeDef(TypedDict):
ShareId: str,
WorkloadId: str,
ClientRequestToken: str,
DisassociateLensesInputRequestTypeDef#
# DisassociateLensesInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import DisassociateLensesInputRequestTypeDef
def get_value() -> DisassociateLensesInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAliases": ...,
}
# DisassociateLensesInputRequestTypeDef definition
class DisassociateLensesInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAliases: Sequence[str],
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ExportLensInputRequestTypeDef#
# ExportLensInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ExportLensInputRequestTypeDef
def get_value() -> ExportLensInputRequestTypeDef:
return {
"LensAlias": ...,
}
# ExportLensInputRequestTypeDef definition
class ExportLensInputRequestTypeDef(TypedDict):
LensAlias: str,
LensVersion: NotRequired[str],
ExportLensOutputTypeDef#
# ExportLensOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ExportLensOutputTypeDef
def get_value() -> ExportLensOutputTypeDef:
return {
"LensJSON": ...,
"ResponseMetadata": ...,
}
# ExportLensOutputTypeDef definition
class ExportLensOutputTypeDef(TypedDict):
LensJSON: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetAnswerInputRequestTypeDef#
# GetAnswerInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetAnswerInputRequestTypeDef
def get_value() -> GetAnswerInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAlias": ...,
"QuestionId": ...,
}
# GetAnswerInputRequestTypeDef definition
class GetAnswerInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
QuestionId: str,
MilestoneNumber: NotRequired[int],
GetConsolidatedReportInputRequestTypeDef#
# GetConsolidatedReportInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetConsolidatedReportInputRequestTypeDef
def get_value() -> GetConsolidatedReportInputRequestTypeDef:
return {
"Format": ...,
}
# GetConsolidatedReportInputRequestTypeDef definition
class GetConsolidatedReportInputRequestTypeDef(TypedDict):
Format: ReportFormatType, # (1)
IncludeSharedResources: NotRequired[bool],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
- See ReportFormatType
GetLensInputRequestTypeDef#
# GetLensInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetLensInputRequestTypeDef
def get_value() -> GetLensInputRequestTypeDef:
return {
"LensAlias": ...,
}
# GetLensInputRequestTypeDef definition
class GetLensInputRequestTypeDef(TypedDict):
LensAlias: str,
LensVersion: NotRequired[str],
LensTypeDef#
# LensTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import LensTypeDef
def get_value() -> LensTypeDef:
return {
"LensArn": ...,
}
# 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 usage example
from mypy_boto3_wellarchitected.type_defs import GetLensReviewInputRequestTypeDef
def get_value() -> GetLensReviewInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAlias": ...,
}
# GetLensReviewInputRequestTypeDef definition
class GetLensReviewInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
MilestoneNumber: NotRequired[int],
GetLensReviewReportInputRequestTypeDef#
# GetLensReviewReportInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetLensReviewReportInputRequestTypeDef
def get_value() -> GetLensReviewReportInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAlias": ...,
}
# GetLensReviewReportInputRequestTypeDef definition
class GetLensReviewReportInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
MilestoneNumber: NotRequired[int],
LensReviewReportTypeDef#
# LensReviewReportTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import LensReviewReportTypeDef
def get_value() -> LensReviewReportTypeDef:
return {
"LensAlias": ...,
}
# LensReviewReportTypeDef definition
class LensReviewReportTypeDef(TypedDict):
LensAlias: NotRequired[str],
LensArn: NotRequired[str],
Base64String: NotRequired[str],
GetLensVersionDifferenceInputRequestTypeDef#
# GetLensVersionDifferenceInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetLensVersionDifferenceInputRequestTypeDef
def get_value() -> GetLensVersionDifferenceInputRequestTypeDef:
return {
"LensAlias": ...,
}
# GetLensVersionDifferenceInputRequestTypeDef definition
class GetLensVersionDifferenceInputRequestTypeDef(TypedDict):
LensAlias: str,
BaseLensVersion: NotRequired[str],
TargetLensVersion: NotRequired[str],
GetMilestoneInputRequestTypeDef#
# GetMilestoneInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetMilestoneInputRequestTypeDef
def get_value() -> GetMilestoneInputRequestTypeDef:
return {
"WorkloadId": ...,
"MilestoneNumber": ...,
}
# GetMilestoneInputRequestTypeDef definition
class GetMilestoneInputRequestTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
GetWorkloadInputRequestTypeDef#
# GetWorkloadInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetWorkloadInputRequestTypeDef
def get_value() -> GetWorkloadInputRequestTypeDef:
return {
"WorkloadId": ...,
}
# GetWorkloadInputRequestTypeDef definition
class GetWorkloadInputRequestTypeDef(TypedDict):
WorkloadId: str,
ImportLensInputRequestTypeDef#
# ImportLensInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ImportLensInputRequestTypeDef
def get_value() -> ImportLensInputRequestTypeDef:
return {
"JSONString": ...,
"ClientRequestToken": ...,
}
# ImportLensInputRequestTypeDef definition
class ImportLensInputRequestTypeDef(TypedDict):
JSONString: str,
ClientRequestToken: str,
LensAlias: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
ImportLensOutputTypeDef#
# ImportLensOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ImportLensOutputTypeDef
def get_value() -> ImportLensOutputTypeDef:
return {
"LensArn": ...,
"Status": ...,
"ResponseMetadata": ...,
}
# ImportLensOutputTypeDef definition
class ImportLensOutputTypeDef(TypedDict):
LensArn: str,
Status: ImportLensStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LensReviewSummaryTypeDef#
# LensReviewSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import LensReviewSummaryTypeDef
def get_value() -> LensReviewSummaryTypeDef:
return {
"LensAlias": ...,
}
# LensReviewSummaryTypeDef definition
class LensReviewSummaryTypeDef(TypedDict):
LensAlias: NotRequired[str],
LensArn: NotRequired[str],
LensVersion: NotRequired[str],
LensName: NotRequired[str],
LensStatus: NotRequired[LensStatusType], # (1)
UpdatedAt: NotRequired[datetime],
RiskCounts: NotRequired[Dict[RiskType, int]], # (2)
- See LensStatusType
- See RiskType
PillarReviewSummaryTypeDef#
# PillarReviewSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import PillarReviewSummaryTypeDef
def get_value() -> PillarReviewSummaryTypeDef:
return {
"PillarId": ...,
}
# PillarReviewSummaryTypeDef definition
class PillarReviewSummaryTypeDef(TypedDict):
PillarId: NotRequired[str],
PillarName: NotRequired[str],
Notes: NotRequired[str],
RiskCounts: NotRequired[Dict[RiskType, int]], # (1)
- See RiskType
LensShareSummaryTypeDef#
# LensShareSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import LensShareSummaryTypeDef
def get_value() -> LensShareSummaryTypeDef:
return {
"ShareId": ...,
}
# LensShareSummaryTypeDef definition
class LensShareSummaryTypeDef(TypedDict):
ShareId: NotRequired[str],
SharedWith: NotRequired[str],
Status: NotRequired[ShareStatusType], # (1)
StatusMessage: NotRequired[str],
- See ShareStatusType
LensSummaryTypeDef#
# LensSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import LensSummaryTypeDef
def get_value() -> LensSummaryTypeDef:
return {
"LensArn": ...,
}
# 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)
- See LensTypeType
- See LensStatusType
LensUpgradeSummaryTypeDef#
# LensUpgradeSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import LensUpgradeSummaryTypeDef
def get_value() -> LensUpgradeSummaryTypeDef:
return {
"WorkloadId": ...,
}
# LensUpgradeSummaryTypeDef definition
class LensUpgradeSummaryTypeDef(TypedDict):
WorkloadId: NotRequired[str],
WorkloadName: NotRequired[str],
LensAlias: NotRequired[str],
LensArn: NotRequired[str],
CurrentLensVersion: NotRequired[str],
LatestLensVersion: NotRequired[str],
ListAnswersInputRequestTypeDef#
# ListAnswersInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListAnswersInputRequestTypeDef
def get_value() -> ListAnswersInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAlias": ...,
}
# ListAnswersInputRequestTypeDef definition
class ListAnswersInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
PillarId: NotRequired[str],
MilestoneNumber: NotRequired[int],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListCheckDetailsInputRequestTypeDef#
# ListCheckDetailsInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListCheckDetailsInputRequestTypeDef
def get_value() -> ListCheckDetailsInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensArn": ...,
"PillarId": ...,
"QuestionId": ...,
"ChoiceId": ...,
}
# ListCheckDetailsInputRequestTypeDef definition
class ListCheckDetailsInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensArn: str,
PillarId: str,
QuestionId: str,
ChoiceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListCheckSummariesInputRequestTypeDef#
# ListCheckSummariesInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListCheckSummariesInputRequestTypeDef
def get_value() -> ListCheckSummariesInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensArn": ...,
"PillarId": ...,
"QuestionId": ...,
"ChoiceId": ...,
}
# ListCheckSummariesInputRequestTypeDef definition
class ListCheckSummariesInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensArn: str,
PillarId: str,
QuestionId: str,
ChoiceId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListLensReviewImprovementsInputRequestTypeDef#
# ListLensReviewImprovementsInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListLensReviewImprovementsInputRequestTypeDef
def get_value() -> ListLensReviewImprovementsInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAlias": ...,
}
# ListLensReviewImprovementsInputRequestTypeDef definition
class ListLensReviewImprovementsInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
PillarId: NotRequired[str],
MilestoneNumber: NotRequired[int],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListLensReviewsInputRequestTypeDef#
# ListLensReviewsInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListLensReviewsInputRequestTypeDef
def get_value() -> ListLensReviewsInputRequestTypeDef:
return {
"WorkloadId": ...,
}
# ListLensReviewsInputRequestTypeDef definition
class ListLensReviewsInputRequestTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: NotRequired[int],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListLensSharesInputRequestTypeDef#
# ListLensSharesInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListLensSharesInputRequestTypeDef
def get_value() -> ListLensSharesInputRequestTypeDef:
return {
"LensAlias": ...,
}
# ListLensSharesInputRequestTypeDef definition
class ListLensSharesInputRequestTypeDef(TypedDict):
LensAlias: str,
SharedWithPrefix: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Status: NotRequired[ShareStatusType], # (1)
- See ShareStatusType
ListLensesInputRequestTypeDef#
# ListLensesInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListLensesInputRequestTypeDef
def get_value() -> ListLensesInputRequestTypeDef:
return {
"NextToken": ...,
}
# ListLensesInputRequestTypeDef definition
class ListLensesInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
LensType: NotRequired[LensTypeType], # (1)
LensStatus: NotRequired[LensStatusTypeType], # (2)
LensName: NotRequired[str],
- See LensTypeType
- See LensStatusTypeType
ListMilestonesInputRequestTypeDef#
# ListMilestonesInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListMilestonesInputRequestTypeDef
def get_value() -> ListMilestonesInputRequestTypeDef:
return {
"WorkloadId": ...,
}
# ListMilestonesInputRequestTypeDef definition
class ListMilestonesInputRequestTypeDef(TypedDict):
WorkloadId: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListNotificationsInputRequestTypeDef#
# ListNotificationsInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListNotificationsInputRequestTypeDef
def get_value() -> ListNotificationsInputRequestTypeDef:
return {
"WorkloadId": ...,
}
# ListNotificationsInputRequestTypeDef definition
class ListNotificationsInputRequestTypeDef(TypedDict):
WorkloadId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListShareInvitationsInputRequestTypeDef#
# ListShareInvitationsInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListShareInvitationsInputRequestTypeDef
def get_value() -> ListShareInvitationsInputRequestTypeDef:
return {
"WorkloadNamePrefix": ...,
}
# ListShareInvitationsInputRequestTypeDef definition
class ListShareInvitationsInputRequestTypeDef(TypedDict):
WorkloadNamePrefix: NotRequired[str],
LensNamePrefix: NotRequired[str],
ShareResourceType: NotRequired[ShareResourceTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ShareInvitationSummaryTypeDef#
# ShareInvitationSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ShareInvitationSummaryTypeDef
def get_value() -> ShareInvitationSummaryTypeDef:
return {
"ShareInvitationId": ...,
}
# ShareInvitationSummaryTypeDef definition
class ShareInvitationSummaryTypeDef(TypedDict):
ShareInvitationId: NotRequired[str],
SharedBy: NotRequired[str],
SharedWith: NotRequired[str],
PermissionType: NotRequired[PermissionTypeType], # (1)
ShareResourceType: NotRequired[ShareResourceTypeType], # (2)
WorkloadName: NotRequired[str],
WorkloadId: NotRequired[str],
LensName: NotRequired[str],
LensArn: NotRequired[str],
ListTagsForResourceInputRequestTypeDef#
# ListTagsForResourceInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListTagsForResourceInputRequestTypeDef
def get_value() -> ListTagsForResourceInputRequestTypeDef:
return {
"WorkloadArn": ...,
}
# ListTagsForResourceInputRequestTypeDef definition
class ListTagsForResourceInputRequestTypeDef(TypedDict):
WorkloadArn: str,
ListTagsForResourceOutputTypeDef#
# ListTagsForResourceOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListTagsForResourceOutputTypeDef
def get_value() -> ListTagsForResourceOutputTypeDef:
return {
"Tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceOutputTypeDef definition
class ListTagsForResourceOutputTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListWorkloadSharesInputRequestTypeDef#
# ListWorkloadSharesInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListWorkloadSharesInputRequestTypeDef
def get_value() -> ListWorkloadSharesInputRequestTypeDef:
return {
"WorkloadId": ...,
}
# ListWorkloadSharesInputRequestTypeDef definition
class ListWorkloadSharesInputRequestTypeDef(TypedDict):
WorkloadId: str,
SharedWithPrefix: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Status: NotRequired[ShareStatusType], # (1)
- See ShareStatusType
WorkloadShareSummaryTypeDef#
# WorkloadShareSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import WorkloadShareSummaryTypeDef
def get_value() -> WorkloadShareSummaryTypeDef:
return {
"ShareId": ...,
}
# WorkloadShareSummaryTypeDef definition
class WorkloadShareSummaryTypeDef(TypedDict):
ShareId: NotRequired[str],
SharedWith: NotRequired[str],
PermissionType: NotRequired[PermissionTypeType], # (1)
Status: NotRequired[ShareStatusType], # (2)
StatusMessage: NotRequired[str],
- See PermissionTypeType
- See ShareStatusType
ListWorkloadsInputRequestTypeDef#
# ListWorkloadsInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListWorkloadsInputRequestTypeDef
def get_value() -> ListWorkloadsInputRequestTypeDef:
return {
"WorkloadNamePrefix": ...,
}
# ListWorkloadsInputRequestTypeDef definition
class ListWorkloadsInputRequestTypeDef(TypedDict):
WorkloadNamePrefix: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
WorkloadSummaryTypeDef#
# WorkloadSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import WorkloadSummaryTypeDef
def get_value() -> WorkloadSummaryTypeDef:
return {
"WorkloadId": ...,
}
# WorkloadSummaryTypeDef definition
class WorkloadSummaryTypeDef(TypedDict):
WorkloadId: NotRequired[str],
WorkloadArn: NotRequired[str],
WorkloadName: NotRequired[str],
Owner: NotRequired[str],
UpdatedAt: NotRequired[datetime],
Lenses: NotRequired[List[str]],
RiskCounts: NotRequired[Dict[RiskType, int]], # (1)
ImprovementStatus: NotRequired[WorkloadImprovementStatusType], # (2)
QuestionDifferenceTypeDef#
# QuestionDifferenceTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import QuestionDifferenceTypeDef
def get_value() -> QuestionDifferenceTypeDef:
return {
"QuestionId": ...,
}
# QuestionDifferenceTypeDef definition
class QuestionDifferenceTypeDef(TypedDict):
QuestionId: NotRequired[str],
QuestionTitle: NotRequired[str],
DifferenceStatus: NotRequired[DifferenceStatusType], # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
ShareInvitationTypeDef#
# ShareInvitationTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ShareInvitationTypeDef
def get_value() -> ShareInvitationTypeDef:
return {
"ShareInvitationId": ...,
}
# ShareInvitationTypeDef definition
class ShareInvitationTypeDef(TypedDict):
ShareInvitationId: NotRequired[str],
ShareResourceType: NotRequired[ShareResourceTypeType], # (1)
WorkloadId: NotRequired[str],
LensAlias: NotRequired[str],
LensArn: NotRequired[str],
TagResourceInputRequestTypeDef#
# TagResourceInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import TagResourceInputRequestTypeDef
def get_value() -> TagResourceInputRequestTypeDef:
return {
"WorkloadArn": ...,
"Tags": ...,
}
# TagResourceInputRequestTypeDef definition
class TagResourceInputRequestTypeDef(TypedDict):
WorkloadArn: str,
Tags: Mapping[str, str],
UntagResourceInputRequestTypeDef#
# UntagResourceInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UntagResourceInputRequestTypeDef
def get_value() -> UntagResourceInputRequestTypeDef:
return {
"WorkloadArn": ...,
"TagKeys": ...,
}
# UntagResourceInputRequestTypeDef definition
class UntagResourceInputRequestTypeDef(TypedDict):
WorkloadArn: str,
TagKeys: Sequence[str],
UpdateGlobalSettingsInputRequestTypeDef#
# UpdateGlobalSettingsInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateGlobalSettingsInputRequestTypeDef
def get_value() -> UpdateGlobalSettingsInputRequestTypeDef:
return {
"OrganizationSharingStatus": ...,
}
# UpdateGlobalSettingsInputRequestTypeDef definition
class UpdateGlobalSettingsInputRequestTypeDef(TypedDict):
OrganizationSharingStatus: NotRequired[OrganizationSharingStatusType], # (1)
DiscoveryIntegrationStatus: NotRequired[DiscoveryIntegrationStatusType], # (2)
UpdateLensReviewInputRequestTypeDef#
# UpdateLensReviewInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateLensReviewInputRequestTypeDef
def get_value() -> UpdateLensReviewInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAlias": ...,
}
# UpdateLensReviewInputRequestTypeDef definition
class UpdateLensReviewInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
LensNotes: NotRequired[str],
PillarNotes: NotRequired[Mapping[str, str]],
UpdateShareInvitationInputRequestTypeDef#
# UpdateShareInvitationInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateShareInvitationInputRequestTypeDef
def get_value() -> UpdateShareInvitationInputRequestTypeDef:
return {
"ShareInvitationId": ...,
"ShareInvitationAction": ...,
}
# UpdateShareInvitationInputRequestTypeDef definition
class UpdateShareInvitationInputRequestTypeDef(TypedDict):
ShareInvitationId: str,
ShareInvitationAction: ShareInvitationActionType, # (1)
UpdateWorkloadShareInputRequestTypeDef#
# UpdateWorkloadShareInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateWorkloadShareInputRequestTypeDef
def get_value() -> UpdateWorkloadShareInputRequestTypeDef:
return {
"ShareId": ...,
"WorkloadId": ...,
"PermissionType": ...,
}
# UpdateWorkloadShareInputRequestTypeDef definition
class UpdateWorkloadShareInputRequestTypeDef(TypedDict):
ShareId: str,
WorkloadId: str,
PermissionType: PermissionTypeType, # (1)
WorkloadShareTypeDef#
# WorkloadShareTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import WorkloadShareTypeDef
def get_value() -> WorkloadShareTypeDef:
return {
"ShareId": ...,
}
# WorkloadShareTypeDef definition
class WorkloadShareTypeDef(TypedDict):
ShareId: NotRequired[str],
SharedBy: NotRequired[str],
SharedWith: NotRequired[str],
PermissionType: NotRequired[PermissionTypeType], # (1)
Status: NotRequired[ShareStatusType], # (2)
WorkloadName: NotRequired[str],
WorkloadId: NotRequired[str],
- See PermissionTypeType
- See ShareStatusType
UpgradeLensReviewInputRequestTypeDef#
# UpgradeLensReviewInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpgradeLensReviewInputRequestTypeDef
def get_value() -> UpgradeLensReviewInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAlias": ...,
"MilestoneName": ...,
}
# UpgradeLensReviewInputRequestTypeDef definition
class UpgradeLensReviewInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
MilestoneName: str,
ClientRequestToken: NotRequired[str],
AdditionalResourcesTypeDef#
# AdditionalResourcesTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import AdditionalResourcesTypeDef
def get_value() -> AdditionalResourcesTypeDef:
return {
"Type": ...,
}
# AdditionalResourcesTypeDef definition
class AdditionalResourcesTypeDef(TypedDict):
Type: NotRequired[AdditionalResourceTypeType], # (1)
Content: NotRequired[List[ChoiceContentTypeDef]], # (2)
QuestionMetricTypeDef#
# QuestionMetricTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import QuestionMetricTypeDef
def get_value() -> QuestionMetricTypeDef:
return {
"QuestionId": ...,
}
# QuestionMetricTypeDef definition
class QuestionMetricTypeDef(TypedDict):
QuestionId: NotRequired[str],
Risk: NotRequired[RiskType], # (1)
BestPractices: NotRequired[List[BestPracticeTypeDef]], # (2)
- See RiskType
- See BestPracticeTypeDef
ListCheckDetailsOutputTypeDef#
# ListCheckDetailsOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListCheckDetailsOutputTypeDef
def get_value() -> ListCheckDetailsOutputTypeDef:
return {
"CheckDetails": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListCheckDetailsOutputTypeDef definition
class ListCheckDetailsOutputTypeDef(TypedDict):
CheckDetails: List[CheckDetailTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListCheckSummariesOutputTypeDef#
# ListCheckSummariesOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListCheckSummariesOutputTypeDef
def get_value() -> ListCheckSummariesOutputTypeDef:
return {
"CheckSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListCheckSummariesOutputTypeDef definition
class ListCheckSummariesOutputTypeDef(TypedDict):
CheckSummaries: List[CheckSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ImprovementSummaryTypeDef#
# ImprovementSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ImprovementSummaryTypeDef
def get_value() -> ImprovementSummaryTypeDef:
return {
"QuestionId": ...,
}
# ImprovementSummaryTypeDef definition
class ImprovementSummaryTypeDef(TypedDict):
QuestionId: NotRequired[str],
PillarId: NotRequired[str],
QuestionTitle: NotRequired[str],
Risk: NotRequired[RiskType], # (1)
ImprovementPlanUrl: NotRequired[str],
ImprovementPlans: NotRequired[List[ChoiceImprovementPlanTypeDef]], # (2)
- See RiskType
- See ChoiceImprovementPlanTypeDef
UpdateAnswerInputRequestTypeDef#
# UpdateAnswerInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateAnswerInputRequestTypeDef
def get_value() -> UpdateAnswerInputRequestTypeDef:
return {
"WorkloadId": ...,
"LensAlias": ...,
"QuestionId": ...,
}
# UpdateAnswerInputRequestTypeDef definition
class UpdateAnswerInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
QuestionId: str,
SelectedChoices: NotRequired[Sequence[str]],
ChoiceUpdates: NotRequired[Mapping[str, ChoiceUpdateTypeDef]], # (1)
Notes: NotRequired[str],
IsApplicable: NotRequired[bool],
Reason: NotRequired[AnswerReasonType], # (2)
- See ChoiceUpdateTypeDef
- See AnswerReasonType
CreateWorkloadInputRequestTypeDef#
# CreateWorkloadInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import CreateWorkloadInputRequestTypeDef
def get_value() -> CreateWorkloadInputRequestTypeDef:
return {
"WorkloadName": ...,
"Description": ...,
"Environment": ...,
"Lenses": ...,
"ClientRequestToken": ...,
}
# CreateWorkloadInputRequestTypeDef definition
class CreateWorkloadInputRequestTypeDef(TypedDict):
WorkloadName: str,
Description: str,
Environment: WorkloadEnvironmentType, # (1)
Lenses: Sequence[str],
ClientRequestToken: str,
AccountIds: NotRequired[Sequence[str]],
AwsRegions: NotRequired[Sequence[str]],
NonAwsRegions: NotRequired[Sequence[str]],
PillarPriorities: NotRequired[Sequence[str]],
ArchitecturalDesign: NotRequired[str],
ReviewOwner: NotRequired[str],
IndustryType: NotRequired[str],
Industry: NotRequired[str],
Notes: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
DiscoveryConfig: NotRequired[WorkloadDiscoveryConfigTypeDef], # (2)
Applications: NotRequired[Sequence[str]],
UpdateWorkloadInputRequestTypeDef#
# UpdateWorkloadInputRequestTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateWorkloadInputRequestTypeDef
def get_value() -> UpdateWorkloadInputRequestTypeDef:
return {
"WorkloadId": ...,
}
# UpdateWorkloadInputRequestTypeDef definition
class UpdateWorkloadInputRequestTypeDef(TypedDict):
WorkloadId: str,
WorkloadName: NotRequired[str],
Description: NotRequired[str],
Environment: NotRequired[WorkloadEnvironmentType], # (1)
AccountIds: NotRequired[Sequence[str]],
AwsRegions: NotRequired[Sequence[str]],
NonAwsRegions: NotRequired[Sequence[str]],
PillarPriorities: NotRequired[Sequence[str]],
ArchitecturalDesign: NotRequired[str],
ReviewOwner: NotRequired[str],
IsReviewOwnerUpdateAcknowledged: NotRequired[bool],
IndustryType: NotRequired[str],
Industry: NotRequired[str],
Notes: NotRequired[str],
ImprovementStatus: NotRequired[WorkloadImprovementStatusType], # (2)
DiscoveryConfig: NotRequired[WorkloadDiscoveryConfigTypeDef], # (3)
Applications: NotRequired[Sequence[str]],
WorkloadTypeDef#
# WorkloadTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import WorkloadTypeDef
def get_value() -> WorkloadTypeDef:
return {
"WorkloadId": ...,
}
# WorkloadTypeDef definition
class WorkloadTypeDef(TypedDict):
WorkloadId: NotRequired[str],
WorkloadArn: NotRequired[str],
WorkloadName: NotRequired[str],
Description: NotRequired[str],
Environment: NotRequired[WorkloadEnvironmentType], # (1)
UpdatedAt: NotRequired[datetime],
AccountIds: NotRequired[List[str]],
AwsRegions: NotRequired[List[str]],
NonAwsRegions: NotRequired[List[str]],
ArchitecturalDesign: NotRequired[str],
ReviewOwner: NotRequired[str],
ReviewRestrictionDate: NotRequired[datetime],
IsReviewOwnerUpdateAcknowledged: NotRequired[bool],
IndustryType: NotRequired[str],
Industry: NotRequired[str],
Notes: NotRequired[str],
ImprovementStatus: NotRequired[WorkloadImprovementStatusType], # (2)
RiskCounts: NotRequired[Dict[RiskType, int]], # (3)
PillarPriorities: NotRequired[List[str]],
Lenses: NotRequired[List[str]],
Owner: NotRequired[str],
ShareInvitationId: NotRequired[str],
Tags: NotRequired[Dict[str, str]],
DiscoveryConfig: NotRequired[WorkloadDiscoveryConfigTypeDef], # (4)
Applications: NotRequired[List[str]],
- See WorkloadEnvironmentType
- See WorkloadImprovementStatusType
- See RiskType
- See WorkloadDiscoveryConfigTypeDef
GetLensOutputTypeDef#
# GetLensOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetLensOutputTypeDef
def get_value() -> GetLensOutputTypeDef:
return {
"Lens": ...,
"ResponseMetadata": ...,
}
# GetLensOutputTypeDef definition
class GetLensOutputTypeDef(TypedDict):
Lens: LensTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See LensTypeDef
- See ResponseMetadataTypeDef
GetLensReviewReportOutputTypeDef#
# GetLensReviewReportOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetLensReviewReportOutputTypeDef
def get_value() -> GetLensReviewReportOutputTypeDef:
return {
"WorkloadId": ...,
"MilestoneNumber": ...,
"LensReviewReport": ...,
"ResponseMetadata": ...,
}
# GetLensReviewReportOutputTypeDef definition
class GetLensReviewReportOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensReviewReport: LensReviewReportTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListLensReviewsOutputTypeDef#
# ListLensReviewsOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListLensReviewsOutputTypeDef
def get_value() -> ListLensReviewsOutputTypeDef:
return {
"WorkloadId": ...,
"MilestoneNumber": ...,
"LensReviewSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListLensReviewsOutputTypeDef definition
class ListLensReviewsOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensReviewSummaries: List[LensReviewSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
LensReviewTypeDef#
# LensReviewTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import LensReviewTypeDef
def get_value() -> LensReviewTypeDef:
return {
"LensAlias": ...,
}
# LensReviewTypeDef definition
class LensReviewTypeDef(TypedDict):
LensAlias: NotRequired[str],
LensArn: NotRequired[str],
LensVersion: NotRequired[str],
LensName: NotRequired[str],
LensStatus: NotRequired[LensStatusType], # (1)
PillarReviewSummaries: NotRequired[List[PillarReviewSummaryTypeDef]], # (2)
UpdatedAt: NotRequired[datetime],
Notes: NotRequired[str],
RiskCounts: NotRequired[Dict[RiskType, int]], # (3)
NextToken: NotRequired[str],
- See LensStatusType
- See PillarReviewSummaryTypeDef
- See RiskType
ListLensSharesOutputTypeDef#
# ListLensSharesOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListLensSharesOutputTypeDef
def get_value() -> ListLensSharesOutputTypeDef:
return {
"LensShareSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListLensSharesOutputTypeDef definition
class ListLensSharesOutputTypeDef(TypedDict):
LensShareSummaries: List[LensShareSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListLensesOutputTypeDef#
# ListLensesOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListLensesOutputTypeDef
def get_value() -> ListLensesOutputTypeDef:
return {
"LensSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListLensesOutputTypeDef definition
class ListLensesOutputTypeDef(TypedDict):
LensSummaries: List[LensSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NotificationSummaryTypeDef#
# NotificationSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import NotificationSummaryTypeDef
def get_value() -> NotificationSummaryTypeDef:
return {
"Type": ...,
}
# NotificationSummaryTypeDef definition
class NotificationSummaryTypeDef(TypedDict):
Type: NotRequired[NotificationTypeType], # (1)
LensUpgradeSummary: NotRequired[LensUpgradeSummaryTypeDef], # (2)
ListShareInvitationsOutputTypeDef#
# ListShareInvitationsOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListShareInvitationsOutputTypeDef
def get_value() -> ListShareInvitationsOutputTypeDef:
return {
"ShareInvitationSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListShareInvitationsOutputTypeDef definition
class ListShareInvitationsOutputTypeDef(TypedDict):
ShareInvitationSummaries: List[ShareInvitationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListWorkloadSharesOutputTypeDef#
# ListWorkloadSharesOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListWorkloadSharesOutputTypeDef
def get_value() -> ListWorkloadSharesOutputTypeDef:
return {
"WorkloadId": ...,
"WorkloadShareSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListWorkloadSharesOutputTypeDef definition
class ListWorkloadSharesOutputTypeDef(TypedDict):
WorkloadId: str,
WorkloadShareSummaries: List[WorkloadShareSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListWorkloadsOutputTypeDef#
# ListWorkloadsOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListWorkloadsOutputTypeDef
def get_value() -> ListWorkloadsOutputTypeDef:
return {
"WorkloadSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListWorkloadsOutputTypeDef definition
class ListWorkloadsOutputTypeDef(TypedDict):
WorkloadSummaries: List[WorkloadSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MilestoneSummaryTypeDef#
# MilestoneSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import MilestoneSummaryTypeDef
def get_value() -> MilestoneSummaryTypeDef:
return {
"MilestoneNumber": ...,
}
# MilestoneSummaryTypeDef definition
class MilestoneSummaryTypeDef(TypedDict):
MilestoneNumber: NotRequired[int],
MilestoneName: NotRequired[str],
RecordedAt: NotRequired[datetime],
WorkloadSummary: NotRequired[WorkloadSummaryTypeDef], # (1)
PillarDifferenceTypeDef#
# PillarDifferenceTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import PillarDifferenceTypeDef
def get_value() -> PillarDifferenceTypeDef:
return {
"PillarId": ...,
}
# PillarDifferenceTypeDef definition
class PillarDifferenceTypeDef(TypedDict):
PillarId: NotRequired[str],
PillarName: NotRequired[str],
DifferenceStatus: NotRequired[DifferenceStatusType], # (1)
QuestionDifferences: NotRequired[List[QuestionDifferenceTypeDef]], # (2)
UpdateShareInvitationOutputTypeDef#
# UpdateShareInvitationOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateShareInvitationOutputTypeDef
def get_value() -> UpdateShareInvitationOutputTypeDef:
return {
"ShareInvitation": ...,
"ResponseMetadata": ...,
}
# UpdateShareInvitationOutputTypeDef definition
class UpdateShareInvitationOutputTypeDef(TypedDict):
ShareInvitation: ShareInvitationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateWorkloadShareOutputTypeDef#
# UpdateWorkloadShareOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateWorkloadShareOutputTypeDef
def get_value() -> UpdateWorkloadShareOutputTypeDef:
return {
"WorkloadId": ...,
"WorkloadShare": ...,
"ResponseMetadata": ...,
}
# UpdateWorkloadShareOutputTypeDef definition
class UpdateWorkloadShareOutputTypeDef(TypedDict):
WorkloadId: str,
WorkloadShare: WorkloadShareTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ChoiceTypeDef#
# ChoiceTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ChoiceTypeDef
def get_value() -> ChoiceTypeDef:
return {
"ChoiceId": ...,
}
# ChoiceTypeDef definition
class ChoiceTypeDef(TypedDict):
ChoiceId: NotRequired[str],
Title: NotRequired[str],
Description: NotRequired[str],
HelpfulResource: NotRequired[ChoiceContentTypeDef], # (1)
ImprovementPlan: NotRequired[ChoiceContentTypeDef], # (1)
AdditionalResources: NotRequired[List[AdditionalResourcesTypeDef]], # (3)
PillarMetricTypeDef#
# PillarMetricTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import PillarMetricTypeDef
def get_value() -> PillarMetricTypeDef:
return {
"PillarId": ...,
}
# PillarMetricTypeDef definition
class PillarMetricTypeDef(TypedDict):
PillarId: NotRequired[str],
RiskCounts: NotRequired[Dict[RiskType, int]], # (1)
Questions: NotRequired[List[QuestionMetricTypeDef]], # (2)
- See RiskType
- See QuestionMetricTypeDef
ListLensReviewImprovementsOutputTypeDef#
# ListLensReviewImprovementsOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListLensReviewImprovementsOutputTypeDef
def get_value() -> ListLensReviewImprovementsOutputTypeDef:
return {
"WorkloadId": ...,
"MilestoneNumber": ...,
"LensAlias": ...,
"LensArn": ...,
"ImprovementSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListLensReviewImprovementsOutputTypeDef definition
class ListLensReviewImprovementsOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensAlias: str,
LensArn: str,
ImprovementSummaries: List[ImprovementSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetWorkloadOutputTypeDef#
# GetWorkloadOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetWorkloadOutputTypeDef
def get_value() -> GetWorkloadOutputTypeDef:
return {
"Workload": ...,
"ResponseMetadata": ...,
}
# GetWorkloadOutputTypeDef definition
class GetWorkloadOutputTypeDef(TypedDict):
Workload: WorkloadTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MilestoneTypeDef#
# MilestoneTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import MilestoneTypeDef
def get_value() -> MilestoneTypeDef:
return {
"MilestoneNumber": ...,
}
# MilestoneTypeDef definition
class MilestoneTypeDef(TypedDict):
MilestoneNumber: NotRequired[int],
MilestoneName: NotRequired[str],
RecordedAt: NotRequired[datetime],
Workload: NotRequired[WorkloadTypeDef], # (1)
- See WorkloadTypeDef
UpdateWorkloadOutputTypeDef#
# UpdateWorkloadOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateWorkloadOutputTypeDef
def get_value() -> UpdateWorkloadOutputTypeDef:
return {
"Workload": ...,
"ResponseMetadata": ...,
}
# UpdateWorkloadOutputTypeDef definition
class UpdateWorkloadOutputTypeDef(TypedDict):
Workload: WorkloadTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetLensReviewOutputTypeDef#
# GetLensReviewOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetLensReviewOutputTypeDef
def get_value() -> GetLensReviewOutputTypeDef:
return {
"WorkloadId": ...,
"MilestoneNumber": ...,
"LensReview": ...,
"ResponseMetadata": ...,
}
# GetLensReviewOutputTypeDef definition
class GetLensReviewOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensReview: LensReviewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateLensReviewOutputTypeDef#
# UpdateLensReviewOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateLensReviewOutputTypeDef
def get_value() -> UpdateLensReviewOutputTypeDef:
return {
"WorkloadId": ...,
"LensReview": ...,
"ResponseMetadata": ...,
}
# UpdateLensReviewOutputTypeDef definition
class UpdateLensReviewOutputTypeDef(TypedDict):
WorkloadId: str,
LensReview: LensReviewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListNotificationsOutputTypeDef#
# ListNotificationsOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListNotificationsOutputTypeDef
def get_value() -> ListNotificationsOutputTypeDef:
return {
"NotificationSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListNotificationsOutputTypeDef definition
class ListNotificationsOutputTypeDef(TypedDict):
NotificationSummaries: List[NotificationSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListMilestonesOutputTypeDef#
# ListMilestonesOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListMilestonesOutputTypeDef
def get_value() -> ListMilestonesOutputTypeDef:
return {
"WorkloadId": ...,
"MilestoneSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListMilestonesOutputTypeDef definition
class ListMilestonesOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneSummaries: List[MilestoneSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
VersionDifferencesTypeDef#
# VersionDifferencesTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import VersionDifferencesTypeDef
def get_value() -> VersionDifferencesTypeDef:
return {
"PillarDifferences": ...,
}
# VersionDifferencesTypeDef definition
class VersionDifferencesTypeDef(TypedDict):
PillarDifferences: NotRequired[List[PillarDifferenceTypeDef]], # (1)
AnswerSummaryTypeDef#
# AnswerSummaryTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import AnswerSummaryTypeDef
def get_value() -> AnswerSummaryTypeDef:
return {
"QuestionId": ...,
}
# AnswerSummaryTypeDef definition
class AnswerSummaryTypeDef(TypedDict):
QuestionId: NotRequired[str],
PillarId: NotRequired[str],
QuestionTitle: NotRequired[str],
Choices: NotRequired[List[ChoiceTypeDef]], # (1)
SelectedChoices: NotRequired[List[str]],
ChoiceAnswerSummaries: NotRequired[List[ChoiceAnswerSummaryTypeDef]], # (2)
IsApplicable: NotRequired[bool],
Risk: NotRequired[RiskType], # (3)
Reason: NotRequired[AnswerReasonType], # (4)
- See ChoiceTypeDef
- See ChoiceAnswerSummaryTypeDef
- See RiskType
- See AnswerReasonType
AnswerTypeDef#
# AnswerTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import AnswerTypeDef
def get_value() -> AnswerTypeDef:
return {
"QuestionId": ...,
}
# AnswerTypeDef definition
class AnswerTypeDef(TypedDict):
QuestionId: NotRequired[str],
PillarId: NotRequired[str],
QuestionTitle: NotRequired[str],
QuestionDescription: NotRequired[str],
ImprovementPlanUrl: NotRequired[str],
HelpfulResourceUrl: NotRequired[str],
HelpfulResourceDisplayText: NotRequired[str],
Choices: NotRequired[List[ChoiceTypeDef]], # (1)
SelectedChoices: NotRequired[List[str]],
ChoiceAnswers: NotRequired[List[ChoiceAnswerTypeDef]], # (2)
IsApplicable: NotRequired[bool],
Risk: NotRequired[RiskType], # (3)
Notes: NotRequired[str],
Reason: NotRequired[AnswerReasonType], # (4)
- See ChoiceTypeDef
- See ChoiceAnswerTypeDef
- See RiskType
- See AnswerReasonType
LensMetricTypeDef#
# LensMetricTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import LensMetricTypeDef
def get_value() -> LensMetricTypeDef:
return {
"LensArn": ...,
}
# LensMetricTypeDef definition
class LensMetricTypeDef(TypedDict):
LensArn: NotRequired[str],
Pillars: NotRequired[List[PillarMetricTypeDef]], # (1)
RiskCounts: NotRequired[Dict[RiskType, int]], # (2)
- See PillarMetricTypeDef
- See RiskType
GetMilestoneOutputTypeDef#
# GetMilestoneOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetMilestoneOutputTypeDef
def get_value() -> GetMilestoneOutputTypeDef:
return {
"WorkloadId": ...,
"Milestone": ...,
"ResponseMetadata": ...,
}
# GetMilestoneOutputTypeDef definition
class GetMilestoneOutputTypeDef(TypedDict):
WorkloadId: str,
Milestone: MilestoneTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetLensVersionDifferenceOutputTypeDef#
# GetLensVersionDifferenceOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetLensVersionDifferenceOutputTypeDef
def get_value() -> GetLensVersionDifferenceOutputTypeDef:
return {
"LensAlias": ...,
"LensArn": ...,
"BaseLensVersion": ...,
"TargetLensVersion": ...,
"LatestLensVersion": ...,
"VersionDifferences": ...,
"ResponseMetadata": ...,
}
# GetLensVersionDifferenceOutputTypeDef definition
class GetLensVersionDifferenceOutputTypeDef(TypedDict):
LensAlias: str,
LensArn: str,
BaseLensVersion: str,
TargetLensVersion: str,
LatestLensVersion: str,
VersionDifferences: VersionDifferencesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAnswersOutputTypeDef#
# ListAnswersOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ListAnswersOutputTypeDef
def get_value() -> ListAnswersOutputTypeDef:
return {
"WorkloadId": ...,
"MilestoneNumber": ...,
"LensAlias": ...,
"LensArn": ...,
"AnswerSummaries": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# ListAnswersOutputTypeDef definition
class ListAnswersOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensAlias: str,
LensArn: str,
AnswerSummaries: List[AnswerSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetAnswerOutputTypeDef#
# GetAnswerOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetAnswerOutputTypeDef
def get_value() -> GetAnswerOutputTypeDef:
return {
"WorkloadId": ...,
"MilestoneNumber": ...,
"LensAlias": ...,
"LensArn": ...,
"Answer": ...,
"ResponseMetadata": ...,
}
# GetAnswerOutputTypeDef definition
class GetAnswerOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensAlias: str,
LensArn: str,
Answer: AnswerTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AnswerTypeDef
- See ResponseMetadataTypeDef
UpdateAnswerOutputTypeDef#
# UpdateAnswerOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import UpdateAnswerOutputTypeDef
def get_value() -> UpdateAnswerOutputTypeDef:
return {
"WorkloadId": ...,
"LensAlias": ...,
"LensArn": ...,
"Answer": ...,
"ResponseMetadata": ...,
}
# UpdateAnswerOutputTypeDef definition
class UpdateAnswerOutputTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
LensArn: str,
Answer: AnswerTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AnswerTypeDef
- See ResponseMetadataTypeDef
ConsolidatedReportMetricTypeDef#
# ConsolidatedReportMetricTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import ConsolidatedReportMetricTypeDef
def get_value() -> ConsolidatedReportMetricTypeDef:
return {
"MetricType": ...,
}
# ConsolidatedReportMetricTypeDef definition
class ConsolidatedReportMetricTypeDef(TypedDict):
MetricType: NotRequired[MetricTypeType], # (1)
RiskCounts: NotRequired[Dict[RiskType, int]], # (2)
WorkloadId: NotRequired[str],
WorkloadName: NotRequired[str],
WorkloadArn: NotRequired[str],
UpdatedAt: NotRequired[datetime],
Lenses: NotRequired[List[LensMetricTypeDef]], # (3)
LensesAppliedCount: NotRequired[int],
- See MetricTypeType
- See RiskType
- See LensMetricTypeDef
GetConsolidatedReportOutputTypeDef#
# GetConsolidatedReportOutputTypeDef usage example
from mypy_boto3_wellarchitected.type_defs import GetConsolidatedReportOutputTypeDef
def get_value() -> GetConsolidatedReportOutputTypeDef:
return {
"Metrics": ...,
"NextToken": ...,
"Base64String": ...,
"ResponseMetadata": ...,
}
# GetConsolidatedReportOutputTypeDef definition
class GetConsolidatedReportOutputTypeDef(TypedDict):
Metrics: List[ConsolidatedReportMetricTypeDef], # (1)
NextToken: str,
Base64String: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)