Skip to content

ConnectParticipantClient#

Index > ConnectParticipant > ConnectParticipantClient

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

ConnectParticipantClient#

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

# ConnectParticipantClient usage example

from boto3.session import Session
from types_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.

# Exceptions.exceptions usage example

client = boto3.client("connectparticipant")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from types_boto3_connectparticipant.client import Exceptions

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

Methods#

can_paginate#

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

# can_paginate method definition

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

generate_presigned_url#

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

# generate_presigned_url method definition

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

cancel_participant_authentication#

Cancels the authentication session.

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

# cancel_participant_authentication method definition

def cancel_participant_authentication(
    self,
    *,
    SessionId: str,
    ConnectionToken: str,
) -> Dict[str, Any]:
    ...
# cancel_participant_authentication method usage example with argument unpacking

kwargs: CancelParticipantAuthenticationRequestTypeDef = {  # (1)
    "SessionId": ...,
    "ConnectionToken": ...,
}

parent.cancel_participant_authentication(**kwargs)
  1. See CancelParticipantAuthenticationRequestTypeDef

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

# complete_attachment_upload method definition

def complete_attachment_upload(
    self,
    *,
    AttachmentIds: Sequence[str],
    ClientToken: str,
    ConnectionToken: str,
) -> Dict[str, Any]:
    ...
# complete_attachment_upload method usage example with argument unpacking

kwargs: CompleteAttachmentUploadRequestTypeDef = {  # (1)
    "AttachmentIds": ...,
    "ClientToken": ...,
    "ConnectionToken": ...,
}

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

create_participant_connection#

Creates the participant's connection.

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

# create_participant_connection method definition

def create_participant_connection(
    self,
    *,
    ParticipantToken: str,
    Type: Sequence[ConnectionTypeType] = ...,  # (1)
    ConnectParticipant: bool = ...,
) -> CreateParticipantConnectionResponseTypeDef:  # (2)
    ...
  1. See Sequence[ConnectionTypeType]
  2. See CreateParticipantConnectionResponseTypeDef
# create_participant_connection method usage example with argument unpacking

kwargs: CreateParticipantConnectionRequestTypeDef = {  # (1)
    "ParticipantToken": ...,
}

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

describe_view#

Retrieves the view for the specified view token.

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

# describe_view method definition

def describe_view(
    self,
    *,
    ViewToken: str,
    ConnectionToken: str,
) -> DescribeViewResponseTypeDef:  # (1)
    ...
  1. See DescribeViewResponseTypeDef
# describe_view method usage example with argument unpacking

kwargs: DescribeViewRequestTypeDef = {  # (1)
    "ViewToken": ...,
    "ConnectionToken": ...,
}

parent.describe_view(**kwargs)
  1. See DescribeViewRequestTypeDef

disconnect_participant#

Disconnects a participant.

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

# disconnect_participant method definition

def disconnect_participant(
    self,
    *,
    ConnectionToken: str,
    ClientToken: str = ...,
) -> Dict[str, Any]:
    ...
# disconnect_participant method usage example with argument unpacking

kwargs: DisconnectParticipantRequestTypeDef = {  # (1)
    "ConnectionToken": ...,
}

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

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

# get_attachment method definition

def get_attachment(
    self,
    *,
    AttachmentId: str,
    ConnectionToken: str,
    UrlExpiryInSeconds: int = ...,
) -> GetAttachmentResponseTypeDef:  # (1)
    ...
  1. See GetAttachmentResponseTypeDef
# get_attachment method usage example with argument unpacking

kwargs: GetAttachmentRequestTypeDef = {  # (1)
    "AttachmentId": ...,
    "ConnectionToken": ...,
}

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

get_authentication_url#

Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block.

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

# get_authentication_url method definition

def get_authentication_url(
    self,
    *,
    SessionId: str,
    RedirectUri: str,
    ConnectionToken: str,
) -> GetAuthenticationUrlResponseTypeDef:  # (1)
    ...
  1. See GetAuthenticationUrlResponseTypeDef
# get_authentication_url method usage example with argument unpacking

kwargs: GetAuthenticationUrlRequestTypeDef = {  # (1)
    "SessionId": ...,
    "RedirectUri": ...,
    "ConnectionToken": ...,
}

parent.get_authentication_url(**kwargs)
  1. See GetAuthenticationUrlRequestTypeDef

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

# get_transcript 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
# get_transcript method usage example with argument unpacking

kwargs: GetTranscriptRequestTypeDef = {  # (1)
    "ConnectionToken": ...,
}

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

send_event#

The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType is no longer maintained since December 31, 2024.

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

# send_event method definition

def send_event(
    self,
    *,
    ContentType: str,
    ConnectionToken: str,
    Content: str = ...,
    ClientToken: str = ...,
) -> SendEventResponseTypeDef:  # (1)
    ...
  1. See SendEventResponseTypeDef
# send_event method usage example with argument unpacking

kwargs: SendEventRequestTypeDef = {  # (1)
    "ContentType": ...,
    "ConnectionToken": ...,
}

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

send_message#

Sends a message.

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

# send_message method definition

def send_message(
    self,
    *,
    ContentType: str,
    Content: str,
    ConnectionToken: str,
    ClientToken: str = ...,
) -> SendMessageResponseTypeDef:  # (1)
    ...
  1. See SendMessageResponseTypeDef
# send_message method usage example with argument unpacking

kwargs: SendMessageRequestTypeDef = {  # (1)
    "ContentType": ...,
    "Content": ...,
    "ConnectionToken": ...,
}

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

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

# start_attachment_upload method definition

def start_attachment_upload(
    self,
    *,
    ContentType: str,
    AttachmentSizeInBytes: int,
    AttachmentName: str,
    ClientToken: str,
    ConnectionToken: str,
) -> StartAttachmentUploadResponseTypeDef:  # (1)
    ...
  1. See StartAttachmentUploadResponseTypeDef
# start_attachment_upload method usage example with argument unpacking

kwargs: StartAttachmentUploadRequestTypeDef = {  # (1)
    "ContentType": ...,
    "AttachmentSizeInBytes": ...,
    "AttachmentName": ...,
    "ClientToken": ...,
    "ConnectionToken": ...,
}

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