Skip to content

Type definitions#

Index > ConnectParticipant > Type definitions

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

AttachmentItemTypeDef#

# AttachmentItemTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import AttachmentItemTypeDef


def get_value() -> AttachmentItemTypeDef:
    return {
        "ContentType": ...,
    }


# AttachmentItemTypeDef definition

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

AttendeeTypeDef#

# AttendeeTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import AttendeeTypeDef


def get_value() -> AttendeeTypeDef:
    return {
        "AttendeeId": ...,
    }


# AttendeeTypeDef definition

class AttendeeTypeDef(TypedDict):
    AttendeeId: NotRequired[str],
    JoinToken: NotRequired[str],

AudioFeaturesTypeDef#

# AudioFeaturesTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import AudioFeaturesTypeDef


def get_value() -> AudioFeaturesTypeDef:
    return {
        "EchoReduction": ...,
    }


# AudioFeaturesTypeDef definition

class AudioFeaturesTypeDef(TypedDict):
    EchoReduction: NotRequired[MeetingFeatureStatusType],  # (1)
  1. See MeetingFeatureStatusType

CancelParticipantAuthenticationRequestTypeDef#

# CancelParticipantAuthenticationRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import CancelParticipantAuthenticationRequestTypeDef


def get_value() -> CancelParticipantAuthenticationRequestTypeDef:
    return {
        "SessionId": ...,
    }


# CancelParticipantAuthenticationRequestTypeDef definition

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

CompleteAttachmentUploadRequestTypeDef#

# CompleteAttachmentUploadRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import CompleteAttachmentUploadRequestTypeDef


def get_value() -> CompleteAttachmentUploadRequestTypeDef:
    return {
        "AttachmentIds": ...,
    }


# CompleteAttachmentUploadRequestTypeDef definition

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

ConnectionCredentialsTypeDef#

# ConnectionCredentialsTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import ConnectionCredentialsTypeDef


def get_value() -> ConnectionCredentialsTypeDef:
    return {
        "ConnectionToken": ...,
    }


# ConnectionCredentialsTypeDef definition

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

CreateParticipantConnectionRequestTypeDef#

# CreateParticipantConnectionRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import CreateParticipantConnectionRequestTypeDef


def get_value() -> CreateParticipantConnectionRequestTypeDef:
    return {
        "ParticipantToken": ...,
    }


# CreateParticipantConnectionRequestTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

WebsocketTypeDef#

# WebsocketTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import WebsocketTypeDef


def get_value() -> WebsocketTypeDef:
    return {
        "Url": ...,
    }


# WebsocketTypeDef definition

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

DescribeViewRequestTypeDef#

# DescribeViewRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import DescribeViewRequestTypeDef


def get_value() -> DescribeViewRequestTypeDef:
    return {
        "ViewToken": ...,
    }


# DescribeViewRequestTypeDef definition

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

DisconnectParticipantRequestTypeDef#

# DisconnectParticipantRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import DisconnectParticipantRequestTypeDef


def get_value() -> DisconnectParticipantRequestTypeDef:
    return {
        "ConnectionToken": ...,
    }


# DisconnectParticipantRequestTypeDef definition

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

GetAttachmentRequestTypeDef#

# GetAttachmentRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import GetAttachmentRequestTypeDef


def get_value() -> GetAttachmentRequestTypeDef:
    return {
        "AttachmentId": ...,
    }


# GetAttachmentRequestTypeDef definition

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

GetAuthenticationUrlRequestTypeDef#

# GetAuthenticationUrlRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import GetAuthenticationUrlRequestTypeDef


def get_value() -> GetAuthenticationUrlRequestTypeDef:
    return {
        "SessionId": ...,
    }


# GetAuthenticationUrlRequestTypeDef definition

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

StartPositionTypeDef#

# StartPositionTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import StartPositionTypeDef


def get_value() -> StartPositionTypeDef:
    return {
        "Id": ...,
    }


# StartPositionTypeDef definition

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

ReceiptTypeDef#

# ReceiptTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import ReceiptTypeDef


def get_value() -> ReceiptTypeDef:
    return {
        "DeliveredTimestamp": ...,
    }


# ReceiptTypeDef definition

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

SendEventRequestTypeDef#

# SendEventRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import SendEventRequestTypeDef


def get_value() -> SendEventRequestTypeDef:
    return {
        "ContentType": ...,
    }


# SendEventRequestTypeDef definition

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

SendMessageRequestTypeDef#

# SendMessageRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import SendMessageRequestTypeDef


def get_value() -> SendMessageRequestTypeDef:
    return {
        "ContentType": ...,
    }


# SendMessageRequestTypeDef definition

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

StartAttachmentUploadRequestTypeDef#

# StartAttachmentUploadRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import StartAttachmentUploadRequestTypeDef


def get_value() -> StartAttachmentUploadRequestTypeDef:
    return {
        "ContentType": ...,
    }


# StartAttachmentUploadRequestTypeDef definition

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

UploadMetadataTypeDef#

# UploadMetadataTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import UploadMetadataTypeDef


def get_value() -> UploadMetadataTypeDef:
    return {
        "Url": ...,
    }


# UploadMetadataTypeDef definition

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

ViewContentTypeDef#

# ViewContentTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import ViewContentTypeDef


def get_value() -> ViewContentTypeDef:
    return {
        "InputSchema": ...,
    }


# ViewContentTypeDef definition

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

WebRTCMediaPlacementTypeDef#

# WebRTCMediaPlacementTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import WebRTCMediaPlacementTypeDef


def get_value() -> WebRTCMediaPlacementTypeDef:
    return {
        "AudioHostUrl": ...,
    }


# WebRTCMediaPlacementTypeDef definition

class WebRTCMediaPlacementTypeDef(TypedDict):
    AudioHostUrl: NotRequired[str],
    AudioFallbackUrl: NotRequired[str],
    SignalingUrl: NotRequired[str],
    EventIngestionUrl: NotRequired[str],

MeetingFeaturesConfigurationTypeDef#

# MeetingFeaturesConfigurationTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import MeetingFeaturesConfigurationTypeDef


def get_value() -> MeetingFeaturesConfigurationTypeDef:
    return {
        "Audio": ...,
    }


# MeetingFeaturesConfigurationTypeDef definition

class MeetingFeaturesConfigurationTypeDef(TypedDict):
    Audio: NotRequired[AudioFeaturesTypeDef],  # (1)
  1. See AudioFeaturesTypeDef

GetAttachmentResponseTypeDef#

# GetAttachmentResponseTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import GetAttachmentResponseTypeDef


def get_value() -> GetAttachmentResponseTypeDef:
    return {
        "Url": ...,
    }


# GetAttachmentResponseTypeDef definition

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

GetAuthenticationUrlResponseTypeDef#

# GetAuthenticationUrlResponseTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import GetAuthenticationUrlResponseTypeDef


def get_value() -> GetAuthenticationUrlResponseTypeDef:
    return {
        "AuthenticationUrl": ...,
    }


# GetAuthenticationUrlResponseTypeDef definition

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

SendEventResponseTypeDef#

# SendEventResponseTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import SendEventResponseTypeDef


def get_value() -> SendEventResponseTypeDef:
    return {
        "Id": ...,
    }


# SendEventResponseTypeDef definition

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

SendMessageResponseTypeDef#

# SendMessageResponseTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import SendMessageResponseTypeDef


def get_value() -> SendMessageResponseTypeDef:
    return {
        "Id": ...,
    }


# SendMessageResponseTypeDef definition

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

GetTranscriptRequestTypeDef#

# GetTranscriptRequestTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import GetTranscriptRequestTypeDef


def get_value() -> GetTranscriptRequestTypeDef:
    return {
        "ConnectionToken": ...,
    }


# GetTranscriptRequestTypeDef definition

class GetTranscriptRequestTypeDef(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 TypedDict usage example

from types_boto3_connectparticipant.type_defs import MessageMetadataTypeDef


def get_value() -> MessageMetadataTypeDef:
    return {
        "MessageId": ...,
    }


# MessageMetadataTypeDef definition

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

StartAttachmentUploadResponseTypeDef#

# StartAttachmentUploadResponseTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import StartAttachmentUploadResponseTypeDef


def get_value() -> StartAttachmentUploadResponseTypeDef:
    return {
        "AttachmentId": ...,
    }


# StartAttachmentUploadResponseTypeDef definition

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

ViewTypeDef#

# ViewTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import ViewTypeDef


def get_value() -> ViewTypeDef:
    return {
        "Id": ...,
    }


# ViewTypeDef definition

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

WebRTCMeetingTypeDef#

# WebRTCMeetingTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import WebRTCMeetingTypeDef


def get_value() -> WebRTCMeetingTypeDef:
    return {
        "MediaPlacement": ...,
    }


# WebRTCMeetingTypeDef definition

class WebRTCMeetingTypeDef(TypedDict):
    MediaPlacement: NotRequired[WebRTCMediaPlacementTypeDef],  # (1)
    MeetingFeatures: NotRequired[MeetingFeaturesConfigurationTypeDef],  # (2)
    MeetingId: NotRequired[str],
  1. See WebRTCMediaPlacementTypeDef
  2. See MeetingFeaturesConfigurationTypeDef

ItemTypeDef#

# ItemTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import ItemTypeDef


def get_value() -> ItemTypeDef:
    return {
        "AbsoluteTime": ...,
    }


# 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 List[AttachmentItemTypeDef]
  4. See MessageMetadataTypeDef

DescribeViewResponseTypeDef#

# DescribeViewResponseTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import DescribeViewResponseTypeDef


def get_value() -> DescribeViewResponseTypeDef:
    return {
        "View": ...,
    }


# DescribeViewResponseTypeDef definition

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

WebRTCConnectionTypeDef#

# WebRTCConnectionTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import WebRTCConnectionTypeDef


def get_value() -> WebRTCConnectionTypeDef:
    return {
        "Attendee": ...,
    }


# WebRTCConnectionTypeDef definition

class WebRTCConnectionTypeDef(TypedDict):
    Attendee: NotRequired[AttendeeTypeDef],  # (1)
    Meeting: NotRequired[WebRTCMeetingTypeDef],  # (2)
  1. See AttendeeTypeDef
  2. See WebRTCMeetingTypeDef

GetTranscriptResponseTypeDef#

# GetTranscriptResponseTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import GetTranscriptResponseTypeDef


def get_value() -> GetTranscriptResponseTypeDef:
    return {
        "InitialContactId": ...,
    }


# GetTranscriptResponseTypeDef definition

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

CreateParticipantConnectionResponseTypeDef#

# CreateParticipantConnectionResponseTypeDef TypedDict usage example

from types_boto3_connectparticipant.type_defs import CreateParticipantConnectionResponseTypeDef


def get_value() -> CreateParticipantConnectionResponseTypeDef:
    return {
        "Websocket": ...,
    }


# CreateParticipantConnectionResponseTypeDef definition

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