Type definitions

Index > ApiGatewayManagementApi > Type definitions

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

BlobTypeDef

# BlobTypeDef Union usage example

from mypy_boto3_apigatewaymanagementapi.type_defs import BlobTypeDef


def get_value() -> BlobTypeDef:
    return ...


# BlobTypeDef definition

BlobTypeDef = Union[
    str,
    bytes,
    IO[Any],
    StreamingBody,
]

DeleteConnectionRequestTypeDef

# DeleteConnectionRequestTypeDef TypedDict usage example

from mypy_boto3_apigatewaymanagementapi.type_defs import DeleteConnectionRequestTypeDef


def get_value() -> DeleteConnectionRequestTypeDef:
    return {
        "ConnectionId": ...,
    }


# DeleteConnectionRequestTypeDef definition

class DeleteConnectionRequestTypeDef(TypedDict):
    ConnectionId: str,

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_apigatewaymanagementapi.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

GetConnectionRequestTypeDef

# GetConnectionRequestTypeDef TypedDict usage example

from mypy_boto3_apigatewaymanagementapi.type_defs import GetConnectionRequestTypeDef


def get_value() -> GetConnectionRequestTypeDef:
    return {
        "ConnectionId": ...,
    }


# GetConnectionRequestTypeDef definition

class GetConnectionRequestTypeDef(TypedDict):
    ConnectionId: str,

IdentityTypeDef

# IdentityTypeDef TypedDict usage example

from mypy_boto3_apigatewaymanagementapi.type_defs import IdentityTypeDef


def get_value() -> IdentityTypeDef:
    return {
        "SourceIp": ...,
    }


# IdentityTypeDef definition

class IdentityTypeDef(TypedDict):
    SourceIp: str,
    UserAgent: str,

PostToConnectionRequestTypeDef

# PostToConnectionRequestTypeDef TypedDict usage example

from mypy_boto3_apigatewaymanagementapi.type_defs import PostToConnectionRequestTypeDef


def get_value() -> PostToConnectionRequestTypeDef:
    return {
        "Data": ...,
    }


# PostToConnectionRequestTypeDef definition

class PostToConnectionRequestTypeDef(TypedDict):
    Data: BlobTypeDef,
    ConnectionId: str,

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_apigatewaymanagementapi.type_defs import EmptyResponseMetadataTypeDef


def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }


# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

GetConnectionResponseTypeDef

# GetConnectionResponseTypeDef TypedDict usage example

from mypy_boto3_apigatewaymanagementapi.type_defs import GetConnectionResponseTypeDef


def get_value() -> GetConnectionResponseTypeDef:
    return {
        "ConnectedAt": ...,
    }


# GetConnectionResponseTypeDef definition

class GetConnectionResponseTypeDef(TypedDict):
    ConnectedAt: datetime,
    Identity: IdentityTypeDef,  # (1)
    LastActiveAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See IdentityTypeDef
2. See ResponseMetadataTypeDef