Skip to content

Typed dictionaries

Index > ivschat > Typed dictionaries

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

CreateChatTokenRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import CreateChatTokenRequestRequestTypeDef

def get_value() -> CreateChatTokenRequestRequestTypeDef:
    return {
        "roomIdentifier": ...,
        "userId": ...,
    }
Definition
class CreateChatTokenRequestRequestTypeDef(TypedDict):
    roomIdentifier: str,
    userId: str,
    attributes: NotRequired[Mapping[str, str]],
    capabilities: NotRequired[Sequence[ChatTokenCapabilityType]],  # (1)
    sessionDurationInMinutes: NotRequired[int],
  1. See ChatTokenCapabilityType

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_ivschat.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,

MessageReviewHandlerTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import MessageReviewHandlerTypeDef

def get_value() -> MessageReviewHandlerTypeDef:
    return {
        "fallbackResult": ...,
    }
Definition
class MessageReviewHandlerTypeDef(TypedDict):
    fallbackResult: NotRequired[FallbackResultType],  # (1)
    uri: NotRequired[str],
  1. See FallbackResultType

DeleteMessageRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import DeleteMessageRequestRequestTypeDef

def get_value() -> DeleteMessageRequestRequestTypeDef:
    return {
        "id": ...,
        "roomIdentifier": ...,
    }
Definition
class DeleteMessageRequestRequestTypeDef(TypedDict):
    id: str,
    roomIdentifier: str,
    reason: NotRequired[str],

DeleteRoomRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import DeleteRoomRequestRequestTypeDef

def get_value() -> DeleteRoomRequestRequestTypeDef:
    return {
        "identifier": ...,
    }
Definition
class DeleteRoomRequestRequestTypeDef(TypedDict):
    identifier: str,

DisconnectUserRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import DisconnectUserRequestRequestTypeDef

def get_value() -> DisconnectUserRequestRequestTypeDef:
    return {
        "roomIdentifier": ...,
        "userId": ...,
    }
Definition
class DisconnectUserRequestRequestTypeDef(TypedDict):
    roomIdentifier: str,
    userId: str,
    reason: NotRequired[str],

GetRoomRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import GetRoomRequestRequestTypeDef

def get_value() -> GetRoomRequestRequestTypeDef:
    return {
        "identifier": ...,
    }
Definition
class GetRoomRequestRequestTypeDef(TypedDict):
    identifier: str,

ListRoomsRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import ListRoomsRequestRequestTypeDef

def get_value() -> ListRoomsRequestRequestTypeDef:
    return {
        "maxResults": ...,
    }
Definition
class ListRoomsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    messageReviewHandlerUri: NotRequired[str],
    name: NotRequired[str],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
Definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

SendEventRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import SendEventRequestRequestTypeDef

def get_value() -> SendEventRequestRequestTypeDef:
    return {
        "eventName": ...,
        "roomIdentifier": ...,
    }
Definition
class SendEventRequestRequestTypeDef(TypedDict):
    eventName: str,
    roomIdentifier: str,
    attributes: NotRequired[Mapping[str, str]],

TagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

CreateChatTokenResponseTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import CreateChatTokenResponseTypeDef

def get_value() -> CreateChatTokenResponseTypeDef:
    return {
        "sessionExpirationTime": ...,
        "token": ...,
        "tokenExpirationTime": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateChatTokenResponseTypeDef(TypedDict):
    sessionExpirationTime: datetime,
    token: str,
    tokenExpirationTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteMessageResponseTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import DeleteMessageResponseTypeDef

def get_value() -> DeleteMessageResponseTypeDef:
    return {
        "id": ...,
        "ResponseMetadata": ...,
    }
Definition
class DeleteMessageResponseTypeDef(TypedDict):
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }
Definition
class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import ListTagsForResourceResponseTypeDef

def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SendEventResponseTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import SendEventResponseTypeDef

def get_value() -> SendEventResponseTypeDef:
    return {
        "id": ...,
        "ResponseMetadata": ...,
    }
Definition
class SendEventResponseTypeDef(TypedDict):
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRoomRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import CreateRoomRequestRequestTypeDef

def get_value() -> CreateRoomRequestRequestTypeDef:
    return {
        "maximumMessageLength": ...,
    }
Definition
class CreateRoomRequestRequestTypeDef(TypedDict):
    maximumMessageLength: NotRequired[int],
    maximumMessageRatePerSecond: NotRequired[int],
    messageReviewHandler: NotRequired[MessageReviewHandlerTypeDef],  # (1)
    name: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See MessageReviewHandlerTypeDef

CreateRoomResponseTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import CreateRoomResponseTypeDef

def get_value() -> CreateRoomResponseTypeDef:
    return {
        "arn": ...,
        "createTime": ...,
        "id": ...,
        "maximumMessageLength": ...,
        "maximumMessageRatePerSecond": ...,
        "messageReviewHandler": ...,
        "name": ...,
        "tags": ...,
        "updateTime": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateRoomResponseTypeDef(TypedDict):
    arn: str,
    createTime: datetime,
    id: str,
    maximumMessageLength: int,
    maximumMessageRatePerSecond: int,
    messageReviewHandler: MessageReviewHandlerTypeDef,  # (1)
    name: str,
    tags: Dict[str, str],
    updateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageReviewHandlerTypeDef
  2. See ResponseMetadataTypeDef

GetRoomResponseTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import GetRoomResponseTypeDef

def get_value() -> GetRoomResponseTypeDef:
    return {
        "arn": ...,
        "createTime": ...,
        "id": ...,
        "maximumMessageLength": ...,
        "maximumMessageRatePerSecond": ...,
        "messageReviewHandler": ...,
        "name": ...,
        "tags": ...,
        "updateTime": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetRoomResponseTypeDef(TypedDict):
    arn: str,
    createTime: datetime,
    id: str,
    maximumMessageLength: int,
    maximumMessageRatePerSecond: int,
    messageReviewHandler: MessageReviewHandlerTypeDef,  # (1)
    name: str,
    tags: Dict[str, str],
    updateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageReviewHandlerTypeDef
  2. See ResponseMetadataTypeDef

RoomSummaryTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import RoomSummaryTypeDef

def get_value() -> RoomSummaryTypeDef:
    return {
        "arn": ...,
    }
Definition
class RoomSummaryTypeDef(TypedDict):
    arn: NotRequired[str],
    createTime: NotRequired[datetime],
    id: NotRequired[str],
    messageReviewHandler: NotRequired[MessageReviewHandlerTypeDef],  # (1)
    name: NotRequired[str],
    tags: NotRequired[Dict[str, str]],
    updateTime: NotRequired[datetime],
  1. See MessageReviewHandlerTypeDef

UpdateRoomRequestRequestTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import UpdateRoomRequestRequestTypeDef

def get_value() -> UpdateRoomRequestRequestTypeDef:
    return {
        "identifier": ...,
    }
Definition
class UpdateRoomRequestRequestTypeDef(TypedDict):
    identifier: str,
    maximumMessageLength: NotRequired[int],
    maximumMessageRatePerSecond: NotRequired[int],
    messageReviewHandler: NotRequired[MessageReviewHandlerTypeDef],  # (1)
    name: NotRequired[str],
  1. See MessageReviewHandlerTypeDef

UpdateRoomResponseTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import UpdateRoomResponseTypeDef

def get_value() -> UpdateRoomResponseTypeDef:
    return {
        "arn": ...,
        "createTime": ...,
        "id": ...,
        "maximumMessageLength": ...,
        "maximumMessageRatePerSecond": ...,
        "messageReviewHandler": ...,
        "name": ...,
        "tags": ...,
        "updateTime": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateRoomResponseTypeDef(TypedDict):
    arn: str,
    createTime: datetime,
    id: str,
    maximumMessageLength: int,
    maximumMessageRatePerSecond: int,
    messageReviewHandler: MessageReviewHandlerTypeDef,  # (1)
    name: str,
    tags: Dict[str, str],
    updateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageReviewHandlerTypeDef
  2. See ResponseMetadataTypeDef

ListRoomsResponseTypeDef

Usage Example
from mypy_boto3_ivschat.type_defs import ListRoomsResponseTypeDef

def get_value() -> ListRoomsResponseTypeDef:
    return {
        "nextToken": ...,
        "rooms": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListRoomsResponseTypeDef(TypedDict):
    nextToken: str,
    rooms: List[RoomSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RoomSummaryTypeDef
  2. See ResponseMetadataTypeDef