Typed dictionaries#
Auto-generated documentation for ivschat type annotations stubs module mypy-boto3-ivschat.
CloudWatchLogsDestinationConfigurationTypeDef#
# CloudWatchLogsDestinationConfigurationTypeDef usage example
from mypy_boto3_ivschat.type_defs import CloudWatchLogsDestinationConfigurationTypeDef
def get_value() -> CloudWatchLogsDestinationConfigurationTypeDef:
return {
"logGroupName": ...,
}
# CloudWatchLogsDestinationConfigurationTypeDef definition
class CloudWatchLogsDestinationConfigurationTypeDef(TypedDict):
logGroupName: str,
CreateChatTokenRequestRequestTypeDef#
# CreateChatTokenRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import CreateChatTokenRequestRequestTypeDef
def get_value() -> CreateChatTokenRequestRequestTypeDef:
return {
"roomIdentifier": ...,
"userId": ...,
}
# CreateChatTokenRequestRequestTypeDef definition
class CreateChatTokenRequestRequestTypeDef(TypedDict):
roomIdentifier: str,
userId: str,
attributes: NotRequired[Mapping[str, str]],
capabilities: NotRequired[Sequence[ChatTokenCapabilityType]], # (1)
sessionDurationInMinutes: NotRequired[int],
CreateChatTokenResponseTypeDef#
# CreateChatTokenResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import CreateChatTokenResponseTypeDef
def get_value() -> CreateChatTokenResponseTypeDef:
return {
"sessionExpirationTime": ...,
"token": ...,
"tokenExpirationTime": ...,
"ResponseMetadata": ...,
}
# CreateChatTokenResponseTypeDef definition
class CreateChatTokenResponseTypeDef(TypedDict):
sessionExpirationTime: datetime,
token: str,
tokenExpirationTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
MessageReviewHandlerTypeDef#
# MessageReviewHandlerTypeDef usage example
from mypy_boto3_ivschat.type_defs import MessageReviewHandlerTypeDef
def get_value() -> MessageReviewHandlerTypeDef:
return {
"fallbackResult": ...,
}
# MessageReviewHandlerTypeDef definition
class MessageReviewHandlerTypeDef(TypedDict):
fallbackResult: NotRequired[FallbackResultType], # (1)
uri: NotRequired[str],
DeleteLoggingConfigurationRequestRequestTypeDef#
# DeleteLoggingConfigurationRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import DeleteLoggingConfigurationRequestRequestTypeDef
def get_value() -> DeleteLoggingConfigurationRequestRequestTypeDef:
return {
"identifier": ...,
}
# DeleteLoggingConfigurationRequestRequestTypeDef definition
class DeleteLoggingConfigurationRequestRequestTypeDef(TypedDict):
identifier: str,
DeleteMessageRequestRequestTypeDef#
# DeleteMessageRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import DeleteMessageRequestRequestTypeDef
def get_value() -> DeleteMessageRequestRequestTypeDef:
return {
"id": ...,
"roomIdentifier": ...,
}
# DeleteMessageRequestRequestTypeDef definition
class DeleteMessageRequestRequestTypeDef(TypedDict):
id: str,
roomIdentifier: str,
reason: NotRequired[str],
DeleteMessageResponseTypeDef#
# DeleteMessageResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import DeleteMessageResponseTypeDef
def get_value() -> DeleteMessageResponseTypeDef:
return {
"id": ...,
"ResponseMetadata": ...,
}
# DeleteMessageResponseTypeDef definition
class DeleteMessageResponseTypeDef(TypedDict):
id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteRoomRequestRequestTypeDef#
# DeleteRoomRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import DeleteRoomRequestRequestTypeDef
def get_value() -> DeleteRoomRequestRequestTypeDef:
return {
"identifier": ...,
}
# DeleteRoomRequestRequestTypeDef definition
class DeleteRoomRequestRequestTypeDef(TypedDict):
identifier: str,
FirehoseDestinationConfigurationTypeDef#
# FirehoseDestinationConfigurationTypeDef usage example
from mypy_boto3_ivschat.type_defs import FirehoseDestinationConfigurationTypeDef
def get_value() -> FirehoseDestinationConfigurationTypeDef:
return {
"deliveryStreamName": ...,
}
# FirehoseDestinationConfigurationTypeDef definition
class FirehoseDestinationConfigurationTypeDef(TypedDict):
deliveryStreamName: str,
S3DestinationConfigurationTypeDef#
# S3DestinationConfigurationTypeDef usage example
from mypy_boto3_ivschat.type_defs import S3DestinationConfigurationTypeDef
def get_value() -> S3DestinationConfigurationTypeDef:
return {
"bucketName": ...,
}
# S3DestinationConfigurationTypeDef definition
class S3DestinationConfigurationTypeDef(TypedDict):
bucketName: str,
DisconnectUserRequestRequestTypeDef#
# DisconnectUserRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import DisconnectUserRequestRequestTypeDef
def get_value() -> DisconnectUserRequestRequestTypeDef:
return {
"roomIdentifier": ...,
"userId": ...,
}
# DisconnectUserRequestRequestTypeDef definition
class DisconnectUserRequestRequestTypeDef(TypedDict):
roomIdentifier: str,
userId: str,
reason: NotRequired[str],
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef usage example
from mypy_boto3_ivschat.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetLoggingConfigurationRequestRequestTypeDef#
# GetLoggingConfigurationRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import GetLoggingConfigurationRequestRequestTypeDef
def get_value() -> GetLoggingConfigurationRequestRequestTypeDef:
return {
"identifier": ...,
}
# GetLoggingConfigurationRequestRequestTypeDef definition
class GetLoggingConfigurationRequestRequestTypeDef(TypedDict):
identifier: str,
GetRoomRequestRequestTypeDef#
# GetRoomRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import GetRoomRequestRequestTypeDef
def get_value() -> GetRoomRequestRequestTypeDef:
return {
"identifier": ...,
}
# GetRoomRequestRequestTypeDef definition
class GetRoomRequestRequestTypeDef(TypedDict):
identifier: str,
ListLoggingConfigurationsRequestRequestTypeDef#
# ListLoggingConfigurationsRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import ListLoggingConfigurationsRequestRequestTypeDef
def get_value() -> ListLoggingConfigurationsRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListLoggingConfigurationsRequestRequestTypeDef definition
class ListLoggingConfigurationsRequestRequestTypeDef(TypedDict):
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListRoomsRequestRequestTypeDef#
# ListRoomsRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import ListRoomsRequestRequestTypeDef
def get_value() -> ListRoomsRequestRequestTypeDef:
return {
"loggingConfigurationIdentifier": ...,
}
# ListRoomsRequestRequestTypeDef definition
class ListRoomsRequestRequestTypeDef(TypedDict):
loggingConfigurationIdentifier: NotRequired[str],
maxResults: NotRequired[int],
messageReviewHandlerUri: NotRequired[str],
name: NotRequired[str],
nextToken: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import ListTagsForResourceResponseTypeDef
def get_value() -> ListTagsForResourceResponseTypeDef:
return {
"tags": ...,
"ResponseMetadata": ...,
}
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_ivschat.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
SendEventRequestRequestTypeDef#
# SendEventRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import SendEventRequestRequestTypeDef
def get_value() -> SendEventRequestRequestTypeDef:
return {
"eventName": ...,
"roomIdentifier": ...,
}
# SendEventRequestRequestTypeDef definition
class SendEventRequestRequestTypeDef(TypedDict):
eventName: str,
roomIdentifier: str,
attributes: NotRequired[Mapping[str, str]],
SendEventResponseTypeDef#
# SendEventResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import SendEventResponseTypeDef
def get_value() -> SendEventResponseTypeDef:
return {
"id": ...,
"ResponseMetadata": ...,
}
# SendEventResponseTypeDef definition
class SendEventResponseTypeDef(TypedDict):
id: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
CreateRoomRequestRequestTypeDef#
# CreateRoomRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import CreateRoomRequestRequestTypeDef
def get_value() -> CreateRoomRequestRequestTypeDef:
return {
"loggingConfigurationIdentifiers": ...,
}
# CreateRoomRequestRequestTypeDef definition
class CreateRoomRequestRequestTypeDef(TypedDict):
loggingConfigurationIdentifiers: NotRequired[Sequence[str]],
maximumMessageLength: NotRequired[int],
maximumMessageRatePerSecond: NotRequired[int],
messageReviewHandler: NotRequired[MessageReviewHandlerTypeDef], # (1)
name: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CreateRoomResponseTypeDef#
# CreateRoomResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import CreateRoomResponseTypeDef
def get_value() -> CreateRoomResponseTypeDef:
return {
"arn": ...,
"createTime": ...,
"id": ...,
"loggingConfigurationIdentifiers": ...,
"maximumMessageLength": ...,
"maximumMessageRatePerSecond": ...,
"messageReviewHandler": ...,
"name": ...,
"tags": ...,
"updateTime": ...,
"ResponseMetadata": ...,
}
# CreateRoomResponseTypeDef definition
class CreateRoomResponseTypeDef(TypedDict):
arn: str,
createTime: datetime,
id: str,
loggingConfigurationIdentifiers: List[str],
maximumMessageLength: int,
maximumMessageRatePerSecond: int,
messageReviewHandler: MessageReviewHandlerTypeDef, # (1)
name: str,
tags: Dict[str, str],
updateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetRoomResponseTypeDef#
# GetRoomResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import GetRoomResponseTypeDef
def get_value() -> GetRoomResponseTypeDef:
return {
"arn": ...,
"createTime": ...,
"id": ...,
"loggingConfigurationIdentifiers": ...,
"maximumMessageLength": ...,
"maximumMessageRatePerSecond": ...,
"messageReviewHandler": ...,
"name": ...,
"tags": ...,
"updateTime": ...,
"ResponseMetadata": ...,
}
# GetRoomResponseTypeDef definition
class GetRoomResponseTypeDef(TypedDict):
arn: str,
createTime: datetime,
id: str,
loggingConfigurationIdentifiers: List[str],
maximumMessageLength: int,
maximumMessageRatePerSecond: int,
messageReviewHandler: MessageReviewHandlerTypeDef, # (1)
name: str,
tags: Dict[str, str],
updateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
RoomSummaryTypeDef#
# RoomSummaryTypeDef usage example
from mypy_boto3_ivschat.type_defs import RoomSummaryTypeDef
def get_value() -> RoomSummaryTypeDef:
return {
"arn": ...,
}
# RoomSummaryTypeDef definition
class RoomSummaryTypeDef(TypedDict):
arn: NotRequired[str],
createTime: NotRequired[datetime],
id: NotRequired[str],
loggingConfigurationIdentifiers: NotRequired[List[str]],
messageReviewHandler: NotRequired[MessageReviewHandlerTypeDef], # (1)
name: NotRequired[str],
tags: NotRequired[Dict[str, str]],
updateTime: NotRequired[datetime],
UpdateRoomRequestRequestTypeDef#
# UpdateRoomRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import UpdateRoomRequestRequestTypeDef
def get_value() -> UpdateRoomRequestRequestTypeDef:
return {
"identifier": ...,
}
# UpdateRoomRequestRequestTypeDef definition
class UpdateRoomRequestRequestTypeDef(TypedDict):
identifier: str,
loggingConfigurationIdentifiers: NotRequired[Sequence[str]],
maximumMessageLength: NotRequired[int],
maximumMessageRatePerSecond: NotRequired[int],
messageReviewHandler: NotRequired[MessageReviewHandlerTypeDef], # (1)
name: NotRequired[str],
UpdateRoomResponseTypeDef#
# UpdateRoomResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import UpdateRoomResponseTypeDef
def get_value() -> UpdateRoomResponseTypeDef:
return {
"arn": ...,
"createTime": ...,
"id": ...,
"loggingConfigurationIdentifiers": ...,
"maximumMessageLength": ...,
"maximumMessageRatePerSecond": ...,
"messageReviewHandler": ...,
"name": ...,
"tags": ...,
"updateTime": ...,
"ResponseMetadata": ...,
}
# UpdateRoomResponseTypeDef definition
class UpdateRoomResponseTypeDef(TypedDict):
arn: str,
createTime: datetime,
id: str,
loggingConfigurationIdentifiers: List[str],
maximumMessageLength: int,
maximumMessageRatePerSecond: int,
messageReviewHandler: MessageReviewHandlerTypeDef, # (1)
name: str,
tags: Dict[str, str],
updateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DestinationConfigurationTypeDef#
# DestinationConfigurationTypeDef usage example
from mypy_boto3_ivschat.type_defs import DestinationConfigurationTypeDef
def get_value() -> DestinationConfigurationTypeDef:
return {
"cloudWatchLogs": ...,
}
# DestinationConfigurationTypeDef definition
class DestinationConfigurationTypeDef(TypedDict):
cloudWatchLogs: NotRequired[CloudWatchLogsDestinationConfigurationTypeDef], # (1)
firehose: NotRequired[FirehoseDestinationConfigurationTypeDef], # (2)
s3: NotRequired[S3DestinationConfigurationTypeDef], # (3)
- See CloudWatchLogsDestinationConfigurationTypeDef
- See FirehoseDestinationConfigurationTypeDef
- See S3DestinationConfigurationTypeDef
ListRoomsResponseTypeDef#
# ListRoomsResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import ListRoomsResponseTypeDef
def get_value() -> ListRoomsResponseTypeDef:
return {
"nextToken": ...,
"rooms": ...,
"ResponseMetadata": ...,
}
# ListRoomsResponseTypeDef definition
class ListRoomsResponseTypeDef(TypedDict):
nextToken: str,
rooms: List[RoomSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateLoggingConfigurationRequestRequestTypeDef#
# CreateLoggingConfigurationRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import CreateLoggingConfigurationRequestRequestTypeDef
def get_value() -> CreateLoggingConfigurationRequestRequestTypeDef:
return {
"destinationConfiguration": ...,
}
# CreateLoggingConfigurationRequestRequestTypeDef definition
class CreateLoggingConfigurationRequestRequestTypeDef(TypedDict):
destinationConfiguration: DestinationConfigurationTypeDef, # (1)
name: NotRequired[str],
tags: NotRequired[Mapping[str, str]],
CreateLoggingConfigurationResponseTypeDef#
# CreateLoggingConfigurationResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import CreateLoggingConfigurationResponseTypeDef
def get_value() -> CreateLoggingConfigurationResponseTypeDef:
return {
"arn": ...,
"createTime": ...,
"destinationConfiguration": ...,
"id": ...,
"name": ...,
"state": ...,
"tags": ...,
"updateTime": ...,
"ResponseMetadata": ...,
}
# CreateLoggingConfigurationResponseTypeDef definition
class CreateLoggingConfigurationResponseTypeDef(TypedDict):
arn: str,
createTime: datetime,
destinationConfiguration: DestinationConfigurationTypeDef, # (1)
id: str,
name: str,
state: CreateLoggingConfigurationStateType, # (2)
tags: Dict[str, str],
updateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See DestinationConfigurationTypeDef
- See CreateLoggingConfigurationStateType
- See ResponseMetadataTypeDef
GetLoggingConfigurationResponseTypeDef#
# GetLoggingConfigurationResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import GetLoggingConfigurationResponseTypeDef
def get_value() -> GetLoggingConfigurationResponseTypeDef:
return {
"arn": ...,
"createTime": ...,
"destinationConfiguration": ...,
"id": ...,
"name": ...,
"state": ...,
"tags": ...,
"updateTime": ...,
"ResponseMetadata": ...,
}
# GetLoggingConfigurationResponseTypeDef definition
class GetLoggingConfigurationResponseTypeDef(TypedDict):
arn: str,
createTime: datetime,
destinationConfiguration: DestinationConfigurationTypeDef, # (1)
id: str,
name: str,
state: LoggingConfigurationStateType, # (2)
tags: Dict[str, str],
updateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
LoggingConfigurationSummaryTypeDef#
# LoggingConfigurationSummaryTypeDef usage example
from mypy_boto3_ivschat.type_defs import LoggingConfigurationSummaryTypeDef
def get_value() -> LoggingConfigurationSummaryTypeDef:
return {
"arn": ...,
}
# LoggingConfigurationSummaryTypeDef definition
class LoggingConfigurationSummaryTypeDef(TypedDict):
arn: NotRequired[str],
createTime: NotRequired[datetime],
destinationConfiguration: NotRequired[DestinationConfigurationTypeDef], # (1)
id: NotRequired[str],
name: NotRequired[str],
state: NotRequired[LoggingConfigurationStateType], # (2)
tags: NotRequired[Dict[str, str]],
updateTime: NotRequired[datetime],
UpdateLoggingConfigurationRequestRequestTypeDef#
# UpdateLoggingConfigurationRequestRequestTypeDef usage example
from mypy_boto3_ivschat.type_defs import UpdateLoggingConfigurationRequestRequestTypeDef
def get_value() -> UpdateLoggingConfigurationRequestRequestTypeDef:
return {
"identifier": ...,
}
# UpdateLoggingConfigurationRequestRequestTypeDef definition
class UpdateLoggingConfigurationRequestRequestTypeDef(TypedDict):
identifier: str,
destinationConfiguration: NotRequired[DestinationConfigurationTypeDef], # (1)
name: NotRequired[str],
UpdateLoggingConfigurationResponseTypeDef#
# UpdateLoggingConfigurationResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import UpdateLoggingConfigurationResponseTypeDef
def get_value() -> UpdateLoggingConfigurationResponseTypeDef:
return {
"arn": ...,
"createTime": ...,
"destinationConfiguration": ...,
"id": ...,
"name": ...,
"state": ...,
"tags": ...,
"updateTime": ...,
"ResponseMetadata": ...,
}
# UpdateLoggingConfigurationResponseTypeDef definition
class UpdateLoggingConfigurationResponseTypeDef(TypedDict):
arn: str,
createTime: datetime,
destinationConfiguration: DestinationConfigurationTypeDef, # (1)
id: str,
name: str,
state: UpdateLoggingConfigurationStateType, # (2)
tags: Dict[str, str],
updateTime: datetime,
ResponseMetadata: ResponseMetadataTypeDef, # (3)
- See DestinationConfigurationTypeDef
- See UpdateLoggingConfigurationStateType
- See ResponseMetadataTypeDef
ListLoggingConfigurationsResponseTypeDef#
# ListLoggingConfigurationsResponseTypeDef usage example
from mypy_boto3_ivschat.type_defs import ListLoggingConfigurationsResponseTypeDef
def get_value() -> ListLoggingConfigurationsResponseTypeDef:
return {
"loggingConfigurations": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListLoggingConfigurationsResponseTypeDef definition
class ListLoggingConfigurationsResponseTypeDef(TypedDict):
loggingConfigurations: List[LoggingConfigurationSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)