Skip to content

Type definitions#

Index > ApiGatewayManagementApi > Type definitions

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

BlobTypeDef#

# BlobTypeDef definition

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

DeleteConnectionRequestRequestTypeDef#

# DeleteConnectionRequestRequestTypeDef definition

class DeleteConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

GetConnectionRequestRequestTypeDef#

# GetConnectionRequestRequestTypeDef definition

class GetConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

IdentityTypeDef#

# IdentityTypeDef definition

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

PostToConnectionRequestRequestTypeDef#

# PostToConnectionRequestRequestTypeDef definition

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

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetConnectionResponseTypeDef#

# GetConnectionResponseTypeDef definition

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