Typed dictionaries

Index > ApiGatewayManagementApi > Typed dictionaries

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

DeleteConnectionRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewaymanagementapi.type_defs import DeleteConnectionRequestRequestTypeDef

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

Definition

class DeleteConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_apigatewaymanagementapi.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

GetConnectionRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewaymanagementapi.type_defs import GetConnectionRequestRequestTypeDef

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

Definition

class GetConnectionRequestRequestTypeDef(TypedDict):
    ConnectionId: str,

IdentityTypeDef

Usage Example

from mypy_boto3_apigatewaymanagementapi.type_defs import IdentityTypeDef

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

Definition

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

PostToConnectionRequestRequestTypeDef

Usage Example

from mypy_boto3_apigatewaymanagementapi.type_defs import PostToConnectionRequestRequestTypeDef

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

Definition

class PostToConnectionRequestRequestTypeDef(TypedDict):
    Data: Union[str, bytes, IO[Any], StreamingBody],
    ConnectionId: str,

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_apigatewaymanagementapi.type_defs import EmptyResponseMetadataTypeDef

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

Definition

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

1. See ResponseMetadataTypeDef

GetConnectionResponseTypeDef

Usage Example

from mypy_boto3_apigatewaymanagementapi.type_defs import GetConnectionResponseTypeDef

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

Definition

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

1. See IdentityTypeDef
2. See ResponseMetadataTypeDef