Skip to content

Type definitions#

Index > ControlTower > Type definitions

Auto-generated documentation for ControlTower type annotations stubs module mypy-boto3-controltower.

BaselineOperationTypeDef#

# BaselineOperationTypeDef definition

class BaselineOperationTypeDef(TypedDict):
    endTime: NotRequired[datetime],
    operationIdentifier: NotRequired[str],
    operationType: NotRequired[BaselineOperationTypeType],  # (1)
    startTime: NotRequired[datetime],
    status: NotRequired[BaselineOperationStatusType],  # (2)
    statusMessage: NotRequired[str],
  1. See BaselineOperationTypeType
  2. See BaselineOperationStatusType

BaselineSummaryTypeDef#

# BaselineSummaryTypeDef definition

class BaselineSummaryTypeDef(TypedDict):
    arn: str,
    name: str,
    description: NotRequired[str],

ControlOperationTypeDef#

# ControlOperationTypeDef definition

class ControlOperationTypeDef(TypedDict):
    endTime: NotRequired[datetime],
    operationType: NotRequired[ControlOperationTypeType],  # (1)
    startTime: NotRequired[datetime],
    status: NotRequired[ControlOperationStatusType],  # (2)
    statusMessage: NotRequired[str],
  1. See ControlOperationTypeType
  2. See ControlOperationStatusType

CreateLandingZoneInputRequestTypeDef#

# CreateLandingZoneInputRequestTypeDef definition

class CreateLandingZoneInputRequestTypeDef(TypedDict):
    manifest: Mapping[str, Any],
    version: str,
    tags: NotRequired[Mapping[str, str]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DeleteLandingZoneInputRequestTypeDef#

# DeleteLandingZoneInputRequestTypeDef definition

class DeleteLandingZoneInputRequestTypeDef(TypedDict):
    landingZoneIdentifier: str,

DisableBaselineInputRequestTypeDef#

# DisableBaselineInputRequestTypeDef definition

class DisableBaselineInputRequestTypeDef(TypedDict):
    enabledBaselineIdentifier: str,

DisableControlInputRequestTypeDef#

# DisableControlInputRequestTypeDef definition

class DisableControlInputRequestTypeDef(TypedDict):
    controlIdentifier: str,
    targetIdentifier: str,

DriftStatusSummaryTypeDef#

# DriftStatusSummaryTypeDef definition

class DriftStatusSummaryTypeDef(TypedDict):
    driftStatus: NotRequired[DriftStatusType],  # (1)
  1. See DriftStatusType

EnabledBaselineParameterTypeDef#

# EnabledBaselineParameterTypeDef definition

class EnabledBaselineParameterTypeDef(TypedDict):
    key: str,
    value: Mapping[str, Any],

EnabledControlParameterTypeDef#

# EnabledControlParameterTypeDef definition

class EnabledControlParameterTypeDef(TypedDict):
    key: str,
    value: Mapping[str, Any],

EnabledBaselineParameterSummaryTypeDef#

# EnabledBaselineParameterSummaryTypeDef definition

class EnabledBaselineParameterSummaryTypeDef(TypedDict):
    key: str,
    value: Dict[str, Any],

EnablementStatusSummaryTypeDef#

# EnablementStatusSummaryTypeDef definition

class EnablementStatusSummaryTypeDef(TypedDict):
    lastOperationIdentifier: NotRequired[str],
    status: NotRequired[EnablementStatusType],  # (1)
  1. See EnablementStatusType

EnabledBaselineFilterTypeDef#

# EnabledBaselineFilterTypeDef definition

class EnabledBaselineFilterTypeDef(TypedDict):
    baselineIdentifiers: NotRequired[Sequence[str]],
    targetIdentifiers: NotRequired[Sequence[str]],

EnabledControlParameterSummaryTypeDef#

# EnabledControlParameterSummaryTypeDef definition

class EnabledControlParameterSummaryTypeDef(TypedDict):
    key: str,
    value: Dict[str, Any],

RegionTypeDef#

# RegionTypeDef definition

class RegionTypeDef(TypedDict):
    name: NotRequired[str],

GetBaselineInputRequestTypeDef#

# GetBaselineInputRequestTypeDef definition

class GetBaselineInputRequestTypeDef(TypedDict):
    baselineIdentifier: str,

GetBaselineOperationInputRequestTypeDef#

# GetBaselineOperationInputRequestTypeDef definition

class GetBaselineOperationInputRequestTypeDef(TypedDict):
    operationIdentifier: str,

GetControlOperationInputRequestTypeDef#

# GetControlOperationInputRequestTypeDef definition

class GetControlOperationInputRequestTypeDef(TypedDict):
    operationIdentifier: str,

GetEnabledBaselineInputRequestTypeDef#

# GetEnabledBaselineInputRequestTypeDef definition

class GetEnabledBaselineInputRequestTypeDef(TypedDict):
    enabledBaselineIdentifier: str,

GetEnabledControlInputRequestTypeDef#

# GetEnabledControlInputRequestTypeDef definition

class GetEnabledControlInputRequestTypeDef(TypedDict):
    enabledControlIdentifier: str,

GetLandingZoneInputRequestTypeDef#

# GetLandingZoneInputRequestTypeDef definition

class GetLandingZoneInputRequestTypeDef(TypedDict):
    landingZoneIdentifier: str,

GetLandingZoneOperationInputRequestTypeDef#

# GetLandingZoneOperationInputRequestTypeDef definition

class GetLandingZoneOperationInputRequestTypeDef(TypedDict):
    operationIdentifier: str,

LandingZoneOperationDetailTypeDef#

# LandingZoneOperationDetailTypeDef definition

class LandingZoneOperationDetailTypeDef(TypedDict):
    endTime: NotRequired[datetime],
    operationType: NotRequired[LandingZoneOperationTypeType],  # (1)
    startTime: NotRequired[datetime],
    status: NotRequired[LandingZoneOperationStatusType],  # (2)
    statusMessage: NotRequired[str],
  1. See LandingZoneOperationTypeType
  2. See LandingZoneOperationStatusType

LandingZoneDriftStatusSummaryTypeDef#

# LandingZoneDriftStatusSummaryTypeDef definition

class LandingZoneDriftStatusSummaryTypeDef(TypedDict):
    status: NotRequired[LandingZoneDriftStatusType],  # (1)
  1. See LandingZoneDriftStatusType

LandingZoneSummaryTypeDef#

# LandingZoneSummaryTypeDef definition

class LandingZoneSummaryTypeDef(TypedDict):
    arn: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListBaselinesInputRequestTypeDef#

# ListBaselinesInputRequestTypeDef definition

class ListBaselinesInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListEnabledControlsInputRequestTypeDef#

# ListEnabledControlsInputRequestTypeDef definition

class ListEnabledControlsInputRequestTypeDef(TypedDict):
    targetIdentifier: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListLandingZonesInputRequestTypeDef#

# ListLandingZonesInputRequestTypeDef definition

class ListLandingZonesInputRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,

ResetEnabledBaselineInputRequestTypeDef#

# ResetEnabledBaselineInputRequestTypeDef definition

class ResetEnabledBaselineInputRequestTypeDef(TypedDict):
    enabledBaselineIdentifier: str,

ResetLandingZoneInputRequestTypeDef#

# ResetLandingZoneInputRequestTypeDef definition

class ResetLandingZoneInputRequestTypeDef(TypedDict):
    landingZoneIdentifier: str,

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateLandingZoneInputRequestTypeDef#

# UpdateLandingZoneInputRequestTypeDef definition

class UpdateLandingZoneInputRequestTypeDef(TypedDict):
    landingZoneIdentifier: str,
    manifest: Mapping[str, Any],
    version: str,

CreateLandingZoneOutputTypeDef#

# CreateLandingZoneOutputTypeDef definition

class CreateLandingZoneOutputTypeDef(TypedDict):
    arn: str,
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteLandingZoneOutputTypeDef#

# DeleteLandingZoneOutputTypeDef definition

class DeleteLandingZoneOutputTypeDef(TypedDict):
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisableBaselineOutputTypeDef#

# DisableBaselineOutputTypeDef definition

class DisableBaselineOutputTypeDef(TypedDict):
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisableControlOutputTypeDef#

# DisableControlOutputTypeDef definition

class DisableControlOutputTypeDef(TypedDict):
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EnableBaselineOutputTypeDef#

# EnableBaselineOutputTypeDef definition

class EnableBaselineOutputTypeDef(TypedDict):
    arn: str,
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EnableControlOutputTypeDef#

# EnableControlOutputTypeDef definition

class EnableControlOutputTypeDef(TypedDict):
    arn: str,
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetBaselineOperationOutputTypeDef#

# GetBaselineOperationOutputTypeDef definition

class GetBaselineOperationOutputTypeDef(TypedDict):
    baselineOperation: BaselineOperationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BaselineOperationTypeDef
  2. See ResponseMetadataTypeDef

GetBaselineOutputTypeDef#

# GetBaselineOutputTypeDef definition

class GetBaselineOutputTypeDef(TypedDict):
    arn: str,
    description: str,
    name: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetControlOperationOutputTypeDef#

# GetControlOperationOutputTypeDef definition

class GetControlOperationOutputTypeDef(TypedDict):
    controlOperation: ControlOperationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ControlOperationTypeDef
  2. See ResponseMetadataTypeDef

ListBaselinesOutputTypeDef#

# ListBaselinesOutputTypeDef definition

class ListBaselinesOutputTypeDef(TypedDict):
    baselines: List[BaselineSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BaselineSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ResetEnabledBaselineOutputTypeDef#

# ResetEnabledBaselineOutputTypeDef definition

class ResetEnabledBaselineOutputTypeDef(TypedDict):
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ResetLandingZoneOutputTypeDef#

# ResetLandingZoneOutputTypeDef definition

class ResetLandingZoneOutputTypeDef(TypedDict):
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateEnabledBaselineOutputTypeDef#

# UpdateEnabledBaselineOutputTypeDef definition

class UpdateEnabledBaselineOutputTypeDef(TypedDict):
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateEnabledControlOutputTypeDef#

# UpdateEnabledControlOutputTypeDef definition

class UpdateEnabledControlOutputTypeDef(TypedDict):
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateLandingZoneOutputTypeDef#

# UpdateLandingZoneOutputTypeDef definition

class UpdateLandingZoneOutputTypeDef(TypedDict):
    operationIdentifier: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EnableBaselineInputRequestTypeDef#

# EnableBaselineInputRequestTypeDef definition

class EnableBaselineInputRequestTypeDef(TypedDict):
    baselineIdentifier: str,
    baselineVersion: str,
    targetIdentifier: str,
    parameters: NotRequired[Sequence[EnabledBaselineParameterTypeDef]],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See EnabledBaselineParameterTypeDef

UpdateEnabledBaselineInputRequestTypeDef#

# UpdateEnabledBaselineInputRequestTypeDef definition

class UpdateEnabledBaselineInputRequestTypeDef(TypedDict):
    baselineVersion: str,
    enabledBaselineIdentifier: str,
    parameters: NotRequired[Sequence[EnabledBaselineParameterTypeDef]],  # (1)
  1. See EnabledBaselineParameterTypeDef

EnableControlInputRequestTypeDef#

# EnableControlInputRequestTypeDef definition

class EnableControlInputRequestTypeDef(TypedDict):
    controlIdentifier: str,
    targetIdentifier: str,
    parameters: NotRequired[Sequence[EnabledControlParameterTypeDef]],  # (1)
    tags: NotRequired[Mapping[str, str]],
  1. See EnabledControlParameterTypeDef

UpdateEnabledControlInputRequestTypeDef#

# UpdateEnabledControlInputRequestTypeDef definition

class UpdateEnabledControlInputRequestTypeDef(TypedDict):
    enabledControlIdentifier: str,
    parameters: Sequence[EnabledControlParameterTypeDef],  # (1)
  1. See EnabledControlParameterTypeDef

EnabledBaselineDetailsTypeDef#

# EnabledBaselineDetailsTypeDef definition

class EnabledBaselineDetailsTypeDef(TypedDict):
    arn: str,
    baselineIdentifier: str,
    statusSummary: EnablementStatusSummaryTypeDef,  # (2)
    targetIdentifier: str,
    baselineVersion: NotRequired[str],
    parameters: NotRequired[List[EnabledBaselineParameterSummaryTypeDef]],  # (1)
  1. See EnabledBaselineParameterSummaryTypeDef
  2. See EnablementStatusSummaryTypeDef

EnabledBaselineSummaryTypeDef#

# EnabledBaselineSummaryTypeDef definition

class EnabledBaselineSummaryTypeDef(TypedDict):
    arn: str,
    baselineIdentifier: str,
    statusSummary: EnablementStatusSummaryTypeDef,  # (1)
    targetIdentifier: str,
    baselineVersion: NotRequired[str],
  1. See EnablementStatusSummaryTypeDef

EnabledControlSummaryTypeDef#

# EnabledControlSummaryTypeDef definition

class EnabledControlSummaryTypeDef(TypedDict):
    arn: NotRequired[str],
    controlIdentifier: NotRequired[str],
    driftStatusSummary: NotRequired[DriftStatusSummaryTypeDef],  # (1)
    statusSummary: NotRequired[EnablementStatusSummaryTypeDef],  # (2)
    targetIdentifier: NotRequired[str],
  1. See DriftStatusSummaryTypeDef
  2. See EnablementStatusSummaryTypeDef

ListEnabledBaselinesInputRequestTypeDef#

# ListEnabledBaselinesInputRequestTypeDef definition

class ListEnabledBaselinesInputRequestTypeDef(TypedDict):
    filter: NotRequired[EnabledBaselineFilterTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
  1. See EnabledBaselineFilterTypeDef

EnabledControlDetailsTypeDef#

# EnabledControlDetailsTypeDef definition

class EnabledControlDetailsTypeDef(TypedDict):
    arn: NotRequired[str],
    controlIdentifier: NotRequired[str],
    driftStatusSummary: NotRequired[DriftStatusSummaryTypeDef],  # (1)
    parameters: NotRequired[List[EnabledControlParameterSummaryTypeDef]],  # (2)
    statusSummary: NotRequired[EnablementStatusSummaryTypeDef],  # (3)
    targetIdentifier: NotRequired[str],
    targetRegions: NotRequired[List[RegionTypeDef]],  # (4)
  1. See DriftStatusSummaryTypeDef
  2. See EnabledControlParameterSummaryTypeDef
  3. See EnablementStatusSummaryTypeDef
  4. See RegionTypeDef

GetLandingZoneOperationOutputTypeDef#

# GetLandingZoneOperationOutputTypeDef definition

class GetLandingZoneOperationOutputTypeDef(TypedDict):
    operationDetails: LandingZoneOperationDetailTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LandingZoneOperationDetailTypeDef
  2. See ResponseMetadataTypeDef

LandingZoneDetailTypeDef#

# LandingZoneDetailTypeDef definition

class LandingZoneDetailTypeDef(TypedDict):
    manifest: Dict[str, Any],
    version: str,
    arn: NotRequired[str],
    driftStatus: NotRequired[LandingZoneDriftStatusSummaryTypeDef],  # (1)
    latestAvailableVersion: NotRequired[str],
    status: NotRequired[LandingZoneStatusType],  # (2)
  1. See LandingZoneDriftStatusSummaryTypeDef
  2. See LandingZoneStatusType

ListLandingZonesOutputTypeDef#

# ListLandingZonesOutputTypeDef definition

class ListLandingZonesOutputTypeDef(TypedDict):
    landingZones: List[LandingZoneSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See LandingZoneSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListBaselinesInputListBaselinesPaginateTypeDef#

# ListBaselinesInputListBaselinesPaginateTypeDef definition

class ListBaselinesInputListBaselinesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See