Skip to content

Type definitions#

Index > ControlCatalog > Type definitions

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

AssociatedDomainSummaryTypeDef#

# AssociatedDomainSummaryTypeDef definition

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

AssociatedObjectiveSummaryTypeDef#

# AssociatedObjectiveSummaryTypeDef definition

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

ObjectiveResourceFilterTypeDef#

# ObjectiveResourceFilterTypeDef definition

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

ControlSummaryTypeDef#

# ControlSummaryTypeDef definition

class ControlSummaryTypeDef(TypedDict):
    Arn: str,
    Name: str,
    Description: str,

DomainResourceFilterTypeDef#

# DomainResourceFilterTypeDef definition

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

DomainSummaryTypeDef#

# DomainSummaryTypeDef definition

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

GetControlRequestRequestTypeDef#

# GetControlRequestRequestTypeDef definition

class GetControlRequestRequestTypeDef(TypedDict):
    ControlArn: str,

RegionConfigurationTypeDef#

# RegionConfigurationTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListControlsRequestRequestTypeDef#

# ListControlsRequestRequestTypeDef definition

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

ListDomainsRequestRequestTypeDef#

# ListDomainsRequestRequestTypeDef definition

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

ObjectiveSummaryTypeDef#

# ObjectiveSummaryTypeDef definition

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

CommonControlSummaryTypeDef#

# CommonControlSummaryTypeDef definition

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

CommonControlFilterTypeDef#

# CommonControlFilterTypeDef definition

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

ObjectiveFilterTypeDef#

# ObjectiveFilterTypeDef definition

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

GetControlResponseTypeDef#

# GetControlResponseTypeDef definition

class GetControlResponseTypeDef(TypedDict):
    Arn: str,
    Name: str,
    Description: str,
    Behavior: ControlBehaviorType,  # (1)
    RegionConfiguration: RegionConfigurationTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ControlBehaviorType
  2. See RegionConfigurationTypeDef
  3. See ResponseMetadataTypeDef

ListControlsResponseTypeDef#

# ListControlsResponseTypeDef definition

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

ListDomainsResponseTypeDef#

# ListDomainsResponseTypeDef definition

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

ListControlsRequestListControlsPaginateTypeDef#

# ListControlsRequestListControlsPaginateTypeDef definition

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

ListDomainsRequestListDomainsPaginateTypeDef#

# ListDomainsRequestListDomainsPaginateTypeDef definition

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

ListObjectivesResponseTypeDef#

# ListObjectivesResponseTypeDef definition

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

ListCommonControlsResponseTypeDef#

# ListCommonControlsResponseTypeDef definition

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

ListCommonControlsRequestListCommonControlsPaginateTypeDef#

# ListCommonControlsRequestListCommonControlsPaginateTypeDef definition

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

ListCommonControlsRequestRequestTypeDef#

# ListCommonControlsRequestRequestTypeDef definition

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

ListObjectivesRequestListObjectivesPaginateTypeDef#

# ListObjectivesRequestListObjectivesPaginateTypeDef definition

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

ListObjectivesRequestRequestTypeDef#

# ListObjectivesRequestRequestTypeDef definition

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