Type definitions#
Index > WellArchitected > Type definitions
Auto-generated documentation for WellArchitected type annotations stubs module mypy-boto3-wellarchitected.
SelectedPillarUnionTypeDef#
# SelectedPillarUnionTypeDef definition
SelectedPillarUnionTypeDef = Union[
SelectedPillarTypeDef, # (1)
SelectedPillarOutputTypeDef, # (2)
]
AccountJiraConfigurationInputTypeDef#
# AccountJiraConfigurationInputTypeDef definition
class AccountJiraConfigurationInputTypeDef(TypedDict):
IssueManagementStatus: NotRequired[AccountJiraIssueManagementStatusType], # (1)
IssueManagementType: NotRequired[IssueManagementTypeType], # (2)
JiraProjectKey: NotRequired[str],
IntegrationStatus: NotRequired[IntegrationStatusInputType], # (3)
AccountJiraConfigurationOutputTypeDef#
# AccountJiraConfigurationOutputTypeDef definition
class AccountJiraConfigurationOutputTypeDef(TypedDict):
IntegrationStatus: NotRequired[IntegrationStatusType], # (1)
IssueManagementStatus: NotRequired[AccountJiraIssueManagementStatusType], # (2)
IssueManagementType: NotRequired[IssueManagementTypeType], # (3)
Subdomain: NotRequired[str],
JiraProjectKey: NotRequired[str],
StatusMessage: NotRequired[str],
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)
- See ChoiceStatusType
- See ChoiceReasonType
JiraConfigurationTypeDef#
# JiraConfigurationTypeDef definition
class JiraConfigurationTypeDef(TypedDict):
JiraIssueUrl: NotRequired[str],
LastSyncedTime: NotRequired[datetime],
ChoiceAnswerTypeDef#
# 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 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],
- See CheckProviderType
- See CheckStatusType
- 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)
- See CheckProviderType
- See CheckStatusType
- 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],
- See ChoiceStatusType
- See ChoiceReasonType
CreateLensShareInputRequestTypeDef#
# CreateLensShareInputRequestTypeDef definition
class CreateLensShareInputRequestTypeDef(TypedDict):
LensAlias: str,
SharedWith: str,
ClientRequestToken: str,
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
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)
WorkloadJiraConfigurationInputTypeDef#
# WorkloadJiraConfigurationInputTypeDef definition
class WorkloadJiraConfigurationInputTypeDef(TypedDict):
IssueManagementStatus: NotRequired[WorkloadIssueManagementStatusType], # (1)
IssueManagementType: NotRequired[IssueManagementTypeType], # (2)
JiraProjectKey: NotRequired[str],
CreateWorkloadShareInputRequestTypeDef#
# CreateWorkloadShareInputRequestTypeDef definition
class CreateWorkloadShareInputRequestTypeDef(TypedDict):
WorkloadId: str,
SharedWith: str,
PermissionType: PermissionTypeType, # (1)
ClientRequestToken: str,
DeleteLensInputRequestTypeDef#
# DeleteLensInputRequestTypeDef definition
class DeleteLensInputRequestTypeDef(TypedDict):
LensAlias: str,
ClientRequestToken: str,
LensStatus: LensStatusTypeType, # (1)
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],
- 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],
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]],
SelectedPillarOutputTypeDef#
# SelectedPillarOutputTypeDef definition
class SelectedPillarOutputTypeDef(TypedDict):
PillarId: NotRequired[str],
SelectedQuestionIds: NotRequired[list[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)
LensShareSummaryTypeDef#
# LensShareSummaryTypeDef definition
class LensShareSummaryTypeDef(TypedDict):
ShareId: NotRequired[str],
SharedWith: NotRequired[str],
Status: NotRequired[ShareStatusType], # (1)
StatusMessage: NotRequired[str],
- 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)
- See LensTypeType
- 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)
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)
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)
- 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],
- See LensTypeType
- 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],
ListProfileSharesInputRequestTypeDef#
# ListProfileSharesInputRequestTypeDef definition
class ListProfileSharesInputRequestTypeDef(TypedDict):
ProfileArn: str,
SharedWithPrefix: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Status: NotRequired[ShareStatusType], # (1)
- See ShareStatusType
ProfileShareSummaryTypeDef#
# ProfileShareSummaryTypeDef definition
class ProfileShareSummaryTypeDef(TypedDict):
ShareId: NotRequired[str],
SharedWith: NotRequired[str],
Status: NotRequired[ShareStatusType], # (1)
StatusMessage: NotRequired[str],
- See ShareStatusType
ListProfilesInputRequestTypeDef#
# ListProfilesInputRequestTypeDef definition
class ListProfilesInputRequestTypeDef(TypedDict):
ProfileNamePrefix: NotRequired[str],
ProfileOwnerType: NotRequired[ProfileOwnerTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ProfileSummaryTypeDef#
# ProfileSummaryTypeDef definition
class ProfileSummaryTypeDef(TypedDict):
ProfileArn: NotRequired[str],
ProfileVersion: NotRequired[str],
ProfileName: NotRequired[str],
ProfileDescription: NotRequired[str],
Owner: NotRequired[str],
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],
ListReviewTemplateAnswersInputRequestTypeDef#
# ListReviewTemplateAnswersInputRequestTypeDef definition
class ListReviewTemplateAnswersInputRequestTypeDef(TypedDict):
TemplateArn: str,
LensAlias: str,
PillarId: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListReviewTemplatesInputRequestTypeDef#
# ListReviewTemplatesInputRequestTypeDef definition
class ListReviewTemplatesInputRequestTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ReviewTemplateSummaryTypeDef#
# ReviewTemplateSummaryTypeDef definition
class ReviewTemplateSummaryTypeDef(TypedDict):
Description: NotRequired[str],
Lenses: NotRequired[list[str]],
Owner: NotRequired[str],
UpdatedAt: NotRequired[datetime],
TemplateArn: NotRequired[str],
TemplateName: NotRequired[str],
UpdateStatus: NotRequired[ReviewTemplateUpdateStatusType], # (1)
ListShareInvitationsInputRequestTypeDef#
# ListShareInvitationsInputRequestTypeDef definition
class ListShareInvitationsInputRequestTypeDef(TypedDict):
WorkloadNamePrefix: NotRequired[str],
LensNamePrefix: NotRequired[str],
ShareResourceType: NotRequired[ShareResourceTypeType], # (1)
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ProfileNamePrefix: NotRequired[str],
TemplateNamePrefix: NotRequired[str],
ShareInvitationSummaryTypeDef#
# 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],
ProfileName: NotRequired[str],
ProfileArn: NotRequired[str],
TemplateName: NotRequired[str],
TemplateArn: NotRequired[str],
ListTagsForResourceInputRequestTypeDef#
# ListTagsForResourceInputRequestTypeDef definition
class ListTagsForResourceInputRequestTypeDef(TypedDict):
WorkloadArn: str,
ListTemplateSharesInputRequestTypeDef#
# ListTemplateSharesInputRequestTypeDef definition
class ListTemplateSharesInputRequestTypeDef(TypedDict):
TemplateArn: str,
SharedWithPrefix: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Status: NotRequired[ShareStatusType], # (1)
- See ShareStatusType
TemplateShareSummaryTypeDef#
# TemplateShareSummaryTypeDef definition
class TemplateShareSummaryTypeDef(TypedDict):
ShareId: NotRequired[str],
SharedWith: NotRequired[str],
Status: NotRequired[ShareStatusType], # (1)
StatusMessage: NotRequired[str],
- See ShareStatusType
ListWorkloadSharesInputRequestTypeDef#
# ListWorkloadSharesInputRequestTypeDef definition
class ListWorkloadSharesInputRequestTypeDef(TypedDict):
WorkloadId: str,
SharedWithPrefix: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Status: NotRequired[ShareStatusType], # (1)
- See ShareStatusType
WorkloadShareSummaryTypeDef#
# 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 definition
class ListWorkloadsInputRequestTypeDef(TypedDict):
WorkloadNamePrefix: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
QuestionDifferenceTypeDef#
# QuestionDifferenceTypeDef definition
class QuestionDifferenceTypeDef(TypedDict):
QuestionId: NotRequired[str],
QuestionTitle: NotRequired[str],
DifferenceStatus: NotRequired[DifferenceStatusType], # (1)
ProfileChoiceTypeDef#
# ProfileChoiceTypeDef definition
class ProfileChoiceTypeDef(TypedDict):
ChoiceId: NotRequired[str],
ChoiceTitle: NotRequired[str],
ChoiceDescription: NotRequired[str],
ProfileTemplateChoiceTypeDef#
# ProfileTemplateChoiceTypeDef definition
class ProfileTemplateChoiceTypeDef(TypedDict):
ChoiceId: NotRequired[str],
ChoiceTitle: NotRequired[str],
ChoiceDescription: NotRequired[str],
ReviewTemplatePillarReviewSummaryTypeDef#
# ReviewTemplatePillarReviewSummaryTypeDef definition
class ReviewTemplatePillarReviewSummaryTypeDef(TypedDict):
PillarId: NotRequired[str],
PillarName: NotRequired[str],
Notes: NotRequired[str],
QuestionCounts: NotRequired[dict[QuestionType, int]], # (1)
- See QuestionType
SelectedPillarTypeDef#
# SelectedPillarTypeDef definition
class SelectedPillarTypeDef(TypedDict):
PillarId: NotRequired[str],
SelectedQuestionIds: NotRequired[Sequence[str]],
ShareInvitationTypeDef#
# ShareInvitationTypeDef definition
class ShareInvitationTypeDef(TypedDict):
ShareInvitationId: NotRequired[str],
ShareResourceType: NotRequired[ShareResourceTypeType], # (1)
WorkloadId: NotRequired[str],
LensAlias: NotRequired[str],
LensArn: NotRequired[str],
ProfileArn: NotRequired[str],
TemplateArn: NotRequired[str],
TagResourceInputRequestTypeDef#
# TagResourceInputRequestTypeDef definition
class TagResourceInputRequestTypeDef(TypedDict):
WorkloadArn: str,
Tags: Mapping[str, str],
UntagResourceInputRequestTypeDef#
# UntagResourceInputRequestTypeDef definition
class UntagResourceInputRequestTypeDef(TypedDict):
WorkloadArn: str,
TagKeys: Sequence[str],
UpdateIntegrationInputRequestTypeDef#
# UpdateIntegrationInputRequestTypeDef definition
class UpdateIntegrationInputRequestTypeDef(TypedDict):
WorkloadId: str,
ClientRequestToken: str,
IntegratingService: IntegratingServiceType, # (1)
UpdateReviewTemplateInputRequestTypeDef#
# UpdateReviewTemplateInputRequestTypeDef definition
class UpdateReviewTemplateInputRequestTypeDef(TypedDict):
TemplateArn: str,
TemplateName: NotRequired[str],
Description: NotRequired[str],
Notes: NotRequired[str],
LensesToAssociate: NotRequired[Sequence[str]],
LensesToDisassociate: NotRequired[Sequence[str]],
UpdateReviewTemplateLensReviewInputRequestTypeDef#
# UpdateReviewTemplateLensReviewInputRequestTypeDef definition
class UpdateReviewTemplateLensReviewInputRequestTypeDef(TypedDict):
TemplateArn: str,
LensAlias: str,
LensNotes: NotRequired[str],
PillarNotes: NotRequired[Mapping[str, str]],
UpdateShareInvitationInputRequestTypeDef#
# UpdateShareInvitationInputRequestTypeDef definition
class UpdateShareInvitationInputRequestTypeDef(TypedDict):
ShareInvitationId: str,
ShareInvitationAction: ShareInvitationActionType, # (1)
UpdateWorkloadShareInputRequestTypeDef#
# UpdateWorkloadShareInputRequestTypeDef definition
class UpdateWorkloadShareInputRequestTypeDef(TypedDict):
ShareId: str,
WorkloadId: str,
PermissionType: PermissionTypeType, # (1)
WorkloadShareTypeDef#
# 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 definition
class UpgradeLensReviewInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
MilestoneName: str,
ClientRequestToken: NotRequired[str],
UpgradeProfileVersionInputRequestTypeDef#
# UpgradeProfileVersionInputRequestTypeDef definition
class UpgradeProfileVersionInputRequestTypeDef(TypedDict):
WorkloadId: str,
ProfileArn: str,
MilestoneName: NotRequired[str],
ClientRequestToken: NotRequired[str],
UpgradeReviewTemplateLensReviewInputRequestTypeDef#
# UpgradeReviewTemplateLensReviewInputRequestTypeDef definition
class UpgradeReviewTemplateLensReviewInputRequestTypeDef(TypedDict):
TemplateArn: str,
LensAlias: str,
ClientRequestToken: NotRequired[str],
WorkloadDiscoveryConfigOutputTypeDef#
# WorkloadDiscoveryConfigOutputTypeDef definition
class WorkloadDiscoveryConfigOutputTypeDef(TypedDict):
TrustedAdvisorIntegrationStatus: NotRequired[TrustedAdvisorIntegrationStatusType], # (1)
WorkloadResourceDefinition: NotRequired[list[DefinitionTypeType]], # (2)
WorkloadJiraConfigurationOutputTypeDef#
# WorkloadJiraConfigurationOutputTypeDef definition
class WorkloadJiraConfigurationOutputTypeDef(TypedDict):
IssueManagementStatus: NotRequired[WorkloadIssueManagementStatusType], # (1)
IssueManagementType: NotRequired[IssueManagementTypeType], # (2)
JiraProjectKey: NotRequired[str],
StatusMessage: NotRequired[str],
UpdateGlobalSettingsInputRequestTypeDef#
# UpdateGlobalSettingsInputRequestTypeDef definition
class UpdateGlobalSettingsInputRequestTypeDef(TypedDict):
OrganizationSharingStatus: NotRequired[OrganizationSharingStatusType], # (1)
DiscoveryIntegrationStatus: NotRequired[DiscoveryIntegrationStatusType], # (2)
JiraConfiguration: NotRequired[AccountJiraConfigurationInputTypeDef], # (3)
- See OrganizationSharingStatusType
- See DiscoveryIntegrationStatusType
- See AccountJiraConfigurationInputTypeDef
AdditionalResourcesTypeDef#
# AdditionalResourcesTypeDef definition
class AdditionalResourcesTypeDef(TypedDict):
Type: NotRequired[AdditionalResourceTypeType], # (1)
Content: NotRequired[list[ChoiceContentTypeDef]], # (2)
QuestionMetricTypeDef#
# QuestionMetricTypeDef definition
class QuestionMetricTypeDef(TypedDict):
QuestionId: NotRequired[str],
Risk: NotRequired[RiskType], # (1)
BestPractices: NotRequired[list[BestPracticeTypeDef]], # (2)
- See RiskType
- See BestPracticeTypeDef
ImprovementSummaryTypeDef#
# 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)
JiraConfiguration: NotRequired[JiraConfigurationTypeDef], # (3)
UpdateAnswerInputRequestTypeDef#
# 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
UpdateReviewTemplateAnswerInputRequestTypeDef#
# UpdateReviewTemplateAnswerInputRequestTypeDef definition
class UpdateReviewTemplateAnswerInputRequestTypeDef(TypedDict):
TemplateArn: 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
CreateLensShareOutputTypeDef#
# CreateLensShareOutputTypeDef definition
class CreateLensShareOutputTypeDef(TypedDict):
ShareId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateLensVersionOutputTypeDef#
# CreateLensVersionOutputTypeDef definition
class CreateLensVersionOutputTypeDef(TypedDict):
LensArn: str,
LensVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateMilestoneOutputTypeDef#
# CreateMilestoneOutputTypeDef definition
class CreateMilestoneOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProfileOutputTypeDef#
# CreateProfileOutputTypeDef definition
class CreateProfileOutputTypeDef(TypedDict):
ProfileArn: str,
ProfileVersion: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProfileShareOutputTypeDef#
# CreateProfileShareOutputTypeDef definition
class CreateProfileShareOutputTypeDef(TypedDict):
ShareId: str,
ProfileArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateReviewTemplateOutputTypeDef#
# CreateReviewTemplateOutputTypeDef definition
class CreateReviewTemplateOutputTypeDef(TypedDict):
TemplateArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateTemplateShareOutputTypeDef#
# CreateTemplateShareOutputTypeDef definition
class CreateTemplateShareOutputTypeDef(TypedDict):
TemplateArn: str,
ShareId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWorkloadOutputTypeDef#
# CreateWorkloadOutputTypeDef definition
class CreateWorkloadOutputTypeDef(TypedDict):
WorkloadId: str,
WorkloadArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateWorkloadShareOutputTypeDef#
# CreateWorkloadShareOutputTypeDef definition
class CreateWorkloadShareOutputTypeDef(TypedDict):
WorkloadId: str,
ShareId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ExportLensOutputTypeDef#
# ExportLensOutputTypeDef definition
class ExportLensOutputTypeDef(TypedDict):
LensJSON: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetGlobalSettingsOutputTypeDef#
# GetGlobalSettingsOutputTypeDef definition
class GetGlobalSettingsOutputTypeDef(TypedDict):
OrganizationSharingStatus: OrganizationSharingStatusType, # (1)
DiscoveryIntegrationStatus: DiscoveryIntegrationStatusType, # (2)
JiraConfiguration: AccountJiraConfigurationOutputTypeDef, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See OrganizationSharingStatusType
- See DiscoveryIntegrationStatusType
- See AccountJiraConfigurationOutputTypeDef
- See ResponseMetadataTypeDef
ImportLensOutputTypeDef#
# ImportLensOutputTypeDef definition
class ImportLensOutputTypeDef(TypedDict):
LensArn: str,
Status: ImportLensStatusType, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListCheckDetailsOutputTypeDef#
# ListCheckDetailsOutputTypeDef definition
class ListCheckDetailsOutputTypeDef(TypedDict):
CheckDetails: list[CheckDetailTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListCheckSummariesOutputTypeDef#
# ListCheckSummariesOutputTypeDef definition
class ListCheckSummariesOutputTypeDef(TypedDict):
CheckSummaries: list[CheckSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListTagsForResourceOutputTypeDef#
# ListTagsForResourceOutputTypeDef definition
class ListTagsForResourceOutputTypeDef(TypedDict):
Tags: dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateProfileInputRequestTypeDef#
# CreateProfileInputRequestTypeDef definition
class CreateProfileInputRequestTypeDef(TypedDict):
ProfileName: str,
ProfileDescription: str,
ProfileQuestions: Sequence[ProfileQuestionUpdateTypeDef], # (1)
ClientRequestToken: str,
Tags: NotRequired[Mapping[str, str]],
UpdateProfileInputRequestTypeDef#
# UpdateProfileInputRequestTypeDef definition
class UpdateProfileInputRequestTypeDef(TypedDict):
ProfileArn: str,
ProfileDescription: NotRequired[str],
ProfileQuestions: NotRequired[Sequence[ProfileQuestionUpdateTypeDef]], # (1)
CreateWorkloadInputRequestTypeDef#
# 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]],
ProfileArns: NotRequired[Sequence[str]],
ReviewTemplateArns: NotRequired[Sequence[str]],
JiraConfiguration: NotRequired[WorkloadJiraConfigurationInputTypeDef], # (3)
- See WorkloadEnvironmentType
- See WorkloadDiscoveryConfigTypeDef
- See WorkloadJiraConfigurationInputTypeDef
UpdateWorkloadInputRequestTypeDef#
# 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]],
JiraConfiguration: NotRequired[WorkloadJiraConfigurationInputTypeDef], # (4)
- See WorkloadEnvironmentType
- See WorkloadImprovementStatusType
- See WorkloadDiscoveryConfigTypeDef
- See WorkloadJiraConfigurationInputTypeDef
GetLensOutputTypeDef#
# GetLensOutputTypeDef definition
class GetLensOutputTypeDef(TypedDict):
Lens: LensTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See LensTypeDef
- See ResponseMetadataTypeDef
GetLensReviewReportOutputTypeDef#
# GetLensReviewReportOutputTypeDef definition
class GetLensReviewReportOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensReviewReport: LensReviewReportTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetReviewTemplateOutputTypeDef#
# GetReviewTemplateOutputTypeDef definition
class GetReviewTemplateOutputTypeDef(TypedDict):
ReviewTemplate: ReviewTemplateTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateReviewTemplateOutputTypeDef#
# UpdateReviewTemplateOutputTypeDef definition
class UpdateReviewTemplateOutputTypeDef(TypedDict):
ReviewTemplate: ReviewTemplateTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
JiraSelectedQuestionConfigurationOutputTypeDef#
# JiraSelectedQuestionConfigurationOutputTypeDef definition
class JiraSelectedQuestionConfigurationOutputTypeDef(TypedDict):
SelectedPillars: NotRequired[list[SelectedPillarOutputTypeDef]], # (1)
LensReviewSummaryTypeDef#
# 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)
Profiles: NotRequired[list[WorkloadProfileTypeDef]], # (3)
PrioritizedRiskCounts: NotRequired[dict[RiskType, int]], # (2)
- See LensStatusType
- See RiskType
- See WorkloadProfileTypeDef
- See RiskType
WorkloadSummaryTypeDef#
# 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)
Profiles: NotRequired[list[WorkloadProfileTypeDef]], # (3)
PrioritizedRiskCounts: NotRequired[dict[RiskType, int]], # (1)
- See RiskType
- See WorkloadImprovementStatusType
- See WorkloadProfileTypeDef
- See RiskType
ListLensSharesOutputTypeDef#
# ListLensSharesOutputTypeDef definition
class ListLensSharesOutputTypeDef(TypedDict):
LensShareSummaries: list[LensShareSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListLensesOutputTypeDef#
# ListLensesOutputTypeDef definition
class ListLensesOutputTypeDef(TypedDict):
LensSummaries: list[LensSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
NotificationSummaryTypeDef#
# NotificationSummaryTypeDef definition
class NotificationSummaryTypeDef(TypedDict):
Type: NotRequired[NotificationTypeType], # (1)
LensUpgradeSummary: NotRequired[LensUpgradeSummaryTypeDef], # (2)
ListProfileNotificationsOutputTypeDef#
# ListProfileNotificationsOutputTypeDef definition
class ListProfileNotificationsOutputTypeDef(TypedDict):
NotificationSummaries: list[ProfileNotificationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListProfileSharesOutputTypeDef#
# ListProfileSharesOutputTypeDef definition
class ListProfileSharesOutputTypeDef(TypedDict):
ProfileShareSummaries: list[ProfileShareSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListProfilesOutputTypeDef#
# ListProfilesOutputTypeDef definition
class ListProfilesOutputTypeDef(TypedDict):
ProfileSummaries: list[ProfileSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListReviewTemplatesOutputTypeDef#
# ListReviewTemplatesOutputTypeDef definition
class ListReviewTemplatesOutputTypeDef(TypedDict):
ReviewTemplates: list[ReviewTemplateSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListShareInvitationsOutputTypeDef#
# ListShareInvitationsOutputTypeDef definition
class ListShareInvitationsOutputTypeDef(TypedDict):
ShareInvitationSummaries: list[ShareInvitationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListTemplateSharesOutputTypeDef#
# ListTemplateSharesOutputTypeDef definition
class ListTemplateSharesOutputTypeDef(TypedDict):
TemplateArn: str,
TemplateShareSummaries: list[TemplateShareSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListWorkloadSharesOutputTypeDef#
# ListWorkloadSharesOutputTypeDef definition
class ListWorkloadSharesOutputTypeDef(TypedDict):
WorkloadId: str,
WorkloadShareSummaries: list[WorkloadShareSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
PillarDifferenceTypeDef#
# PillarDifferenceTypeDef definition
class PillarDifferenceTypeDef(TypedDict):
PillarId: NotRequired[str],
PillarName: NotRequired[str],
DifferenceStatus: NotRequired[DifferenceStatusType], # (1)
QuestionDifferences: NotRequired[list[QuestionDifferenceTypeDef]], # (2)
ProfileQuestionTypeDef#
# ProfileQuestionTypeDef definition
class ProfileQuestionTypeDef(TypedDict):
QuestionId: NotRequired[str],
QuestionTitle: NotRequired[str],
QuestionDescription: NotRequired[str],
QuestionChoices: NotRequired[list[ProfileChoiceTypeDef]], # (1)
SelectedChoiceIds: NotRequired[list[str]],
MinSelectedChoices: NotRequired[int],
MaxSelectedChoices: NotRequired[int],
ProfileTemplateQuestionTypeDef#
# ProfileTemplateQuestionTypeDef definition
class ProfileTemplateQuestionTypeDef(TypedDict):
QuestionId: NotRequired[str],
QuestionTitle: NotRequired[str],
QuestionDescription: NotRequired[str],
QuestionChoices: NotRequired[list[ProfileTemplateChoiceTypeDef]], # (1)
MinSelectedChoices: NotRequired[int],
MaxSelectedChoices: NotRequired[int],
ReviewTemplateLensReviewTypeDef#
# ReviewTemplateLensReviewTypeDef definition
class ReviewTemplateLensReviewTypeDef(TypedDict):
LensAlias: NotRequired[str],
LensArn: NotRequired[str],
LensVersion: NotRequired[str],
LensName: NotRequired[str],
LensStatus: NotRequired[LensStatusType], # (1)
PillarReviewSummaries: NotRequired[list[ReviewTemplatePillarReviewSummaryTypeDef]], # (2)
UpdatedAt: NotRequired[datetime],
Notes: NotRequired[str],
QuestionCounts: NotRequired[dict[QuestionType, int]], # (3)
NextToken: NotRequired[str],
UpdateShareInvitationOutputTypeDef#
# UpdateShareInvitationOutputTypeDef definition
class UpdateShareInvitationOutputTypeDef(TypedDict):
ShareInvitation: ShareInvitationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateWorkloadShareOutputTypeDef#
# UpdateWorkloadShareOutputTypeDef definition
class UpdateWorkloadShareOutputTypeDef(TypedDict):
WorkloadId: str,
WorkloadShare: WorkloadShareTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
WorkloadTypeDef#
# 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[WorkloadDiscoveryConfigOutputTypeDef], # (4)
Applications: NotRequired[list[str]],
Profiles: NotRequired[list[WorkloadProfileTypeDef]], # (5)
PrioritizedRiskCounts: NotRequired[dict[RiskType, int]], # (3)
JiraConfiguration: NotRequired[WorkloadJiraConfigurationOutputTypeDef], # (7)
- See WorkloadEnvironmentType
- See WorkloadImprovementStatusType
- See RiskType
- See WorkloadDiscoveryConfigOutputTypeDef
- See WorkloadProfileTypeDef
- See RiskType
- See WorkloadJiraConfigurationOutputTypeDef
ChoiceTypeDef#
# 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 definition
class PillarMetricTypeDef(TypedDict):
PillarId: NotRequired[str],
RiskCounts: NotRequired[dict[RiskType, int]], # (1)
Questions: NotRequired[list[QuestionMetricTypeDef]], # (2)
- See RiskType
- See QuestionMetricTypeDef
ListLensReviewImprovementsOutputTypeDef#
# ListLensReviewImprovementsOutputTypeDef definition
class ListLensReviewImprovementsOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensAlias: str,
LensArn: str,
ImprovementSummaries: list[ImprovementSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
LensReviewTypeDef#
# 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)
JiraConfiguration: NotRequired[JiraSelectedQuestionConfigurationOutputTypeDef], # (3)
UpdatedAt: NotRequired[datetime],
Notes: NotRequired[str],
RiskCounts: NotRequired[dict[RiskType, int]], # (4)
NextToken: NotRequired[str],
Profiles: NotRequired[list[WorkloadProfileTypeDef]], # (5)
PrioritizedRiskCounts: NotRequired[dict[RiskType, int]], # (4)
- See LensStatusType
- See PillarReviewSummaryTypeDef
- See JiraSelectedQuestionConfigurationOutputTypeDef
- See RiskType
- See WorkloadProfileTypeDef
- See RiskType
ListLensReviewsOutputTypeDef#
# ListLensReviewsOutputTypeDef definition
class ListLensReviewsOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensReviewSummaries: list[LensReviewSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListWorkloadsOutputTypeDef#
# ListWorkloadsOutputTypeDef definition
class ListWorkloadsOutputTypeDef(TypedDict):
WorkloadSummaries: list[WorkloadSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
MilestoneSummaryTypeDef#
# MilestoneSummaryTypeDef definition
class MilestoneSummaryTypeDef(TypedDict):
MilestoneNumber: NotRequired[int],
MilestoneName: NotRequired[str],
RecordedAt: NotRequired[datetime],
WorkloadSummary: NotRequired[WorkloadSummaryTypeDef], # (1)
ListNotificationsOutputTypeDef#
# ListNotificationsOutputTypeDef definition
class ListNotificationsOutputTypeDef(TypedDict):
NotificationSummaries: list[NotificationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
VersionDifferencesTypeDef#
# VersionDifferencesTypeDef definition
class VersionDifferencesTypeDef(TypedDict):
PillarDifferences: NotRequired[list[PillarDifferenceTypeDef]], # (1)
ProfileTypeDef#
# ProfileTypeDef definition
class ProfileTypeDef(TypedDict):
ProfileArn: NotRequired[str],
ProfileVersion: NotRequired[str],
ProfileName: NotRequired[str],
ProfileDescription: NotRequired[str],
ProfileQuestions: NotRequired[list[ProfileQuestionTypeDef]], # (1)
Owner: NotRequired[str],
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],
ShareInvitationId: NotRequired[str],
Tags: NotRequired[dict[str, str]],
ProfileTemplateTypeDef#
# ProfileTemplateTypeDef definition
class ProfileTemplateTypeDef(TypedDict):
TemplateName: NotRequired[str],
TemplateQuestions: NotRequired[list[ProfileTemplateQuestionTypeDef]], # (1)
CreatedAt: NotRequired[datetime],
UpdatedAt: NotRequired[datetime],
GetReviewTemplateLensReviewOutputTypeDef#
# GetReviewTemplateLensReviewOutputTypeDef definition
class GetReviewTemplateLensReviewOutputTypeDef(TypedDict):
TemplateArn: str,
LensReview: ReviewTemplateLensReviewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateReviewTemplateLensReviewOutputTypeDef#
# UpdateReviewTemplateLensReviewOutputTypeDef definition
class UpdateReviewTemplateLensReviewOutputTypeDef(TypedDict):
TemplateArn: str,
LensReview: ReviewTemplateLensReviewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
JiraSelectedQuestionConfigurationTypeDef#
# JiraSelectedQuestionConfigurationTypeDef definition
class JiraSelectedQuestionConfigurationTypeDef(TypedDict):
SelectedPillars: NotRequired[Sequence[SelectedPillarUnionTypeDef]], # (1)
GetWorkloadOutputTypeDef#
# GetWorkloadOutputTypeDef definition
class GetWorkloadOutputTypeDef(TypedDict):
Workload: WorkloadTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
MilestoneTypeDef#
# MilestoneTypeDef definition
class MilestoneTypeDef(TypedDict):
MilestoneNumber: NotRequired[int],
MilestoneName: NotRequired[str],
RecordedAt: NotRequired[datetime],
Workload: NotRequired[WorkloadTypeDef], # (1)
- See WorkloadTypeDef
UpdateWorkloadOutputTypeDef#
# UpdateWorkloadOutputTypeDef definition
class UpdateWorkloadOutputTypeDef(TypedDict):
Workload: WorkloadTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
AnswerSummaryTypeDef#
# 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)
QuestionType: NotRequired[QuestionTypeType], # (5)
JiraConfiguration: NotRequired[JiraConfigurationTypeDef], # (6)
- See ChoiceTypeDef
- See ChoiceAnswerSummaryTypeDef
- See RiskType
- See AnswerReasonType
- See QuestionTypeType
- See JiraConfigurationTypeDef
AnswerTypeDef#
# 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)
JiraConfiguration: NotRequired[JiraConfigurationTypeDef], # (5)
- See ChoiceTypeDef
- See ChoiceAnswerTypeDef
- See RiskType
- See AnswerReasonType
- See JiraConfigurationTypeDef
ReviewTemplateAnswerSummaryTypeDef#
# ReviewTemplateAnswerSummaryTypeDef definition
class ReviewTemplateAnswerSummaryTypeDef(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],
AnswerStatus: NotRequired[ReviewTemplateAnswerStatusType], # (3)
Reason: NotRequired[AnswerReasonType], # (4)
QuestionType: NotRequired[QuestionTypeType], # (5)
- See ChoiceTypeDef
- See ChoiceAnswerSummaryTypeDef
- See ReviewTemplateAnswerStatusType
- See AnswerReasonType
- See QuestionTypeType
ReviewTemplateAnswerTypeDef#
# ReviewTemplateAnswerTypeDef definition
class ReviewTemplateAnswerTypeDef(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],
AnswerStatus: NotRequired[ReviewTemplateAnswerStatusType], # (3)
Notes: NotRequired[str],
Reason: NotRequired[AnswerReasonType], # (4)
LensMetricTypeDef#
# LensMetricTypeDef definition
class LensMetricTypeDef(TypedDict):
LensArn: NotRequired[str],
Pillars: NotRequired[list[PillarMetricTypeDef]], # (1)
RiskCounts: NotRequired[dict[RiskType, int]], # (2)
- See PillarMetricTypeDef
- See RiskType
GetLensReviewOutputTypeDef#
# GetLensReviewOutputTypeDef definition
class GetLensReviewOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensReview: LensReviewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateLensReviewOutputTypeDef#
# UpdateLensReviewOutputTypeDef definition
class UpdateLensReviewOutputTypeDef(TypedDict):
WorkloadId: str,
LensReview: LensReviewTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListMilestonesOutputTypeDef#
# ListMilestonesOutputTypeDef definition
class ListMilestonesOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneSummaries: list[MilestoneSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
GetLensVersionDifferenceOutputTypeDef#
# GetLensVersionDifferenceOutputTypeDef definition
class GetLensVersionDifferenceOutputTypeDef(TypedDict):
LensAlias: str,
LensArn: str,
BaseLensVersion: str,
TargetLensVersion: str,
LatestLensVersion: str,
VersionDifferences: VersionDifferencesTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetProfileOutputTypeDef#
# GetProfileOutputTypeDef definition
class GetProfileOutputTypeDef(TypedDict):
Profile: ProfileTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateProfileOutputTypeDef#
# UpdateProfileOutputTypeDef definition
class UpdateProfileOutputTypeDef(TypedDict):
Profile: ProfileTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetProfileTemplateOutputTypeDef#
# GetProfileTemplateOutputTypeDef definition
class GetProfileTemplateOutputTypeDef(TypedDict):
ProfileTemplate: ProfileTemplateTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateLensReviewInputRequestTypeDef#
# UpdateLensReviewInputRequestTypeDef definition
class UpdateLensReviewInputRequestTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
LensNotes: NotRequired[str],
PillarNotes: NotRequired[Mapping[str, str]],
JiraConfiguration: NotRequired[JiraSelectedQuestionConfigurationTypeDef], # (1)
GetMilestoneOutputTypeDef#
# GetMilestoneOutputTypeDef definition
class GetMilestoneOutputTypeDef(TypedDict):
WorkloadId: str,
Milestone: MilestoneTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAnswersOutputTypeDef#
# ListAnswersOutputTypeDef definition
class ListAnswersOutputTypeDef(TypedDict):
WorkloadId: str,
MilestoneNumber: int,
LensAlias: str,
LensArn: str,
AnswerSummaries: list[AnswerSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
GetAnswerOutputTypeDef#
# 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 definition
class UpdateAnswerOutputTypeDef(TypedDict):
WorkloadId: str,
LensAlias: str,
LensArn: str,
Answer: AnswerTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See AnswerTypeDef
- See ResponseMetadataTypeDef
ListReviewTemplateAnswersOutputTypeDef#
# ListReviewTemplateAnswersOutputTypeDef definition
class ListReviewTemplateAnswersOutputTypeDef(TypedDict):
TemplateArn: str,
LensAlias: str,
AnswerSummaries: list[ReviewTemplateAnswerSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
GetReviewTemplateAnswerOutputTypeDef#
# GetReviewTemplateAnswerOutputTypeDef definition
class GetReviewTemplateAnswerOutputTypeDef(TypedDict):
TemplateArn: str,
LensAlias: str,
Answer: ReviewTemplateAnswerTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateReviewTemplateAnswerOutputTypeDef#
# UpdateReviewTemplateAnswerOutputTypeDef definition
class UpdateReviewTemplateAnswerOutputTypeDef(TypedDict):
TemplateArn: str,
LensAlias: str,
Answer: ReviewTemplateAnswerTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ConsolidatedReportMetricTypeDef#
# 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 definition
class GetConsolidatedReportOutputTypeDef(TypedDict):
Metrics: list[ConsolidatedReportMetricTypeDef], # (1)
Base64String: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],