Typed dictionaries

Index > ControlTower > Typed dictionaries

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

ControlOperationTypeDef

# ControlOperationTypeDef usage example

from mypy_boto3_controltower.type_defs import ControlOperationTypeDef

def get_value() -> ControlOperationTypeDef:
    return {
        "endTime": ...,
    }

# 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

DisableControlInputRequestTypeDef

# DisableControlInputRequestTypeDef usage example

from mypy_boto3_controltower.type_defs import DisableControlInputRequestTypeDef

def get_value() -> DisableControlInputRequestTypeDef:
    return {
        "controlIdentifier": ...,
        "targetIdentifier": ...,
    }

# DisableControlInputRequestTypeDef definition

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

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_controltower.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,

EnableControlInputRequestTypeDef

# EnableControlInputRequestTypeDef usage example

from mypy_boto3_controltower.type_defs import EnableControlInputRequestTypeDef

def get_value() -> EnableControlInputRequestTypeDef:
    return {
        "controlIdentifier": ...,
        "targetIdentifier": ...,
    }

# EnableControlInputRequestTypeDef definition

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

EnabledControlSummaryTypeDef

# EnabledControlSummaryTypeDef usage example

from mypy_boto3_controltower.type_defs import EnabledControlSummaryTypeDef

def get_value() -> EnabledControlSummaryTypeDef:
    return {
        "controlIdentifier": ...,
    }

# EnabledControlSummaryTypeDef definition

class EnabledControlSummaryTypeDef(TypedDict):
    controlIdentifier: NotRequired[str],

GetControlOperationInputRequestTypeDef

# GetControlOperationInputRequestTypeDef usage example

from mypy_boto3_controltower.type_defs import GetControlOperationInputRequestTypeDef

def get_value() -> GetControlOperationInputRequestTypeDef:
    return {
        "operationIdentifier": ...,
    }

# GetControlOperationInputRequestTypeDef definition

class GetControlOperationInputRequestTypeDef(TypedDict):
    operationIdentifier: str,

PaginatorConfigTypeDef

# PaginatorConfigTypeDef usage example

from mypy_boto3_controltower.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

# PaginatorConfigTypeDef definition

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

ListEnabledControlsInputRequestTypeDef

# ListEnabledControlsInputRequestTypeDef usage example

from mypy_boto3_controltower.type_defs import ListEnabledControlsInputRequestTypeDef

def get_value() -> ListEnabledControlsInputRequestTypeDef:
    return {
        "targetIdentifier": ...,
    }

# ListEnabledControlsInputRequestTypeDef definition

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

DisableControlOutputTypeDef

# DisableControlOutputTypeDef usage example

from mypy_boto3_controltower.type_defs import DisableControlOutputTypeDef

def get_value() -> DisableControlOutputTypeDef:
    return {
        "operationIdentifier": ...,
        "ResponseMetadata": ...,
    }

# DisableControlOutputTypeDef definition

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

1. See ResponseMetadataTypeDef

EnableControlOutputTypeDef

# EnableControlOutputTypeDef usage example

from mypy_boto3_controltower.type_defs import EnableControlOutputTypeDef

def get_value() -> EnableControlOutputTypeDef:
    return {
        "operationIdentifier": ...,
        "ResponseMetadata": ...,
    }

# EnableControlOutputTypeDef definition

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

1. See ResponseMetadataTypeDef

GetControlOperationOutputTypeDef

# GetControlOperationOutputTypeDef usage example

from mypy_boto3_controltower.type_defs import GetControlOperationOutputTypeDef

def get_value() -> GetControlOperationOutputTypeDef:
    return {
        "controlOperation": ...,
        "ResponseMetadata": ...,
    }

# GetControlOperationOutputTypeDef definition

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

1. See ControlOperationTypeDef
2. See ResponseMetadataTypeDef

ListEnabledControlsOutputTypeDef

# ListEnabledControlsOutputTypeDef usage example

from mypy_boto3_controltower.type_defs import ListEnabledControlsOutputTypeDef

def get_value() -> ListEnabledControlsOutputTypeDef:
    return {
        "enabledControls": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }

# ListEnabledControlsOutputTypeDef definition

class ListEnabledControlsOutputTypeDef(TypedDict):
    enabledControls: List[EnabledControlSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See EnabledControlSummaryTypeDef
2. See ResponseMetadataTypeDef

ListEnabledControlsInputListEnabledControlsPaginateTypeDef

# ListEnabledControlsInputListEnabledControlsPaginateTypeDef usage example

from mypy_boto3_controltower.type_defs import ListEnabledControlsInputListEnabledControlsPaginateTypeDef

def get_value() -> ListEnabledControlsInputListEnabledControlsPaginateTypeDef:
    return {
        "targetIdentifier": ...,
    }

# ListEnabledControlsInputListEnabledControlsPaginateTypeDef definition

class ListEnabledControlsInputListEnabledControlsPaginateTypeDef(TypedDict):
    targetIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef