Type definitions

Index > ControlCatalog > Type definitions

Auto-generated documentation for ControlCatalog type annotations stubs module mypy-boto3-controlcatalog.

AssociatedDomainSummaryTypeDef

# AssociatedDomainSummaryTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import AssociatedDomainSummaryTypeDef


def get_value() -> AssociatedDomainSummaryTypeDef:
    return {
        "Arn": ...,
    }


# AssociatedDomainSummaryTypeDef definition

class AssociatedDomainSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    Name: NotRequired[str],

AssociatedObjectiveSummaryTypeDef

# AssociatedObjectiveSummaryTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import AssociatedObjectiveSummaryTypeDef


def get_value() -> AssociatedObjectiveSummaryTypeDef:
    return {
        "Arn": ...,
    }


# AssociatedObjectiveSummaryTypeDef definition

class AssociatedObjectiveSummaryTypeDef(TypedDict):
    Arn: NotRequired[str],
    Name: NotRequired[str],

ObjectiveResourceFilterTypeDef

# ObjectiveResourceFilterTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ObjectiveResourceFilterTypeDef


def get_value() -> ObjectiveResourceFilterTypeDef:
    return {
        "Arn": ...,
    }


# ObjectiveResourceFilterTypeDef definition

class ObjectiveResourceFilterTypeDef(TypedDict):
    Arn: NotRequired[str],

CommonControlMappingDetailsTypeDef

# CommonControlMappingDetailsTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import CommonControlMappingDetailsTypeDef


def get_value() -> CommonControlMappingDetailsTypeDef:
    return {
        "CommonControlArn": ...,
    }


# CommonControlMappingDetailsTypeDef definition

class CommonControlMappingDetailsTypeDef(TypedDict):
    CommonControlArn: str,

ImplementationFilterTypeDef

# ImplementationFilterTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ImplementationFilterTypeDef


def get_value() -> ImplementationFilterTypeDef:
    return {
        "Types": ...,
    }


# ImplementationFilterTypeDef definition

class ImplementationFilterTypeDef(TypedDict):
    Types: NotRequired[Sequence[str]],
    Identifiers: NotRequired[Sequence[str]],

ControlMappingFilterTypeDef

# ControlMappingFilterTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ControlMappingFilterTypeDef


def get_value() -> ControlMappingFilterTypeDef:
    return {
        "ControlArns": ...,
    }


# ControlMappingFilterTypeDef definition

class ControlMappingFilterTypeDef(TypedDict):
    ControlArns: NotRequired[Sequence[str]],
    CommonControlArns: NotRequired[Sequence[str]],
    MappingTypes: NotRequired[Sequence[MappingTypeType]],  # (1)

1. See Sequence[MappingTypeType]

ControlParameterTypeDef

# ControlParameterTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ControlParameterTypeDef


def get_value() -> ControlParameterTypeDef:
    return {
        "Name": ...,
    }


# ControlParameterTypeDef definition

class ControlParameterTypeDef(TypedDict):
    Name: str,

ImplementationSummaryTypeDef

# ImplementationSummaryTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ImplementationSummaryTypeDef


def get_value() -> ImplementationSummaryTypeDef:
    return {
        "Type": ...,
    }


# ImplementationSummaryTypeDef definition

class ImplementationSummaryTypeDef(TypedDict):
    Type: str,
    Identifier: NotRequired[str],

DomainResourceFilterTypeDef

# DomainResourceFilterTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import DomainResourceFilterTypeDef


def get_value() -> DomainResourceFilterTypeDef:
    return {
        "Arn": ...,
    }


# DomainResourceFilterTypeDef definition

class DomainResourceFilterTypeDef(TypedDict):
    Arn: NotRequired[str],

DomainSummaryTypeDef

# DomainSummaryTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import DomainSummaryTypeDef


def get_value() -> DomainSummaryTypeDef:
    return {
        "Arn": ...,
    }


# DomainSummaryTypeDef definition

class DomainSummaryTypeDef(TypedDict):
    Arn: str,
    Name: str,
    Description: str,
    CreateTime: datetime.datetime,
    LastUpdateTime: datetime.datetime,

FrameworkMappingDetailsTypeDef

# FrameworkMappingDetailsTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import FrameworkMappingDetailsTypeDef


def get_value() -> FrameworkMappingDetailsTypeDef:
    return {
        "Name": ...,
    }


# FrameworkMappingDetailsTypeDef definition

class FrameworkMappingDetailsTypeDef(TypedDict):
    Name: str,
    Item: str,

GetControlRequestTypeDef

# GetControlRequestTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import GetControlRequestTypeDef


def get_value() -> GetControlRequestTypeDef:
    return {
        "ControlArn": ...,
    }


# GetControlRequestTypeDef definition

class GetControlRequestTypeDef(TypedDict):
    ControlArn: str,

ImplementationDetailsTypeDef

# ImplementationDetailsTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ImplementationDetailsTypeDef


def get_value() -> ImplementationDetailsTypeDef:
    return {
        "Type": ...,
    }


# ImplementationDetailsTypeDef definition

class ImplementationDetailsTypeDef(TypedDict):
    Type: str,
    Identifier: NotRequired[str],

RegionConfigurationTypeDef

# RegionConfigurationTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import RegionConfigurationTypeDef


def get_value() -> RegionConfigurationTypeDef:
    return {
        "Scope": ...,
    }


# RegionConfigurationTypeDef definition

class RegionConfigurationTypeDef(TypedDict):
    Scope: ControlScopeType,  # (1)
    DeployableRegions: NotRequired[List[str]],

1. See ControlScopeType

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import PaginatorConfigTypeDef


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


# PaginatorConfigTypeDef definition

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

ListDomainsRequestTypeDef

# ListDomainsRequestTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListDomainsRequestTypeDef


def get_value() -> ListDomainsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListDomainsRequestTypeDef definition

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

ObjectiveSummaryTypeDef

# ObjectiveSummaryTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ObjectiveSummaryTypeDef


def get_value() -> ObjectiveSummaryTypeDef:
    return {
        "Arn": ...,
    }


# ObjectiveSummaryTypeDef definition

class ObjectiveSummaryTypeDef(TypedDict):
    Arn: str,
    Name: str,
    Description: str,
    Domain: AssociatedDomainSummaryTypeDef,  # (1)
    CreateTime: datetime.datetime,
    LastUpdateTime: datetime.datetime,

1. See AssociatedDomainSummaryTypeDef

CommonControlSummaryTypeDef

# CommonControlSummaryTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import CommonControlSummaryTypeDef


def get_value() -> CommonControlSummaryTypeDef:
    return {
        "Arn": ...,
    }


# CommonControlSummaryTypeDef definition

class CommonControlSummaryTypeDef(TypedDict):
    Arn: str,
    Name: str,
    Description: str,
    Domain: AssociatedDomainSummaryTypeDef,  # (1)
    Objective: AssociatedObjectiveSummaryTypeDef,  # (2)
    CreateTime: datetime.datetime,
    LastUpdateTime: datetime.datetime,

1. See AssociatedDomainSummaryTypeDef
2. See AssociatedObjectiveSummaryTypeDef

CommonControlFilterTypeDef

# CommonControlFilterTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import CommonControlFilterTypeDef


def get_value() -> CommonControlFilterTypeDef:
    return {
        "Objectives": ...,
    }


# CommonControlFilterTypeDef definition

class CommonControlFilterTypeDef(TypedDict):
    Objectives: NotRequired[Sequence[ObjectiveResourceFilterTypeDef]],  # (1)

1. See Sequence[ObjectiveResourceFilterTypeDef]

ControlFilterTypeDef

# ControlFilterTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ControlFilterTypeDef


def get_value() -> ControlFilterTypeDef:
    return {
        "Implementations": ...,
    }


# ControlFilterTypeDef definition

class ControlFilterTypeDef(TypedDict):
    Implementations: NotRequired[ImplementationFilterTypeDef],  # (1)

1. See ImplementationFilterTypeDef

ListControlMappingsRequestTypeDef

# ListControlMappingsRequestTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListControlMappingsRequestTypeDef


def get_value() -> ListControlMappingsRequestTypeDef:
    return {
        "NextToken": ...,
    }


# ListControlMappingsRequestTypeDef definition

class ListControlMappingsRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filter: NotRequired[ControlMappingFilterTypeDef],  # (1)

1. See ControlMappingFilterTypeDef

ControlSummaryTypeDef

# ControlSummaryTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ControlSummaryTypeDef


def get_value() -> ControlSummaryTypeDef:
    return {
        "Arn": ...,
    }


# ControlSummaryTypeDef definition

class ControlSummaryTypeDef(TypedDict):
    Arn: str,
    Name: str,
    Description: str,
    Aliases: NotRequired[List[str]],
    Behavior: NotRequired[ControlBehaviorType],  # (1)
    Severity: NotRequired[ControlSeverityType],  # (2)
    Implementation: NotRequired[ImplementationSummaryTypeDef],  # (3)
    CreateTime: NotRequired[datetime.datetime],
    GovernedResources: NotRequired[List[str]],

1. See ControlBehaviorType
2. See ControlSeverityType
3. See ImplementationSummaryTypeDef

ObjectiveFilterTypeDef

# ObjectiveFilterTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ObjectiveFilterTypeDef


def get_value() -> ObjectiveFilterTypeDef:
    return {
        "Domains": ...,
    }


# ObjectiveFilterTypeDef definition

class ObjectiveFilterTypeDef(TypedDict):
    Domains: NotRequired[Sequence[DomainResourceFilterTypeDef]],  # (1)

1. See Sequence[DomainResourceFilterTypeDef]

MappingTypeDef

# MappingTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import MappingTypeDef


def get_value() -> MappingTypeDef:
    return {
        "Framework": ...,
    }


# MappingTypeDef definition

class MappingTypeDef(TypedDict):
    Framework: NotRequired[FrameworkMappingDetailsTypeDef],  # (1)
    CommonControl: NotRequired[CommonControlMappingDetailsTypeDef],  # (2)

1. See FrameworkMappingDetailsTypeDef
2. See CommonControlMappingDetailsTypeDef

GetControlResponseTypeDef

# GetControlResponseTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import GetControlResponseTypeDef


def get_value() -> GetControlResponseTypeDef:
    return {
        "Arn": ...,
    }


# GetControlResponseTypeDef definition

class GetControlResponseTypeDef(TypedDict):
    Arn: str,
    Aliases: List[str],
    Name: str,
    Description: str,
    Behavior: ControlBehaviorType,  # (1)
    Severity: ControlSeverityType,  # (2)
    RegionConfiguration: RegionConfigurationTypeDef,  # (3)
    Implementation: ImplementationDetailsTypeDef,  # (4)
    Parameters: List[ControlParameterTypeDef],  # (5)
    CreateTime: datetime.datetime,
    GovernedResources: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)

1. See ControlBehaviorType
2. See ControlSeverityType
3. See RegionConfigurationTypeDef
4. See ImplementationDetailsTypeDef
5. See List[ControlParameterTypeDef]
6. See ResponseMetadataTypeDef

ListDomainsResponseTypeDef

# ListDomainsResponseTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListDomainsResponseTypeDef


def get_value() -> ListDomainsResponseTypeDef:
    return {
        "Domains": ...,
    }


# ListDomainsResponseTypeDef definition

class ListDomainsResponseTypeDef(TypedDict):
    Domains: List[DomainSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[DomainSummaryTypeDef]
2. See ResponseMetadataTypeDef

ListControlMappingsRequestPaginateTypeDef

# ListControlMappingsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListControlMappingsRequestPaginateTypeDef


def get_value() -> ListControlMappingsRequestPaginateTypeDef:
    return {
        "Filter": ...,
    }


# ListControlMappingsRequestPaginateTypeDef definition

class ListControlMappingsRequestPaginateTypeDef(TypedDict):
    Filter: NotRequired[ControlMappingFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

1. See ControlMappingFilterTypeDef
2. See PaginatorConfigTypeDef

ListDomainsRequestPaginateTypeDef

# ListDomainsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListDomainsRequestPaginateTypeDef


def get_value() -> ListDomainsRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListDomainsRequestPaginateTypeDef definition

class ListDomainsRequestPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

ListObjectivesResponseTypeDef

# ListObjectivesResponseTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListObjectivesResponseTypeDef


def get_value() -> ListObjectivesResponseTypeDef:
    return {
        "Objectives": ...,
    }


# ListObjectivesResponseTypeDef definition

class ListObjectivesResponseTypeDef(TypedDict):
    Objectives: List[ObjectiveSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[ObjectiveSummaryTypeDef]
2. See ResponseMetadataTypeDef

ListCommonControlsResponseTypeDef

# ListCommonControlsResponseTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListCommonControlsResponseTypeDef


def get_value() -> ListCommonControlsResponseTypeDef:
    return {
        "CommonControls": ...,
    }


# ListCommonControlsResponseTypeDef definition

class ListCommonControlsResponseTypeDef(TypedDict):
    CommonControls: List[CommonControlSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[CommonControlSummaryTypeDef]
2. See ResponseMetadataTypeDef

ListCommonControlsRequestPaginateTypeDef

# ListCommonControlsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListCommonControlsRequestPaginateTypeDef


def get_value() -> ListCommonControlsRequestPaginateTypeDef:
    return {
        "CommonControlFilter": ...,
    }


# ListCommonControlsRequestPaginateTypeDef definition

class ListCommonControlsRequestPaginateTypeDef(TypedDict):
    CommonControlFilter: NotRequired[CommonControlFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

1. See CommonControlFilterTypeDef
2. See PaginatorConfigTypeDef

ListCommonControlsRequestTypeDef

# ListCommonControlsRequestTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListCommonControlsRequestTypeDef


def get_value() -> ListCommonControlsRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListCommonControlsRequestTypeDef definition

class ListCommonControlsRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    CommonControlFilter: NotRequired[CommonControlFilterTypeDef],  # (1)

1. See CommonControlFilterTypeDef

ListControlsRequestPaginateTypeDef

# ListControlsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListControlsRequestPaginateTypeDef


def get_value() -> ListControlsRequestPaginateTypeDef:
    return {
        "Filter": ...,
    }


# ListControlsRequestPaginateTypeDef definition

class ListControlsRequestPaginateTypeDef(TypedDict):
    Filter: NotRequired[ControlFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

1. See ControlFilterTypeDef
2. See PaginatorConfigTypeDef

ListControlsRequestTypeDef

# ListControlsRequestTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListControlsRequestTypeDef


def get_value() -> ListControlsRequestTypeDef:
    return {
        "NextToken": ...,
    }


# ListControlsRequestTypeDef definition

class ListControlsRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filter: NotRequired[ControlFilterTypeDef],  # (1)

1. See ControlFilterTypeDef

ListControlsResponseTypeDef

# ListControlsResponseTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListControlsResponseTypeDef


def get_value() -> ListControlsResponseTypeDef:
    return {
        "Controls": ...,
    }


# ListControlsResponseTypeDef definition

class ListControlsResponseTypeDef(TypedDict):
    Controls: List[ControlSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[ControlSummaryTypeDef]
2. See ResponseMetadataTypeDef

ListObjectivesRequestPaginateTypeDef

# ListObjectivesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListObjectivesRequestPaginateTypeDef


def get_value() -> ListObjectivesRequestPaginateTypeDef:
    return {
        "ObjectiveFilter": ...,
    }


# ListObjectivesRequestPaginateTypeDef definition

class ListObjectivesRequestPaginateTypeDef(TypedDict):
    ObjectiveFilter: NotRequired[ObjectiveFilterTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

1. See ObjectiveFilterTypeDef
2. See PaginatorConfigTypeDef

ListObjectivesRequestTypeDef

# ListObjectivesRequestTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListObjectivesRequestTypeDef


def get_value() -> ListObjectivesRequestTypeDef:
    return {
        "MaxResults": ...,
    }


# ListObjectivesRequestTypeDef definition

class ListObjectivesRequestTypeDef(TypedDict):
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
    ObjectiveFilter: NotRequired[ObjectiveFilterTypeDef],  # (1)

1. See ObjectiveFilterTypeDef

ControlMappingTypeDef

# ControlMappingTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ControlMappingTypeDef


def get_value() -> ControlMappingTypeDef:
    return {
        "ControlArn": ...,
    }


# ControlMappingTypeDef definition

class ControlMappingTypeDef(TypedDict):
    ControlArn: str,
    MappingType: MappingTypeType,  # (1)
    Mapping: MappingTypeDef,  # (2)

1. See MappingTypeType
2. See MappingTypeDef

ListControlMappingsResponseTypeDef

# ListControlMappingsResponseTypeDef TypedDict usage example

from mypy_boto3_controlcatalog.type_defs import ListControlMappingsResponseTypeDef


def get_value() -> ListControlMappingsResponseTypeDef:
    return {
        "ControlMappings": ...,
    }


# ListControlMappingsResponseTypeDef definition

class ListControlMappingsResponseTypeDef(TypedDict):
    ControlMappings: List[ControlMappingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],

1. See List[ControlMappingTypeDef]
2. See ResponseMetadataTypeDef