Skip to content

ConnectParticipantClient

Index > ConnectParticipant > ConnectParticipantClient

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

ConnectParticipantClient

Type annotations and code completion for boto3.client("connectparticipant"). boto3 documentation

Usage example
from boto3.session import Session
from mypy_boto3_connectparticipant.client import ConnectParticipantClient

def get_connectparticipant_client() -> ConnectParticipantClient:
    return Session().client("connectparticipant")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("connectparticipant").exceptions structure.

Usage example
client = boto3.client("connectparticipant")

try:
    do_something(client)
except (
    client.AccessDeniedException,
    client.ClientError,
    client.ConflictException,
    client.InternalServerException,
    client.ServiceQuotaExceededException,
    client.ThrottlingException,
    client.ValidationException,
) as e:
    print(e)
Type checking example
from mypy_boto3_connectparticipant.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("connectparticipant").can_paginate method. boto3 documentation

Method definition
def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("connectparticipant").close method. boto3 documentation

Method definition
def close(
    self,
) -> None:
    ...

complete_attachment_upload

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

Type annotations and code completion for boto3.client("connectparticipant").complete_attachment_upload method. boto3 documentation

Method definition
def complete_attachment_upload(
    self,
    *,
    AttachmentIds: Sequence[str],
    ClientToken: str,
    ConnectionToken: str,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: CompleteAttachmentUploadRequestRequestTypeDef = {  # (1)
    "AttachmentIds": ...,
    "ClientToken": ...,
    "ConnectionToken": ...,
}

parent.complete_attachment_upload(**kwargs)
  1. See CompleteAttachmentUploadRequestRequestTypeDef

create_participant_connection

Creates the participant's connection.

Type annotations and code completion for boto3.client("connectparticipant").create_participant_connection method. boto3 documentation

Method definition
def create_participant_connection(
    self,
    *,
    Type: Sequence[ConnectionTypeType],  # (1)
    ParticipantToken: str,
    ConnectParticipant: bool = ...,
) -> CreateParticipantConnectionResponseTypeDef:  # (2)
    ...
  1. See ConnectionTypeType
  2. See CreateParticipantConnectionResponseTypeDef
Usage example with kwargs
kwargs: CreateParticipantConnectionRequestRequestTypeDef = {  # (1)
    "Type": ...,
    "ParticipantToken": ...,
}

parent.create_participant_connection(**kwargs)
  1. See CreateParticipantConnectionRequestRequestTypeDef

disconnect_participant

Disconnects a participant.

Type annotations and code completion for boto3.client("connectparticipant").disconnect_participant method. boto3 documentation

Method definition
def disconnect_participant(
    self,
    *,
    ConnectionToken: str,
    ClientToken: str = ...,
) -> Dict[str, Any]:
    ...
Usage example with kwargs
kwargs: DisconnectParticipantRequestRequestTypeDef = {  # (1)
    "ConnectionToken": ...,
}

parent.disconnect_participant(**kwargs)
  1. See DisconnectParticipantRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("connectparticipant").generate_presigned_url method. boto3 documentation

Method definition
def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_attachment

Provides a pre-signed URL for download of a completed attachment.

Type annotations and code completion for boto3.client("connectparticipant").get_attachment method. boto3 documentation

Method definition
def get_attachment(
    self,
    *,
    AttachmentId: str,
    ConnectionToken: str,
) -> GetAttachmentResponseTypeDef:  # (1)
    ...
  1. See GetAttachmentResponseTypeDef
Usage example with kwargs
kwargs: GetAttachmentRequestRequestTypeDef = {  # (1)
    "AttachmentId": ...,
    "ConnectionToken": ...,
}

parent.get_attachment(**kwargs)
  1. See GetAttachmentRequestRequestTypeDef

get_transcript

Retrieves a transcript of the session, including details about any attachments.

Type annotations and code completion for boto3.client("connectparticipant").get_transcript method. boto3 documentation

Method definition
def get_transcript(
    self,
    *,
    ConnectionToken: str,
    ContactId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    ScanDirection: ScanDirectionType = ...,  # (1)
    SortOrder: SortKeyType = ...,  # (2)
    StartPosition: StartPositionTypeDef = ...,  # (3)
) -> GetTranscriptResponseTypeDef:  # (4)
    ...
  1. See ScanDirectionType
  2. See SortKeyType
  3. See StartPositionTypeDef
  4. See GetTranscriptResponseTypeDef
Usage example with kwargs
kwargs: GetTranscriptRequestRequestTypeDef = {  # (1)
    "ConnectionToken": ...,
}

parent.get_transcript(**kwargs)
  1. See GetTranscriptRequestRequestTypeDef

send_event

Sends an event.

Type annotations and code completion for boto3.client("connectparticipant").send_event method. boto3 documentation

Method definition
def send_event(
    self,
    *,
    ContentType: str,
    ConnectionToken: str,
    Content: str = ...,
    ClientToken: str = ...,
) -> SendEventResponseTypeDef:  # (1)
    ...
  1. See SendEventResponseTypeDef
Usage example with kwargs
kwargs: SendEventRequestRequestTypeDef = {  # (1)
    "ContentType": ...,
    "ConnectionToken": ...,
}

parent.send_event(**kwargs)
  1. See SendEventRequestRequestTypeDef

send_message

Sends a message.

Type annotations and code completion for boto3.client("connectparticipant").send_message method. boto3 documentation

Method definition
def send_message(
    self,
    *,
    ContentType: str,
    Content: str,
    ConnectionToken: str,
    ClientToken: str = ...,
) -> SendMessageResponseTypeDef:  # (1)
    ...
  1. See SendMessageResponseTypeDef
Usage example with kwargs
kwargs: SendMessageRequestRequestTypeDef = {  # (1)
    "ContentType": ...,
    "Content": ...,
    "ConnectionToken": ...,
}

parent.send_message(**kwargs)
  1. See SendMessageRequestRequestTypeDef

start_attachment_upload

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

Type annotations and code completion for boto3.client("connectparticipant").start_attachment_upload method. boto3 documentation

Method definition
def start_attachment_upload(
    self,
    *,
    ContentType: str,
    AttachmentSizeInBytes: int,
    AttachmentName: str,
    ClientToken: str,
    ConnectionToken: str,
) -> StartAttachmentUploadResponseTypeDef:  # (1)
    ...
  1. See StartAttachmentUploadResponseTypeDef
Usage example with kwargs
kwargs: StartAttachmentUploadRequestRequestTypeDef = {  # (1)
    "ContentType": ...,
    "AttachmentSizeInBytes": ...,
    "AttachmentName": ...,
    "ClientToken": ...,
    "ConnectionToken": ...,
}

parent.start_attachment_upload(**kwargs)
  1. See StartAttachmentUploadRequestRequestTypeDef