Skip to content

Type definitions#

Index > ConnectParticipant > Type definitions

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

AttachmentItemTypeDef#

# AttachmentItemTypeDef definition

class AttachmentItemTypeDef(TypedDict):
    ContentType: NotRequired[str],
    AttachmentId: NotRequired[str],
    AttachmentName: NotRequired[str],
    Status: NotRequired[ArtifactStatusType],  # (1)
  1. See ArtifactStatusType

CancelParticipantAuthenticationRequestRequestTypeDef#

# CancelParticipantAuthenticationRequestRequestTypeDef definition

class CancelParticipantAuthenticationRequestRequestTypeDef(TypedDict):
    SessionId: str,
    ConnectionToken: str,

CompleteAttachmentUploadRequestRequestTypeDef#

# CompleteAttachmentUploadRequestRequestTypeDef definition

class CompleteAttachmentUploadRequestRequestTypeDef(TypedDict):
    AttachmentIds: Sequence[str],
    ClientToken: str,
    ConnectionToken: str,

ConnectionCredentialsTypeDef#

# ConnectionCredentialsTypeDef definition

class ConnectionCredentialsTypeDef(TypedDict):
    ConnectionToken: NotRequired[str],
    Expiry: NotRequired[str],

CreateParticipantConnectionRequestRequestTypeDef#

# CreateParticipantConnectionRequestRequestTypeDef definition

class CreateParticipantConnectionRequestRequestTypeDef(TypedDict):
    ParticipantToken: str,
    Type: NotRequired[Sequence[ConnectionTypeType]],  # (1)
    ConnectParticipant: NotRequired[bool],
  1. See ConnectionTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

WebsocketTypeDef#

# WebsocketTypeDef definition

class WebsocketTypeDef(TypedDict):
    Url: NotRequired[str],
    ConnectionExpiry: NotRequired[str],

DescribeViewRequestRequestTypeDef#

# DescribeViewRequestRequestTypeDef definition

class DescribeViewRequestRequestTypeDef(TypedDict):
    ViewToken: str,
    ConnectionToken: str,

DisconnectParticipantRequestRequestTypeDef#

# DisconnectParticipantRequestRequestTypeDef definition

class DisconnectParticipantRequestRequestTypeDef(TypedDict):
    ConnectionToken: str,
    ClientToken: NotRequired[str],

GetAttachmentRequestRequestTypeDef#

# GetAttachmentRequestRequestTypeDef definition

class GetAttachmentRequestRequestTypeDef(TypedDict):
    AttachmentId: str,
    ConnectionToken: str,
    UrlExpiryInSeconds: NotRequired[int],

GetAuthenticationUrlRequestRequestTypeDef#

# GetAuthenticationUrlRequestRequestTypeDef definition

class GetAuthenticationUrlRequestRequestTypeDef(TypedDict):
    SessionId: str,
    RedirectUri: str,
    ConnectionToken: str,

StartPositionTypeDef#

# StartPositionTypeDef definition

class StartPositionTypeDef(TypedDict):
    Id: NotRequired[str],
    AbsoluteTime: NotRequired[str],
    MostRecent: NotRequired[int],

ReceiptTypeDef#

# ReceiptTypeDef definition

class ReceiptTypeDef(TypedDict):
    DeliveredTimestamp: NotRequired[str],
    ReadTimestamp: NotRequired[str],
    RecipientParticipantId: NotRequired[str],

SendEventRequestRequestTypeDef#

# SendEventRequestRequestTypeDef definition

class SendEventRequestRequestTypeDef(TypedDict):
    ContentType: str,
    ConnectionToken: str,
    Content: NotRequired[str],
    ClientToken: NotRequired[str],

SendMessageRequestRequestTypeDef#

# SendMessageRequestRequestTypeDef definition

class SendMessageRequestRequestTypeDef(TypedDict):
    ContentType: str,
    Content: str,
    ConnectionToken: str,
    ClientToken: NotRequired[str],

StartAttachmentUploadRequestRequestTypeDef#

# StartAttachmentUploadRequestRequestTypeDef definition

class StartAttachmentUploadRequestRequestTypeDef(TypedDict):
    ContentType: str,
    AttachmentSizeInBytes: int,
    AttachmentName: str,
    ClientToken: str,
    ConnectionToken: str,

UploadMetadataTypeDef#

# UploadMetadataTypeDef definition

class UploadMetadataTypeDef(TypedDict):
    Url: NotRequired[str],
    UrlExpiry: NotRequired[str],
    HeadersToInclude: NotRequired[dict[str, str]],

ViewContentTypeDef#

# ViewContentTypeDef definition

class ViewContentTypeDef(TypedDict):
    InputSchema: NotRequired[str],
    Template: NotRequired[str],
    Actions: NotRequired[list[str]],

GetAttachmentResponseTypeDef#

# GetAttachmentResponseTypeDef definition

class GetAttachmentResponseTypeDef(TypedDict):
    Url: str,
    UrlExpiry: str,
    AttachmentSizeInBytes: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAuthenticationUrlResponseTypeDef#

# GetAuthenticationUrlResponseTypeDef definition

class GetAuthenticationUrlResponseTypeDef(TypedDict):
    AuthenticationUrl: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

SendEventResponseTypeDef#

# SendEventResponseTypeDef definition

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

SendMessageResponseTypeDef#

# SendMessageResponseTypeDef definition

class SendMessageResponseTypeDef(TypedDict):
    Id: str,
    AbsoluteTime: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateParticipantConnectionResponseTypeDef#

# CreateParticipantConnectionResponseTypeDef definition

class CreateParticipantConnectionResponseTypeDef(TypedDict):
    Websocket: WebsocketTypeDef,  # (1)
    ConnectionCredentials: ConnectionCredentialsTypeDef,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See WebsocketTypeDef
  2. See ConnectionCredentialsTypeDef
  3. See ResponseMetadataTypeDef

GetTranscriptRequestRequestTypeDef#

# GetTranscriptRequestRequestTypeDef 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)
  1. See ScanDirectionType
  2. See SortKeyType
  3. See StartPositionTypeDef

MessageMetadataTypeDef#

# MessageMetadataTypeDef definition

class MessageMetadataTypeDef(TypedDict):
    MessageId: NotRequired[str],
    Receipts: NotRequired[list[ReceiptTypeDef]],  # (1)
  1. See ReceiptTypeDef

StartAttachmentUploadResponseTypeDef#

# StartAttachmentUploadResponseTypeDef definition

class StartAttachmentUploadResponseTypeDef(TypedDict):
    AttachmentId: str,
    UploadMetadata: UploadMetadataTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See UploadMetadataTypeDef
  2. See ResponseMetadataTypeDef

ViewTypeDef#

# ViewTypeDef definition

class ViewTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Version: NotRequired[int],
    Content: NotRequired[ViewContentTypeDef],  # (1)
  1. See ViewContentTypeDef

ItemTypeDef#

# ItemTypeDef 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],
  1. See ChatItemTypeType
  2. See ParticipantRoleType
  3. See AttachmentItemTypeDef
  4. See MessageMetadataTypeDef

DescribeViewResponseTypeDef#

# DescribeViewResponseTypeDef definition

class DescribeViewResponseTypeDef(TypedDict):
    View: ViewTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ViewTypeDef
  2. See ResponseMetadataTypeDef

GetTranscriptResponseTypeDef#

# GetTranscriptResponseTypeDef definition

class GetTranscriptResponseTypeDef(TypedDict):
    InitialContactId: str,
    Transcript: list[ItemTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ItemTypeDef
  2. See ResponseMetadataTypeDef