CloudControlApiClient

Index > CloudControlApi > CloudControlApiClient

Auto-generated documentation for CloudControlApi type annotations stubs module types-aiobotocore-cloudcontrol.

CloudControlApiClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_cloudcontrol.client import CloudControlApiClient

session = Session()
async with session.client("cloudcontrol") as client:
    client: CloudControlApiClient

Exceptions

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

Usage example

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

Type checking example

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

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 session.client("cloudcontrol").cancel_resource_request method. boto3 documentation

Method definition

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

1. See CancelResourceRequestOutputTypeDef

Usage example with kwargs

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

parent.cancel_resource_request(**kwargs)

1. See CancelResourceRequestInputRequestTypeDef

close

Closes underlying endpoint connections.

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

Method definition

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

create_resource

Creates the specified resource.

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

Method definition

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

1. See CreateResourceOutputTypeDef

Usage example with kwargs

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

parent.create_resource(**kwargs)

1. See CreateResourceInputRequestTypeDef

delete_resource

Deletes the specified resource.

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

Method definition

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

1. See DeleteResourceOutputTypeDef

Usage example with kwargs

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

Method definition

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

Method definition

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

1. See GetResourceOutputTypeDef

Usage example with kwargs

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 session.client("cloudcontrol").get_resource_request_status method. boto3 documentation

Method definition

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

1. See GetResourceRequestStatusOutputTypeDef

Usage example with kwargs

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 session.client("cloudcontrol").list_resource_requests method. boto3 documentation

Method definition

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

1. See ResourceRequestStatusFilterTypeDef
2. See ListResourceRequestsOutputTypeDef

Usage example with kwargs

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 session.client("cloudcontrol").list_resources method. boto3 documentation

Method definition

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

1. See ListResourcesOutputTypeDef

Usage example with kwargs

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

parent.list_resources(**kwargs)

1. See ListResourcesInputRequestTypeDef

update_resource

.

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

Method definition

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

1. See UpdateResourceOutputTypeDef

Usage example with kwargs

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

parent.update_resource(**kwargs)

1. See UpdateResourceInputRequestTypeDef

__aenter__

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

Method definition

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

__aexit__

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

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("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 session.client("cloudcontrol").get_waiter method with overloads.

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