Typed dictionaries
Index > ConnectParticipant > Typed dictionaries
Auto-generated documentation for ConnectParticipant type annotations stubs module mypy-boto3-connectparticipant.
AttachmentItemTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import AttachmentItemTypeDef
def get_value() -> AttachmentItemTypeDef:
return {
"ContentType": ...,
}
Definition
class AttachmentItemTypeDef(TypedDict):
ContentType: NotRequired[str],
AttachmentId: NotRequired[str],
AttachmentName: NotRequired[str],
Status: NotRequired[ArtifactStatusType], # (1)
CompleteAttachmentUploadRequestRequestTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import CompleteAttachmentUploadRequestRequestTypeDef
def get_value() -> CompleteAttachmentUploadRequestRequestTypeDef:
return {
"AttachmentIds": ...,
"ClientToken": ...,
"ConnectionToken": ...,
}
Definition
class CompleteAttachmentUploadRequestRequestTypeDef(TypedDict):
AttachmentIds: Sequence[str],
ClientToken: str,
ConnectionToken: str,
ConnectionCredentialsTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import ConnectionCredentialsTypeDef
def get_value() -> ConnectionCredentialsTypeDef:
return {
"ConnectionToken": ...,
}
Definition
class ConnectionCredentialsTypeDef(TypedDict):
ConnectionToken: NotRequired[str],
Expiry: NotRequired[str],
CreateParticipantConnectionRequestRequestTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import CreateParticipantConnectionRequestRequestTypeDef
def get_value() -> CreateParticipantConnectionRequestRequestTypeDef:
return {
"ParticipantToken": ...,
}
Definition
class CreateParticipantConnectionRequestRequestTypeDef(TypedDict):
ParticipantToken: str,
Type: NotRequired[Sequence[ConnectionTypeType]], # (1)
ConnectParticipant: NotRequired[bool],
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_connectparticipant.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,
WebsocketTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import WebsocketTypeDef
def get_value() -> WebsocketTypeDef:
return {
"Url": ...,
}
Definition
class WebsocketTypeDef(TypedDict):
Url: NotRequired[str],
ConnectionExpiry: NotRequired[str],
DisconnectParticipantRequestRequestTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import DisconnectParticipantRequestRequestTypeDef
def get_value() -> DisconnectParticipantRequestRequestTypeDef:
return {
"ConnectionToken": ...,
}
Definition
class DisconnectParticipantRequestRequestTypeDef(TypedDict):
ConnectionToken: str,
ClientToken: NotRequired[str],
GetAttachmentRequestRequestTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import GetAttachmentRequestRequestTypeDef
def get_value() -> GetAttachmentRequestRequestTypeDef:
return {
"AttachmentId": ...,
"ConnectionToken": ...,
}
Definition
class GetAttachmentRequestRequestTypeDef(TypedDict):
AttachmentId: str,
ConnectionToken: str,
StartPositionTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import StartPositionTypeDef
def get_value() -> StartPositionTypeDef:
return {
"Id": ...,
}
Definition
class StartPositionTypeDef(TypedDict):
Id: NotRequired[str],
AbsoluteTime: NotRequired[str],
MostRecent: NotRequired[int],
ReceiptTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import ReceiptTypeDef
def get_value() -> ReceiptTypeDef:
return {
"DeliveredTimestamp": ...,
}
Definition
class ReceiptTypeDef(TypedDict):
DeliveredTimestamp: NotRequired[str],
ReadTimestamp: NotRequired[str],
RecipientParticipantId: NotRequired[str],
SendEventRequestRequestTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import SendEventRequestRequestTypeDef
def get_value() -> SendEventRequestRequestTypeDef:
return {
"ContentType": ...,
"ConnectionToken": ...,
}
Definition
class SendEventRequestRequestTypeDef(TypedDict):
ContentType: str,
ConnectionToken: str,
Content: NotRequired[str],
ClientToken: NotRequired[str],
SendMessageRequestRequestTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import SendMessageRequestRequestTypeDef
def get_value() -> SendMessageRequestRequestTypeDef:
return {
"ContentType": ...,
"Content": ...,
"ConnectionToken": ...,
}
Definition
class SendMessageRequestRequestTypeDef(TypedDict):
ContentType: str,
Content: str,
ConnectionToken: str,
ClientToken: NotRequired[str],
StartAttachmentUploadRequestRequestTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import StartAttachmentUploadRequestRequestTypeDef
def get_value() -> StartAttachmentUploadRequestRequestTypeDef:
return {
"ContentType": ...,
"AttachmentSizeInBytes": ...,
"AttachmentName": ...,
"ClientToken": ...,
"ConnectionToken": ...,
}
Definition
class StartAttachmentUploadRequestRequestTypeDef(TypedDict):
ContentType: str,
AttachmentSizeInBytes: int,
AttachmentName: str,
ClientToken: str,
ConnectionToken: str,
UploadMetadataTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import UploadMetadataTypeDef
def get_value() -> UploadMetadataTypeDef:
return {
"Url": ...,
}
Definition
class UploadMetadataTypeDef(TypedDict):
Url: NotRequired[str],
UrlExpiry: NotRequired[str],
HeadersToInclude: NotRequired[Dict[str, str]],
GetAttachmentResponseTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import GetAttachmentResponseTypeDef
def get_value() -> GetAttachmentResponseTypeDef:
return {
"Url": ...,
"UrlExpiry": ...,
"ResponseMetadata": ...,
}
Definition
class GetAttachmentResponseTypeDef(TypedDict):
Url: str,
UrlExpiry: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SendEventResponseTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import SendEventResponseTypeDef
def get_value() -> SendEventResponseTypeDef:
return {
"Id": ...,
"AbsoluteTime": ...,
"ResponseMetadata": ...,
}
Definition
class SendEventResponseTypeDef(TypedDict):
Id: str,
AbsoluteTime: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
SendMessageResponseTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import SendMessageResponseTypeDef
def get_value() -> SendMessageResponseTypeDef:
return {
"Id": ...,
"AbsoluteTime": ...,
"ResponseMetadata": ...,
}
Definition
class SendMessageResponseTypeDef(TypedDict):
Id: str,
AbsoluteTime: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateParticipantConnectionResponseTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import CreateParticipantConnectionResponseTypeDef
def get_value() -> CreateParticipantConnectionResponseTypeDef:
return {
"Websocket": ...,
"ConnectionCredentials": ...,
"ResponseMetadata": ...,
}
Definition
class CreateParticipantConnectionResponseTypeDef(TypedDict):
Websocket: WebsocketTypeDef, # (1)
ConnectionCredentials: ConnectionCredentialsTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetTranscriptRequestRequestTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import GetTranscriptRequestRequestTypeDef
def get_value() -> GetTranscriptRequestRequestTypeDef:
return {
"ConnectionToken": ...,
}
Definition
class GetTranscriptRequestRequestTypeDef(TypedDict):
ConnectionToken: str,
ContactId: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ScanDirection: NotRequired[ScanDirectionType], # (1)
SortOrder: NotRequired[SortKeyType], # (2)
StartPosition: NotRequired[StartPositionTypeDef], # (3)
- See ScanDirectionType
- See SortKeyType
- See StartPositionTypeDef
MessageMetadataTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import MessageMetadataTypeDef
def get_value() -> MessageMetadataTypeDef:
return {
"MessageId": ...,
}
Definition
class MessageMetadataTypeDef(TypedDict):
MessageId: NotRequired[str],
Receipts: NotRequired[List[ReceiptTypeDef]], # (1)
- See ReceiptTypeDef
StartAttachmentUploadResponseTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import StartAttachmentUploadResponseTypeDef
def get_value() -> StartAttachmentUploadResponseTypeDef:
return {
"AttachmentId": ...,
"UploadMetadata": ...,
"ResponseMetadata": ...,
}
Definition
class StartAttachmentUploadResponseTypeDef(TypedDict):
AttachmentId: str,
UploadMetadata: UploadMetadataTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ItemTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import ItemTypeDef
def get_value() -> ItemTypeDef:
return {
"AbsoluteTime": ...,
}
Definition
class ItemTypeDef(TypedDict):
AbsoluteTime: NotRequired[str],
Content: NotRequired[str],
ContentType: NotRequired[str],
Id: NotRequired[str],
Type: NotRequired[ChatItemTypeType], # (1)
ParticipantId: NotRequired[str],
DisplayName: NotRequired[str],
ParticipantRole: NotRequired[ParticipantRoleType], # (2)
Attachments: NotRequired[List[AttachmentItemTypeDef]], # (3)
MessageMetadata: NotRequired[MessageMetadataTypeDef], # (4)
RelatedContactId: NotRequired[str],
ContactId: NotRequired[str],
GetTranscriptResponseTypeDef
Usage Example
from mypy_boto3_connectparticipant.type_defs import GetTranscriptResponseTypeDef
def get_value() -> GetTranscriptResponseTypeDef:
return {
"InitialContactId": ...,
"Transcript": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
Definition
class GetTranscriptResponseTypeDef(TypedDict):
InitialContactId: str,
Transcript: List[ItemTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See ItemTypeDef
- See ResponseMetadataTypeDef