ControlTowerClient

Index > ControlTower > ControlTowerClient

Auto-generated documentation for ControlTower type annotations stubs module types-aiobotocore-controltower.

ControlTowerClient

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

# ControlTowerClient usage example

from aioboto3.session import Session
from types_aiobotocore_controltower.client import ControlTowerClient

session = Session()
async with session.client("controltower") as client:
    client: ControlTowerClient

Exceptions

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

# ControlTowerClient.exceptions usage example

async with session.client("controltower") as client:
    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)

# ControlTowerClient.exceptions type checking example

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

# close method definition

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

create_landing_zone

Creates a new landing zone.

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

# create_landing_zone method definition

await 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 session.client("controltower").delete_landing_zone method. boto3 documentation

# delete_landing_zone method definition

await 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_control

This API call turns off a control.

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

# disable_control method definition

await 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_control

This API call activates a control.

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

# enable_control method definition

await 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 session.client("controltower").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

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

get_control_operation

Returns the status of a particular EnableControl or DisableControl operation.

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

# get_control_operation method definition

await 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_control

Retrieves details about an enabled control.

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

# get_enabled_control method definition

await 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 session.client("controltower").get_landing_zone method. boto3 documentation

# get_landing_zone method definition

await 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 session.client("controltower").get_landing_zone_operation method. boto3 documentation

# get_landing_zone_operation method definition

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

1. See GetLandingZoneOperationOutputTypeDef

# get_landing_zone_operation method usage example with argument unpacking

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

parent.get_landing_zone_operation(**kwargs)

1. See GetLandingZoneOperationInputRequestTypeDef

list_enabled_controls

Lists the controls enabled by Amazon Web Services Control Tower on the specified organizational unit and the accounts it contains.

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

# list_enabled_controls method definition

await def list_enabled_controls(
    self,
    *,
    targetIdentifier: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEnabledControlsOutputTypeDef:  # (1)
    ...

1. See ListEnabledControlsOutputTypeDef

# list_enabled_controls method usage example with argument unpacking

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

parent.list_enabled_controls(**kwargs)

1. See ListEnabledControlsInputRequestTypeDef

list_landing_zones

Returns the landing zone ARN for the landing zone deployed in your managed account.

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

# list_landing_zones method definition

await def list_landing_zones(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLandingZonesOutputTypeDef:  # (1)
    ...

1. See ListLandingZonesOutputTypeDef

# list_landing_zones method usage example with argument unpacking

kwargs: ListLandingZonesInputRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_landing_zones(**kwargs)

1. See ListLandingZonesInputRequestTypeDef

list_tags_for_resource

Returns a list of tags associated with the resource.

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

# list_tags_for_resource method definition

await def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

reset_landing_zone

This API call resets a landing zone.

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

# reset_landing_zone method definition

await def reset_landing_zone(
    self,
    *,
    landingZoneIdentifier: str,
) -> ResetLandingZoneOutputTypeDef:  # (1)
    ...

1. See ResetLandingZoneOutputTypeDef

# reset_landing_zone method usage example with argument unpacking

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

parent.reset_landing_zone(**kwargs)

1. See ResetLandingZoneInputRequestTypeDef

tag_resource

Applies tags to a resource.

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

# tag_resource method definition

await def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

untag_resource

Removes tags from a resource.

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

# untag_resource method definition

await def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputRequestTypeDef

update_enabled_control

Updates the configuration of an already enabled control.

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

# update_enabled_control method definition

await def update_enabled_control(
    self,
    *,
    enabledControlIdentifier: str,
    parameters: Sequence[EnabledControlParameterTypeDef],  # (1)
) -> UpdateEnabledControlOutputTypeDef:  # (2)
    ...

1. See EnabledControlParameterTypeDef
2. See UpdateEnabledControlOutputTypeDef

# update_enabled_control method usage example with argument unpacking

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

parent.update_enabled_control(**kwargs)

1. See UpdateEnabledControlInputRequestTypeDef

update_landing_zone

This API call updates the landing zone.

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

# update_landing_zone method definition

await def update_landing_zone(
    self,
    *,
    landingZoneIdentifier: str,
    manifest: Mapping[str, Any],
    version: str,
) -> UpdateLandingZoneOutputTypeDef:  # (1)
    ...

1. See UpdateLandingZoneOutputTypeDef

# update_landing_zone method usage example with argument unpacking

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

parent.update_landing_zone(**kwargs)

1. See UpdateLandingZoneInputRequestTypeDef

__aenter__

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

# __aenter__ method definition

await def __aenter__(
    self,
) -> ControlTowerClient:
    ...

__aexit__

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

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.client("controltower").get_paginator method with overloads.

• client.get_paginator("list_enabled_controls") -> ListEnabledControlsPaginator
• client.get_paginator("list_landing_zones") -> ListLandingZonesPaginator