ApiGatewayManagementApiClient#

Index > ApiGatewayManagementApi > ApiGatewayManagementApiClient

Auto-generated documentation for ApiGatewayManagementApi type annotations stubs module types-boto3-apigatewaymanagementapi.

ApiGatewayManagementApiClient#

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

# ApiGatewayManagementApiClient usage example

from boto3.session import Session
from types_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 types_boto3_apigatewaymanagementapi.client import Exceptions

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

Methods#

can_paginate#

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:
    ...

generate_presigned_url#

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:
    ...

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)
    ...

See EmptyResponseMetadataTypeDef

# delete_connection method usage example with argument unpacking

kwargs: DeleteConnectionRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

parent.delete_connection(**kwargs)

See DeleteConnectionRequestTypeDef

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)
    ...

See GetConnectionResponseTypeDef

# get_connection method usage example with argument unpacking

kwargs: GetConnectionRequestTypeDef = {  # (1)
    "ConnectionId": ...,
}

parent.get_connection(**kwargs)

See GetConnectionRequestTypeDef

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)
    ...

See EmptyResponseMetadataTypeDef

# post_to_connection method usage example with argument unpacking

kwargs: PostToConnectionRequestTypeDef = {  # (1)
    "Data": ...,
    "ConnectionId": ...,
}

parent.post_to_connection(**kwargs)

See PostToConnectionRequestTypeDef