Skip to content

ControlTowerClient#

Index > ControlTower > ControlTowerClient

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

ControlTowerClient#

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

# ControlTowerClient usage example

from boto3.session import Session
from mypy_boto3_controltower.client import ControlTowerClient

def get_controltower_client() -> ControlTowerClient:
    return Session().client("controltower")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("controltower")

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

from mypy_boto3_controltower.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("controltower").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("controltower").close method. boto3 documentation

# close method definition

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

create_landing_zone#

Creates a new landing zone.

Type annotations and code completion for boto3.client("controltower").create_landing_zone method. boto3 documentation

# create_landing_zone method definition

def create_landing_zone(
    self,
    *,
    manifest: Mapping[str, Any],
    version: str,
    tags: Mapping[str, str] = ...,
) -> CreateLandingZoneOutputTypeDef:  # (1)
    ...
  1. See CreateLandingZoneOutputTypeDef
# create_landing_zone method usage example with argument unpacking

kwargs: CreateLandingZoneInputRequestTypeDef = {  # (1)
    "manifest": ...,
    "version": ...,
}

parent.create_landing_zone(**kwargs)
  1. See CreateLandingZoneInputRequestTypeDef

delete_landing_zone#

Decommissions a landing zone.

Type annotations and code completion for boto3.client("controltower").delete_landing_zone method. boto3 documentation

# delete_landing_zone method definition

def delete_landing_zone(
    self,
    *,
    landingZoneIdentifier: str,
) -> DeleteLandingZoneOutputTypeDef:  # (1)
    ...
  1. See DeleteLandingZoneOutputTypeDef
# delete_landing_zone method usage example with argument unpacking

kwargs: DeleteLandingZoneInputRequestTypeDef = {  # (1)
    "landingZoneIdentifier": ...,
}

parent.delete_landing_zone(**kwargs)
  1. See DeleteLandingZoneInputRequestTypeDef

disable_baseline#

Disable an EnabledBaseline resource on the specified Target.

Type annotations and code completion for boto3.client("controltower").disable_baseline method. boto3 documentation

# disable_baseline method definition

def disable_baseline(
    self,
    *,
    enabledBaselineIdentifier: str,
) -> DisableBaselineOutputTypeDef:  # (1)
    ...
  1. See DisableBaselineOutputTypeDef
# disable_baseline method usage example with argument unpacking

kwargs: DisableBaselineInputRequestTypeDef = {  # (1)
    "enabledBaselineIdentifier": ...,
}

parent.disable_baseline(**kwargs)
  1. See DisableBaselineInputRequestTypeDef

disable_control#

This API call turns off a control.

Type annotations and code completion for boto3.client("controltower").disable_control method. boto3 documentation

# disable_control method definition

def disable_control(
    self,
    *,
    controlIdentifier: str,
    targetIdentifier: str,
) -> DisableControlOutputTypeDef:  # (1)
    ...
  1. See DisableControlOutputTypeDef
# disable_control method usage example with argument unpacking

kwargs: DisableControlInputRequestTypeDef = {  # (1)
    "controlIdentifier": ...,
    "targetIdentifier": ...,
}

parent.disable_control(**kwargs)
  1. See DisableControlInputRequestTypeDef

enable_baseline#

Enable (apply) a Baseline to a Target.

Type annotations and code completion for boto3.client("controltower").enable_baseline method. boto3 documentation

# enable_baseline method definition

def enable_baseline(
    self,
    *,
    baselineIdentifier: str,
    baselineVersion: str,
    targetIdentifier: str,
    parameters: Sequence[EnabledBaselineParameterTypeDef] = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> EnableBaselineOutputTypeDef:  # (2)
    ...
  1. See EnabledBaselineParameterTypeDef
  2. See EnableBaselineOutputTypeDef
# enable_baseline method usage example with argument unpacking

kwargs: EnableBaselineInputRequestTypeDef = {  # (1)
    "baselineIdentifier": ...,
    "baselineVersion": ...,
    "targetIdentifier": ...,
}

parent.enable_baseline(**kwargs)
  1. See EnableBaselineInputRequestTypeDef

enable_control#

This API call activates a control.

Type annotations and code completion for boto3.client("controltower").enable_control method. boto3 documentation

# enable_control method definition

def enable_control(
    self,
    *,
    controlIdentifier: str,
    targetIdentifier: str,
    parameters: Sequence[EnabledControlParameterTypeDef] = ...,  # (1)
    tags: Mapping[str, str] = ...,
) -> EnableControlOutputTypeDef:  # (2)
    ...
  1. See EnabledControlParameterTypeDef
  2. See EnableControlOutputTypeDef
# enable_control method usage example with argument unpacking

kwargs: EnableControlInputRequestTypeDef = {  # (1)
    "controlIdentifier": ...,
    "targetIdentifier": ...,
}

parent.enable_control(**kwargs)
  1. See EnableControlInputRequestTypeDef

generate_presigned_url#

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

Type annotations and code completion for boto3.client("controltower").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_baseline#

Retrieve details about an existing Baseline resource by specifying its identifier.

Type annotations and code completion for boto3.client("controltower").get_baseline method. boto3 documentation

# get_baseline method definition

def get_baseline(
    self,
    *,
    baselineIdentifier: str,
) -> GetBaselineOutputTypeDef:  # (1)
    ...
  1. See GetBaselineOutputTypeDef
# get_baseline method usage example with argument unpacking

kwargs: GetBaselineInputRequestTypeDef = {  # (1)
    "baselineIdentifier": ...,
}

parent.get_baseline(**kwargs)
  1. See GetBaselineInputRequestTypeDef

get_baseline_operation#

Returns the details of an asynchronous baseline operation, as initiated by any of these APIs: EnableBaseline, DisableBaseline, UpdateEnabledBaseline, ResetEnabledBaseline.

Type annotations and code completion for boto3.client("controltower").get_baseline_operation method. boto3 documentation

# get_baseline_operation method definition

def get_baseline_operation(
    self,
    *,
    operationIdentifier: str,
) -> GetBaselineOperationOutputTypeDef:  # (1)
    ...
  1. See GetBaselineOperationOutputTypeDef
# get_baseline_operation method usage example with argument unpacking

kwargs: GetBaselineOperationInputRequestTypeDef = {  # (1)
    "operationIdentifier": ...,
}

parent.get_baseline_operation(**kwargs)
  1. See GetBaselineOperationInputRequestTypeDef

get_control_operation#

Returns the status of a particular EnableControl or DisableControl operation.

Type annotations and code completion for boto3.client("controltower").get_control_operation method. boto3 documentation

# get_control_operation method definition

def get_control_operation(
    self,
    *,
    operationIdentifier: str,
) -> GetControlOperationOutputTypeDef:  # (1)
    ...
  1. See GetControlOperationOutputTypeDef
# get_control_operation method usage example with argument unpacking

kwargs: GetControlOperationInputRequestTypeDef = {  # (1)
    "operationIdentifier": ...,
}

parent.get_control_operation(**kwargs)
  1. See GetControlOperationInputRequestTypeDef

get_enabled_baseline#

Retrieve details of an EnabledBaseline resource by specifying its identifier.

Type annotations and code completion for boto3.client("controltower").get_enabled_baseline method. boto3 documentation

# get_enabled_baseline method definition

def get_enabled_baseline(
    self,
    *,
    enabledBaselineIdentifier: str,
) -> GetEnabledBaselineOutputTypeDef:  # (1)
    ...
  1. See GetEnabledBaselineOutputTypeDef
# get_enabled_baseline method usage example with argument unpacking

kwargs: GetEnabledBaselineInputRequestTypeDef = {  # (1)
    "enabledBaselineIdentifier": ...,
}

parent.get_enabled_baseline(**kwargs)
  1. See GetEnabledBaselineInputRequestTypeDef

get_enabled_control#

Retrieves details about an enabled control.

Type annotations and code completion for boto3.client("controltower").get_enabled_control method. boto3 documentation

# get_enabled_control method definition

def get_enabled_control(
    self,
    *,
    enabledControlIdentifier: str,
) -> GetEnabledControlOutputTypeDef:  # (1)
    ...
  1. See GetEnabledControlOutputTypeDef
# get_enabled_control method usage example with argument unpacking

kwargs: GetEnabledControlInputRequestTypeDef = {  # (1)
    "enabledControlIdentifier": ...,
}

parent.get_enabled_control(**kwargs)
  1. See GetEnabledControlInputRequestTypeDef

get_landing_zone#

Returns details about the landing zone.

Type annotations and code completion for boto3.client("controltower").get_landing_zone method. boto3 documentation

# get_landing_zone method definition

def get_landing_zone(
    self,
    *,
    landingZoneIdentifier: str,
) -> GetLandingZoneOutputTypeDef:  # (1)
    ...
  1. See GetLandingZoneOutputTypeDef
# get_landing_zone method usage example with argument unpacking

kwargs: GetLandingZoneInputRequestTypeDef = {  # (1)
    "landingZoneIdentifier": ...,
}

parent.get_landing_zone(**kwargs)
  1. See GetLandingZoneInputRequestTypeDef

get_landing_zone_operation#

Returns the status of the specified landing zone operation.

Type annotations and code completion for boto3.client("controltower").get_landing_zone_operation method. boto3 documentation

# get_landing_zone_operation method definition

def get_landing_zone_operation(
    self,
    *,
    operationIdentifier: str,
) -> GetLandingZoneOperationOutputTypeDef:  # (1)
    ...
  1. See GetLandingZoneOperationOutputTypeDef
<