CloudControlApiClient

Index > CloudControlApi > CloudControlApiClient

Auto-generated documentation for CloudControlApi type annotations stubs module mypy-boto3-cloudcontrol.

CloudControlApiClient

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

# CloudControlApiClient usage example

from boto3.session import Session
from mypy_boto3_cloudcontrol.client import CloudControlApiClient

def get_cloudcontrol_client() -> CloudControlApiClient:
    return Session().client("cloudcontrol")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("cloudcontrol")

try:
    do_something(client)
except (
    client.exceptions.AlreadyExistsException,
    client.exceptions.ClientError,
    client.exceptions.ClientTokenConflictException,
    client.exceptions.ConcurrentModificationException,
    client.exceptions.ConcurrentOperationException,
    client.exceptions.GeneralServiceException,
    client.exceptions.HandlerFailureException,
    client.exceptions.HandlerInternalFailureException,
    client.exceptions.InvalidCredentialsException,
    client.exceptions.InvalidRequestException,
    client.exceptions.NetworkFailureException,
    client.exceptions.NotStabilizedException,
    client.exceptions.NotUpdatableException,
    client.exceptions.PrivateTypeException,
    client.exceptions.RequestTokenNotFoundException,
    client.exceptions.ResourceConflictException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceInternalErrorException,
    client.exceptions.ServiceLimitExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.TypeNotFoundException,
    client.exceptions.UnsupportedActionException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_cloudcontrol.client import Exceptions

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

Methods

can_paginate

Check if an operation can be paginated.

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

# can_paginate method definition

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

cancel_resource_request

Cancels the specified resource operation request.

Type annotations and code completion for boto3.client("cloudcontrol").cancel_resource_request method. boto3 documentation

# cancel_resource_request method definition

def cancel_resource_request(
    self,
    *,
    RequestToken: str,
) -> CancelResourceRequestOutputTypeDef:  # (1)
    ...

1. See CancelResourceRequestOutputTypeDef

# cancel_resource_request method usage example with argument unpacking

kwargs: CancelResourceRequestInputRequestTypeDef = {  # (1)
    "RequestToken": ...,
}

parent.cancel_resource_request(**kwargs)

1. See CancelResourceRequestInputRequestTypeDef

close

Closes underlying endpoint connections.

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

# close method definition

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

create_resource

Creates the specified resource.

Type annotations and code completion for boto3.client("cloudcontrol").create_resource method. boto3 documentation

# create_resource method definition

def create_resource(
    self,
    *,
    TypeName: str,
    DesiredState: str,
    TypeVersionId: str = ...,
    RoleArn: str = ...,
    ClientToken: str = ...,
) -> CreateResourceOutputTypeDef:  # (1)
    ...

1. See CreateResourceOutputTypeDef

# create_resource method usage example with argument unpacking

kwargs: CreateResourceInputRequestTypeDef = {  # (1)
    "TypeName": ...,
    "DesiredState": ...,
}

parent.create_resource(**kwargs)

1. See CreateResourceInputRequestTypeDef

delete_resource

Deletes the specified resource.

Type annotations and code completion for boto3.client("cloudcontrol").delete_resource method. boto3 documentation

# delete_resource method definition

def delete_resource(
    self,
    *,
    TypeName: str,
    Identifier: str,
    TypeVersionId: str = ...,
    RoleArn: str = ...,
    ClientToken: str = ...,
) -> DeleteResourceOutputTypeDef:  # (1)
    ...

1. See DeleteResourceOutputTypeDef

# delete_resource method usage example with argument unpacking

kwargs: DeleteResourceInputRequestTypeDef = {  # (1)
    "TypeName": ...,
    "Identifier": ...,
}

parent.delete_resource(**kwargs)

1. See DeleteResourceInputRequestTypeDef

generate_presigned_url

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

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

Returns information about the current state of the specified resource.

Type annotations and code completion for boto3.client("cloudcontrol").get_resource method. boto3 documentation

# get_resource method definition

def get_resource(
    self,
    *,
    TypeName: str,
    Identifier: str,
    TypeVersionId: str = ...,
    RoleArn: str = ...,
) -> GetResourceOutputTypeDef:  # (1)
    ...

1. See GetResourceOutputTypeDef

# get_resource method usage example with argument unpacking

kwargs: GetResourceInputRequestTypeDef = {  # (1)
    "TypeName": ...,
    "Identifier": ...,
}

parent.get_resource(**kwargs)

1. See GetResourceInputRequestTypeDef

get_resource_request_status

Returns the current status of a resource operation request.

Type annotations and code completion for boto3.client("cloudcontrol").get_resource_request_status method. boto3 documentation

# get_resource_request_status method definition

def get_resource_request_status(
    self,
    *,
    RequestToken: str,
) -> GetResourceRequestStatusOutputTypeDef:  # (1)
    ...

1. See GetResourceRequestStatusOutputTypeDef

# get_resource_request_status method usage example with argument unpacking

kwargs: GetResourceRequestStatusInputRequestTypeDef = {  # (1)
    "RequestToken": ...,
}

parent.get_resource_request_status(**kwargs)

1. See GetResourceRequestStatusInputRequestTypeDef

list_resource_requests

Returns existing resource operation requests.

Type annotations and code completion for boto3.client("cloudcontrol").list_resource_requests method. boto3 documentation

# list_resource_requests method definition

def list_resource_requests(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    ResourceRequestStatusFilter: ResourceRequestStatusFilterTypeDef = ...,  # (1)
) -> ListResourceRequestsOutputTypeDef:  # (2)
    ...

1. See ResourceRequestStatusFilterTypeDef
2. See ListResourceRequestsOutputTypeDef

# list_resource_requests method usage example with argument unpacking

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

parent.list_resource_requests(**kwargs)

1. See ListResourceRequestsInputRequestTypeDef

list_resources

Returns information about the specified resources.

Type annotations and code completion for boto3.client("cloudcontrol").list_resources method. boto3 documentation

# list_resources method definition

def list_resources(
    self,
    *,
    TypeName: str,
    TypeVersionId: str = ...,
    RoleArn: str = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
    ResourceModel: str = ...,
) -> ListResourcesOutputTypeDef:  # (1)
    ...

1. See ListResourcesOutputTypeDef

# list_resources method usage example with argument unpacking

kwargs: ListResourcesInputRequestTypeDef = {  # (1)
    "TypeName": ...,
}

parent.list_resources(**kwargs)

1. See ListResourcesInputRequestTypeDef

update_resource

Updates the specified property values in the resource.

Type annotations and code completion for boto3.client("cloudcontrol").update_resource method. boto3 documentation

# update_resource method definition

def update_resource(
    self,
    *,
    TypeName: str,
    Identifier: str,
    PatchDocument: str,
    TypeVersionId: str = ...,
    RoleArn: str = ...,
    ClientToken: str = ...,
) -> UpdateResourceOutputTypeDef:  # (1)
    ...

1. See UpdateResourceOutputTypeDef

# update_resource method usage example with argument unpacking

kwargs: UpdateResourceInputRequestTypeDef = {  # (1)
    "TypeName": ...,
    "Identifier": ...,
    "PatchDocument": ...,
}

parent.update_resource(**kwargs)

1. See UpdateResourceInputRequestTypeDef

get_paginator

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

• client.get_paginator("list_resource_requests") -> ListResourceRequestsPaginator
• client.get_paginator("list_resources") -> ListResourcesPaginator

get_waiter

Type annotations and code completion for boto3.client("cloudcontrol").get_waiter method with overloads.

• client.get_waiter("resource_request_success") -> ResourceRequestSuccessWaiter