Skip to content

ControlCatalogClient#

Index > ControlCatalog > ControlCatalogClient

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

ControlCatalogClient#

Type annotations and code completion for boto3.client("controlcatalog"). boto3 documentation

# ControlCatalogClient usage example

from boto3.session import Session
from mypy_boto3_controlcatalog.client import ControlCatalogClient

def get_controlcatalog_client() -> ControlCatalogClient:
    return Session().client("controlcatalog")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("controlcatalog").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("controlcatalog")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_controlcatalog.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("controlcatalog").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("controlcatalog").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("controlcatalog").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_control#

Returns details about a specific control, most notably a list of Amazon Web Services Regions where this control is supported.

Type annotations and code completion for boto3.client("controlcatalog").get_control method. boto3 documentation

# get_control method definition

def get_control(
    self,
    *,
    ControlArn: str,
) -> GetControlResponseTypeDef:  # (1)
    ...
  1. See GetControlResponseTypeDef 
# get_control method usage example with argument unpacking

kwargs: GetControlRequestRequestTypeDef = {  # (1)
    "ControlArn": ...,
}

parent.get_control(**kwargs)
  1. See GetControlRequestRequestTypeDef

list_common_controls#

Returns a paginated list of common controls from the Amazon Web Services Control Catalog.

Type annotations and code completion for boto3.client("controlcatalog").list_common_controls method. boto3 documentation

# list_common_controls method definition

def list_common_controls(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    CommonControlFilter: CommonControlFilterTypeDef = ...,  # (1)
) -> ListCommonControlsResponseTypeDef:  # (2)
    ...
  1. See CommonControlFilterTypeDef
  2. See ListCommonControlsResponseTypeDef 
# list_common_controls method usage example with argument unpacking

kwargs: ListCommonControlsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_common_controls(**kwargs)
  1. See ListCommonControlsRequestRequestTypeDef

list_controls#

Returns a paginated list of all available controls in the Amazon Web Services Control Catalog library.

Type annotations and code completion for boto3.client("controlcatalog").list_controls method. boto3 documentation

# list_controls method definition

def list_controls(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListControlsResponseTypeDef:  # (1)
    ...
  1. See ListControlsResponseTypeDef 
# list_controls method usage example with argument unpacking

kwargs: ListControlsRequestRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_controls(**kwargs)
  1. See ListControlsRequestRequestTypeDef

list_domains#

Returns a paginated list of domains from the Amazon Web Services Control Catalog.

Type annotations and code completion for boto3.client("controlcatalog").list_domains method. boto3 documentation

# list_domains method definition

def list_domains(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListDomainsResponseTypeDef:  # (1)
    ...
  1. See ListDomainsResponseTypeDef 
# list_domains method usage example with argument unpacking

kwargs: ListDomainsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_domains(**kwargs)
  1. See ListDomainsRequestRequestTypeDef

list_objectives#

Returns a paginated list of objectives from the Amazon Web Services Control Catalog.

Type annotations and code completion for boto3.client("controlcatalog").list_objectives method. boto3 documentation

# list_objectives method definition

def list_objectives(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    ObjectiveFilter: ObjectiveFilterTypeDef = ...,  # (1)
) -> ListObjectivesResponseTypeDef:  # (2)
    ...
  1. See ObjectiveFilterTypeDef
  2. See ListObjectivesResponseTypeDef 
# list_objectives method usage example with argument unpacking

kwargs: ListObjectivesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_objectives(**kwargs)
  1. See ListObjectivesRequestRequestTypeDef

get_paginator#

Type annotations and code completion for boto3.client("controlcatalog").get_paginator method with overloads.