CloudControlApiClient#
Index > CloudControlApi > CloudControlApiClient
Auto-generated documentation for CloudControlApi type annotations stubs module types-aiobotocore-cloudcontrol.
CloudControlApiClient#
Type annotations and code completion for session.create_client("cloudcontrol")
boto3 documentation
CloudControlApiClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_cloudcontrol.client import CloudControlApiClient
session = get_session()
async with session.create_client("cloudcontrol") as client:
client: CloudControlApiClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("cloudcontrol").exceptions
structure.
CloudControlApiClient.exceptions usage example
async with session.create_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)
CloudControlApiClient usage 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.create_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 session.create_client("cloudcontrol").cancel_resource_request
method.
boto3 documentation
# cancel_resource_request method definition
await def cancel_resource_request(
self,
*,
RequestToken: str,
) -> CancelResourceRequestOutputTypeDef: # (1)
...
# cancel_resource_request method usage example with argument unpacking
kwargs: CancelResourceRequestInputRequestTypeDef = { # (1)
"RequestToken": ...,
}
parent.cancel_resource_request(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("cloudcontrol").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
create_resource#
Creates the specified resource.
Type annotations and code completion for session.create_client("cloudcontrol").create_resource
method.
boto3 documentation
# create_resource method definition
await def create_resource(
self,
*,
TypeName: str,
DesiredState: str,
TypeVersionId: str = ...,
RoleArn: str = ...,
ClientToken: str = ...,
) -> CreateResourceOutputTypeDef: # (1)
...
# create_resource method usage example with argument unpacking
kwargs: CreateResourceInputRequestTypeDef = { # (1)
"TypeName": ...,
"DesiredState": ...,
}
parent.create_resource(**kwargs)
delete_resource#
Deletes the specified resource.
Type annotations and code completion for session.create_client("cloudcontrol").delete_resource
method.
boto3 documentation
# delete_resource method definition
await def delete_resource(
self,
*,
TypeName: str,
Identifier: str,
TypeVersionId: str = ...,
RoleArn: str = ...,
ClientToken: str = ...,
) -> DeleteResourceOutputTypeDef: # (1)
...
# delete_resource method usage example with argument unpacking
kwargs: DeleteResourceInputRequestTypeDef = { # (1)
"TypeName": ...,
"Identifier": ...,
}
parent.delete_resource(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("cloudcontrol").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_resource#
Returns information about the current state of the specified resource.
Type annotations and code completion for session.create_client("cloudcontrol").get_resource
method.
boto3 documentation
# get_resource method definition
await def get_resource(
self,
*,
TypeName: str,
Identifier: str,
TypeVersionId: str = ...,
RoleArn: str = ...,
) -> GetResourceOutputTypeDef: # (1)
...
# get_resource method usage example with argument unpacking
kwargs: GetResourceInputRequestTypeDef = { # (1)
"TypeName": ...,
"Identifier": ...,
}
parent.get_resource(**kwargs)
get_resource_request_status#
Returns the current status of a resource operation request.
Type annotations and code completion for session.create_client("cloudcontrol").get_resource_request_status
method.
boto3 documentation
# get_resource_request_status method definition
await def get_resource_request_status(
self,
*,
RequestToken: str,
) -> GetResourceRequestStatusOutputTypeDef: # (1)
...
# get_resource_request_status method usage example with argument unpacking
kwargs: GetResourceRequestStatusInputRequestTypeDef = { # (1)
"RequestToken": ...,
}
parent.get_resource_request_status(**kwargs)
list_resource_requests#
Returns existing resource operation requests.
Type annotations and code completion for session.create_client("cloudcontrol").list_resource_requests
method.
boto3 documentation
# list_resource_requests method definition
await def list_resource_requests(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
ResourceRequestStatusFilter: ResourceRequestStatusFilterTypeDef = ..., # (1)
) -> ListResourceRequestsOutputTypeDef: # (2)
...
# list_resource_requests method usage example with argument unpacking
kwargs: ListResourceRequestsInputRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_resource_requests(**kwargs)
list_resources#
Returns information about the specified resources.
Type annotations and code completion for session.create_client("cloudcontrol").list_resources
method.
boto3 documentation
# list_resources method definition
await def list_resources(
self,
*,
TypeName: str,
TypeVersionId: str = ...,
RoleArn: str = ...,
NextToken: str = ...,
MaxResults: int = ...,
ResourceModel: str = ...,
) -> ListResourcesOutputTypeDef: # (1)
...
# list_resources method usage example with argument unpacking
kwargs: ListResourcesInputRequestTypeDef = { # (1)
"TypeName": ...,
}
parent.list_resources(**kwargs)
update_resource#
Updates the specified property values in the resource.
Type annotations and code completion for session.create_client("cloudcontrol").update_resource
method.
boto3 documentation
# update_resource method definition
await def update_resource(
self,
*,
TypeName: str,
Identifier: str,
PatchDocument: str,
TypeVersionId: str = ...,
RoleArn: str = ...,
ClientToken: str = ...,
) -> UpdateResourceOutputTypeDef: # (1)
...
# update_resource method usage example with argument unpacking
kwargs: UpdateResourceInputRequestTypeDef = { # (1)
"TypeName": ...,
"Identifier": ...,
"PatchDocument": ...,
}
parent.update_resource(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("cloudcontrol").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> CloudControlApiClient:
...
__aexit__#
Type annotations and code completion for session.create_client("cloudcontrol").__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.create_client("cloudcontrol").get_paginator
method with overloads.
client.get_paginator("list_resource_requests")
-> ListResourceRequestsPaginatorclient.get_paginator("list_resources")
-> ListResourcesPaginator
get_waiter#
Type annotations and code completion for session.create_client("cloudcontrol").get_waiter
method with overloads.
client.get_waiter("resource_request_success")
-> ResourceRequestSuccessWaiter