ApiGatewayManagementApiClient#
Index > ApiGatewayManagementApi > ApiGatewayManagementApiClient
Auto-generated documentation for ApiGatewayManagementApi type annotations stubs module types-aiobotocore-apigatewaymanagementapi.
ApiGatewayManagementApiClient#
Type annotations and code completion for session.create_client("apigatewaymanagementapi")
boto3 documentation
ApiGatewayManagementApiClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_apigatewaymanagementapi.client import ApiGatewayManagementApiClient
session = get_session()
async with session.create_client("apigatewaymanagementapi") as client:
client: ApiGatewayManagementApiClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("apigatewaymanagementapi").exceptions
structure.
ApiGatewayManagementApiClient.exceptions usage example
async with session.create_client("apigatewaymanagementapi") as client:
try:
do_something(client)
except (
client.ClientError,
client.ForbiddenException,
client.GoneException,
client.LimitExceededException,
client.PayloadTooLargeException,
) as e:
print(e)
ApiGatewayManagementApiClient usage type checking example
from types_aiobotocore_apigatewaymanagementapi.client import Exceptions
def handle_error(exc: Exceptions.ClientError) -> None:
...
Methods#
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for session.create_client("apigatewaymanagementapi").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.create_client("apigatewaymanagementapi").close
method.
boto3 documentation
# close method definition
await def close(
self,
) -> None:
...
delete_connection#
Delete the connection with the provided id.
Type annotations and code completion for session.create_client("apigatewaymanagementapi").delete_connection
method.
boto3 documentation
# delete_connection method definition
await def delete_connection(
self,
*,
ConnectionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_connection method usage example with argument unpacking
kwargs: DeleteConnectionRequestRequestTypeDef = { # (1)
"ConnectionId": ...,
}
parent.delete_connection(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("apigatewaymanagementapi").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_connection#
Get information about the connection with the provided id.
Type annotations and code completion for session.create_client("apigatewaymanagementapi").get_connection
method.
boto3 documentation
# get_connection method definition
await def get_connection(
self,
*,
ConnectionId: str,
) -> GetConnectionResponseTypeDef: # (1)
...
# get_connection method usage example with argument unpacking
kwargs: GetConnectionRequestRequestTypeDef = { # (1)
"ConnectionId": ...,
}
parent.get_connection(**kwargs)
post_to_connection#
Sends the provided data to the specified connection.
Type annotations and code completion for session.create_client("apigatewaymanagementapi").post_to_connection
method.
boto3 documentation
# post_to_connection method definition
await def post_to_connection(
self,
*,
Data: Union[str, bytes, IO[Any], StreamingBody],
ConnectionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# post_to_connection method usage example with argument unpacking
kwargs: PostToConnectionRequestRequestTypeDef = { # (1)
"Data": ...,
"ConnectionId": ...,
}
parent.post_to_connection(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("apigatewaymanagementapi").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> ApiGatewayManagementApiClient:
...
__aexit__#
Type annotations and code completion for session.create_client("apigatewaymanagementapi").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...