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

# get_landing_zone_operation method usage example with argument unpacking

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

parent.get_landing_zone_operation(**kwargs)

1. See GetLandingZoneOperationInputRequestTypeDef

list_baselines

Returns a summary list of all available baselines.

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

# list_baselines method definition

def list_baselines(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListBaselinesOutputTypeDef:  # (1)
    ...

1. See ListBaselinesOutputTypeDef

# list_baselines method usage example with argument unpacking

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

parent.list_baselines(**kwargs)

1. See ListBaselinesInputRequestTypeDef

list_control_operations

Provides a list of operations in progress or queued.

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

# list_control_operations method definition

def list_control_operations(
    self,
    *,
    filter: ControlOperationFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListControlOperationsOutputTypeDef:  # (2)
    ...

1. See ControlOperationFilterTypeDef
2. See ListControlOperationsOutputTypeDef

# list_control_operations method usage example with argument unpacking

kwargs: ListControlOperationsInputRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_control_operations(**kwargs)

1. See ListControlOperationsInputRequestTypeDef

list_enabled_baselines

Returns a list of summaries describing EnabledBaseline resources.

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

# list_enabled_baselines method definition

def list_enabled_baselines(
    self,
    *,
    filter: EnabledBaselineFilterTypeDef = ...,  # (1)
    includeChildren: bool = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListEnabledBaselinesOutputTypeDef:  # (2)
    ...

1. See EnabledBaselineFilterTypeDef
2. See ListEnabledBaselinesOutputTypeDef

# list_enabled_baselines method usage example with argument unpacking

kwargs: ListEnabledBaselinesInputRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_enabled_baselines(**kwargs)

1. See ListEnabledBaselinesInputRequestTypeDef

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

# list_enabled_controls method definition

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

1. See EnabledControlFilterTypeDef
2. See ListEnabledControlsOutputTypeDef

# list_enabled_controls method usage example with argument unpacking

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

parent.list_enabled_controls(**kwargs)

1. See ListEnabledControlsInputRequestTypeDef

list_landing_zone_operations

Lists all landing zone operations from the past 90 days.

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

# list_landing_zone_operations method definition

def list_landing_zone_operations(
    self,
    *,
    filter: LandingZoneOperationFilterTypeDef = ...,  # (1)
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListLandingZoneOperationsOutputTypeDef:  # (2)
    ...

1. See LandingZoneOperationFilterTypeDef
2. See ListLandingZoneOperationsOutputTypeDef

# list_landing_zone_operations method usage example with argument unpacking

kwargs: ListLandingZoneOperationsInputRequestTypeDef = {  # (1)
    "filter": ...,
}

parent.list_landing_zone_operations(**kwargs)

1. See ListLandingZoneOperationsInputRequestTypeDef

list_landing_zones

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

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

# list_landing_zones method definition

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

# list_tags_for_resource method definition

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_enabled_baseline

Re-enables an EnabledBaseline resource.

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

# reset_enabled_baseline method definition

def reset_enabled_baseline(
    self,
    *,
    enabledBaselineIdentifier: str,
) -> ResetEnabledBaselineOutputTypeDef:  # (1)
    ...

1. See ResetEnabledBaselineOutputTypeDef

# reset_enabled_baseline method usage example with argument unpacking

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

parent.reset_enabled_baseline(**kwargs)

1. See ResetEnabledBaselineInputRequestTypeDef

reset_enabled_control

Resets an enabled control.

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

# reset_enabled_control method definition

def reset_enabled_control(
    self,
    *,
    enabledControlIdentifier: str,
) -> ResetEnabledControlOutputTypeDef:  # (1)
    ...

1. See ResetEnabledControlOutputTypeDef

# reset_enabled_control method usage example with argument unpacking

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

parent.reset_enabled_control(**kwargs)

1. See ResetEnabledControlInputRequestTypeDef

reset_landing_zone

This API call resets a landing zone.

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

# reset_landing_zone method definition

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

# tag_resource method definition

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

# untag_resource method definition

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_baseline

Updates an EnabledBaseline resource's applied parameters or version.

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

# update_enabled_baseline method definition

def update_enabled_baseline(
    self,
    *,
    baselineVersion: str,
    enabledBaselineIdentifier: str,
    parameters: Sequence[EnabledBaselineParameterTypeDef] = ...,  # (1)
) -> UpdateEnabledBaselineOutputTypeDef:  # (2)
    ...

1. See EnabledBaselineParameterTypeDef
2. See UpdateEnabledBaselineOutputTypeDef

# update_enabled_baseline method usage example with argument unpacking

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

parent.update_enabled_baseline(**kwargs)

1. See UpdateEnabledBaselineInputRequestTypeDef

update_enabled_control

Updates the configuration of an already enabled control.

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

# update_enabled_control method definition

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

# update_landing_zone method definition

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

get_paginator

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

• client.get_paginator("list_baselines") -> ListBaselinesPaginator
• client.get_paginator("list_control_operations") -> ListControlOperationsPaginator
• client.get_paginator("list_enabled_baselines") -> ListEnabledBaselinesPaginator
• client.get_paginator("list_enabled_controls") -> ListEnabledControlsPaginator
• client.get_paginator("list_landing_zone_operations") -> ListLandingZoneOperationsPaginator
• client.get_paginator("list_landing_zones") -> ListLandingZonesPaginator