ApiGatewayManagementApiClient#
Index > ApiGatewayManagementApi > ApiGatewayManagementApiClient
Auto-generated documentation for ApiGatewayManagementApi type annotations stubs module mypy-boto3-apigatewaymanagementapi.
ApiGatewayManagementApiClient#
Type annotations and code completion for boto3.client("apigatewaymanagementapi").
boto3 documentation
# ApiGatewayManagementApiClient usage example
from boto3.session import Session
from mypy_boto3_apigatewaymanagementapi.client import ApiGatewayManagementApiClient
def get_apigatewaymanagementapi_client() -> ApiGatewayManagementApiClient:
return Session().client("apigatewaymanagementapi")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("apigatewaymanagementapi").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("apigatewaymanagementapi")
try:
do_something(client)
except (
client.exceptions.ClientError,
client.exceptions.ForbiddenException,
client.exceptions.GoneException,
client.exceptions.LimitExceededException,
client.exceptions.PayloadTooLargeException,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_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 boto3.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 boto3.client("apigatewaymanagementapi").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...delete_connection#
Delete the connection with the provided id.
Type annotations and code completion for boto3.client("apigatewaymanagementapi").delete_connection method.
boto3 documentation
# delete_connection method definition
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 boto3.client("apigatewaymanagementapi").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_connection#
Get information about the connection with the provided id.
Type annotations and code completion for boto3.client("apigatewaymanagementapi").get_connection method.
boto3 documentation
# get_connection method definition
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 boto3.client("apigatewaymanagementapi").post_to_connection method.
boto3 documentation
# post_to_connection method definition
def post_to_connection(
self,
*,
Data: BlobTypeDef,
ConnectionId: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# post_to_connection method usage example with argument unpacking
kwargs: PostToConnectionRequestRequestTypeDef = { # (1)
"Data": ...,
"ConnectionId": ...,
}
parent.post_to_connection(**kwargs)