Skip to content

Type definitions#

Index > Ivschat > Type definitions

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

CloudWatchLogsDestinationConfigurationTypeDef#

# CloudWatchLogsDestinationConfigurationTypeDef definition

class CloudWatchLogsDestinationConfigurationTypeDef(TypedDict):
    logGroupName: str,

CreateChatTokenRequestRequestTypeDef#

# CreateChatTokenRequestRequestTypeDef definition

class CreateChatTokenRequestRequestTypeDef(TypedDict):
    roomIdentifier: str,
    userId: str,
    capabilities: NotRequired[Sequence[ChatTokenCapabilityType]],  # (1)
    sessionDurationInMinutes: NotRequired[int],
    attributes: NotRequired[Mapping[str, str]],
  1. See ChatTokenCapabilityType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

MessageReviewHandlerTypeDef#

# MessageReviewHandlerTypeDef definition

class MessageReviewHandlerTypeDef(TypedDict):
    uri: NotRequired[str],
    fallbackResult: NotRequired[FallbackResultType],  # (1)
  1. See FallbackResultType

DeleteLoggingConfigurationRequestRequestTypeDef#

# DeleteLoggingConfigurationRequestRequestTypeDef definition

class DeleteLoggingConfigurationRequestRequestTypeDef(TypedDict):
    identifier: str,

DeleteMessageRequestRequestTypeDef#

# DeleteMessageRequestRequestTypeDef definition

class DeleteMessageRequestRequestTypeDef(TypedDict):
    roomIdentifier: str,
    id: str,
    reason: NotRequired[str],

DeleteRoomRequestRequestTypeDef#

# DeleteRoomRequestRequestTypeDef definition

class DeleteRoomRequestRequestTypeDef(TypedDict):
    identifier: str,

FirehoseDestinationConfigurationTypeDef#

# FirehoseDestinationConfigurationTypeDef definition

class FirehoseDestinationConfigurationTypeDef(TypedDict):
    deliveryStreamName: str,

S3DestinationConfigurationTypeDef#

# S3DestinationConfigurationTypeDef definition

class S3DestinationConfigurationTypeDef(TypedDict):
    bucketName: str,

DisconnectUserRequestRequestTypeDef#

# DisconnectUserRequestRequestTypeDef definition

class DisconnectUserRequestRequestTypeDef(TypedDict):
    roomIdentifier: str,
    userId: str,
    reason: NotRequired[str],

GetLoggingConfigurationRequestRequestTypeDef#

# GetLoggingConfigurationRequestRequestTypeDef definition

class GetLoggingConfigurationRequestRequestTypeDef(TypedDict):
    identifier: str,

GetRoomRequestRequestTypeDef#

# GetRoomRequestRequestTypeDef definition

class GetRoomRequestRequestTypeDef(TypedDict):
    identifier: str,

ListLoggingConfigurationsRequestRequestTypeDef#

# ListLoggingConfigurationsRequestRequestTypeDef definition

class ListLoggingConfigurationsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListRoomsRequestRequestTypeDef#

# ListRoomsRequestRequestTypeDef definition

class ListRoomsRequestRequestTypeDef(TypedDict):
    name: NotRequired[str],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    messageReviewHandlerUri: NotRequired[str],
    loggingConfigurationIdentifier: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

SendEventRequestRequestTypeDef#

# SendEventRequestRequestTypeDef definition

class SendEventRequestRequestTypeDef(TypedDict):
    roomIdentifier: str,
    eventName: str,
    attributes: NotRequired[Mapping[str, str]],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

CreateChatTokenResponseTypeDef#

# CreateChatTokenResponseTypeDef definition

class CreateChatTokenResponseTypeDef(TypedDict):
    token: str,
    tokenExpirationTime: datetime,
    sessionExpirationTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteMessageResponseTypeDef#

# DeleteMessageResponseTypeDef definition

class DeleteMessageResponseTypeDef(TypedDict):
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SendEventResponseTypeDef#

# SendEventResponseTypeDef definition

class SendEventResponseTypeDef(TypedDict):
    id: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRoomRequestRequestTypeDef#

# CreateRoomRequestRequestTypeDef definition

class CreateRoomRequestRequestTypeDef(TypedDict):
    name: NotRequired[str],
    maximumMessageRatePerSecond: NotRequired[int],
    maximumMessageLength: NotRequired[int],
    messageReviewHandler: NotRequired[MessageReviewHandlerTypeDef],  # (1)
    tags: NotRequired[Mapping[str, str]],
    loggingConfigurationIdentifiers: NotRequired[Sequence[str]],
  1. See MessageReviewHandlerTypeDef

CreateRoomResponseTypeDef#

# CreateRoomResponseTypeDef definition

class CreateRoomResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    createTime: datetime,
    updateTime: datetime,
    maximumMessageRatePerSecond: int,
    maximumMessageLength: int,
    messageReviewHandler: MessageReviewHandlerTypeDef,  # (1)
    tags: dict[str, str],
    loggingConfigurationIdentifiers: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageReviewHandlerTypeDef
  2. See ResponseMetadataTypeDef

GetRoomResponseTypeDef#

# GetRoomResponseTypeDef definition

class GetRoomResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    createTime: datetime,
    updateTime: datetime,
    maximumMessageRatePerSecond: int,
    maximumMessageLength: int,
    messageReviewHandler: MessageReviewHandlerTypeDef,  # (1)
    tags: dict[str, str],
    loggingConfigurationIdentifiers: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageReviewHandlerTypeDef
  2. See ResponseMetadataTypeDef

RoomSummaryTypeDef#

# RoomSummaryTypeDef definition

class RoomSummaryTypeDef(TypedDict):
    arn: NotRequired[str],
    id: NotRequired[str],
    name: NotRequired[str],
    messageReviewHandler: NotRequired[MessageReviewHandlerTypeDef],  # (1)
    createTime: NotRequired[datetime],
    updateTime: NotRequired[datetime],
    tags: NotRequired[dict[str, str]],
    loggingConfigurationIdentifiers: NotRequired[list[str]],
  1. See MessageReviewHandlerTypeDef

UpdateRoomRequestRequestTypeDef#

# UpdateRoomRequestRequestTypeDef definition

class UpdateRoomRequestRequestTypeDef(TypedDict):
    identifier: str,
    name: NotRequired[str],
    maximumMessageRatePerSecond: NotRequired[int],
    maximumMessageLength: NotRequired[int],
    messageReviewHandler: NotRequired[MessageReviewHandlerTypeDef],  # (1)
    loggingConfigurationIdentifiers: NotRequired[Sequence[str]],
  1. See MessageReviewHandlerTypeDef

UpdateRoomResponseTypeDef#

# UpdateRoomResponseTypeDef definition

class UpdateRoomResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    name: str,
    createTime: datetime,
    updateTime: datetime,
    maximumMessageRatePerSecond: int,
    maximumMessageLength: int,
    messageReviewHandler: MessageReviewHandlerTypeDef,  # (1)
    tags: dict[str, str],
    loggingConfigurationIdentifiers: list[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MessageReviewHandlerTypeDef
  2. See ResponseMetadataTypeDef

DestinationConfigurationTypeDef#

# DestinationConfigurationTypeDef definition

class DestinationConfigurationTypeDef(TypedDict):
    s3: NotRequired[S3DestinationConfigurationTypeDef],  # (1)
    cloudWatchLogs: NotRequired[CloudWatchLogsDestinationConfigurationTypeDef],  # (2)
    firehose: NotRequired[FirehoseDestinationConfigurationTypeDef],  # (3)
  1. See S3DestinationConfigurationTypeDef
  2. See CloudWatchLogsDestinationConfigurationTypeDef
  3. See FirehoseDestinationConfigurationTypeDef

ListRoomsResponseTypeDef#

# ListRoomsResponseTypeDef definition

class ListRoomsResponseTypeDef(TypedDict):
    rooms: list[RoomSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See RoomSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateLoggingConfigurationRequestRequestTypeDef#

# CreateLoggingConfigurationRequestRequestTypeDef definition

class CreateLoggingConfigurationRequestRequestTypeDef(TypedDict):
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    name: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See DestinationConfigurationTypeDef

CreateLoggingConfigurationResponseTypeDef#

# CreateLoggingConfigurationResponseTypeDef definition

class CreateLoggingConfigurationResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    createTime: datetime,
    updateTime: datetime,
    name: str,
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    state: CreateLoggingConfigurationStateType,  # (2)
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DestinationConfigurationTypeDef
  2. See CreateLoggingConfigurationStateType
  3. See ResponseMetadataTypeDef

GetLoggingConfigurationResponseTypeDef#

# GetLoggingConfigurationResponseTypeDef definition

class GetLoggingConfigurationResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    createTime: datetime,
    updateTime: datetime,
    name: str,
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    state: LoggingConfigurationStateType,  # (2)
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DestinationConfigurationTypeDef
  2. See LoggingConfigurationStateType
  3. See ResponseMetadataTypeDef

LoggingConfigurationSummaryTypeDef#

# LoggingConfigurationSummaryTypeDef definition

class LoggingConfigurationSummaryTypeDef(TypedDict):
    arn: NotRequired[str],
    id: NotRequired[str],
    createTime: NotRequired[datetime],
    updateTime: NotRequired[datetime],
    name: NotRequired[str],
    destinationConfiguration: NotRequired[DestinationConfigurationTypeDef],  # (1)
    state: NotRequired[LoggingConfigurationStateType],  # (2)
    tags: NotRequired[dict[str, str]],
  1. See DestinationConfigurationTypeDef
  2. See LoggingConfigurationStateType

UpdateLoggingConfigurationRequestRequestTypeDef#

# UpdateLoggingConfigurationRequestRequestTypeDef definition

class UpdateLoggingConfigurationRequestRequestTypeDef(TypedDict):
    identifier: str,
    name: NotRequired[str],
    destinationConfiguration: NotRequired[DestinationConfigurationTypeDef],  # (1)
  1. See DestinationConfigurationTypeDef

UpdateLoggingConfigurationResponseTypeDef#

# UpdateLoggingConfigurationResponseTypeDef definition

class UpdateLoggingConfigurationResponseTypeDef(TypedDict):
    arn: str,
    id: str,
    createTime: datetime,
    updateTime: datetime,
    name: str,
    destinationConfiguration: DestinationConfigurationTypeDef,  # (1)
    state: UpdateLoggingConfigurationStateType,  # (2)
    tags: dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See DestinationConfigurationTypeDef
  2. See UpdateLoggingConfigurationStateType
  3. See ResponseMetadataTypeDef

ListLoggingConfigurationsResponseTypeDef#

# ListLoggingConfigurationsResponseTypeDef definition

class ListLoggingConfigurationsResponseTypeDef(TypedDict):
    loggingConfigurations: list[LoggingConfigurationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See LoggingConfigurationSummaryTypeDef
  2. See ResponseMetadataTypeDef