ConnectParticipantClient#
Index > ConnectParticipant > ConnectParticipantClient
Auto-generated documentation for ConnectParticipant type annotations stubs module types-aiobotocore-connectparticipant.
ConnectParticipantClient#
Type annotations and code completion for session.create_client("connectparticipant")
boto3 documentation
ConnectParticipantClient usage example
from aiobotocore.session import get_session
from types_aiobotocore_connectparticipant.client import ConnectParticipantClient
session = get_session()
async with session.create_client("connectparticipant") as client:
client: ConnectParticipantClient
Exceptions#
aiobotocore
client exceptions are generated in runtime.
This class provides code completion for session.create_client("connectparticipant").exceptions
structure.
ConnectParticipantClient.exceptions usage example
async with session.create_client("connectparticipant") as client:
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.ConflictException,
client.InternalServerException,
client.ServiceQuotaExceededException,
client.ThrottlingException,
client.ValidationException,
) as e:
print(e)
ConnectParticipantClient usage type checking example
from types_aiobotocore_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 session.create_client("connectparticipant").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
close#
Closes underlying endpoint connections.
Type annotations and code completion for session.create_client("connectparticipant").close
method.
boto3 documentation
# close method definition
await 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 session.create_client("connectparticipant").complete_attachment_upload
method.
boto3 documentation
# complete_attachment_upload method definition
await 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: CompleteAttachmentUploadRequestRequestTypeDef = { # (1)
"AttachmentIds": ...,
"ClientToken": ...,
"ConnectionToken": ...,
}
parent.complete_attachment_upload(**kwargs)
create_participant_connection#
Creates the participant's connection.
Type annotations and code completion for session.create_client("connectparticipant").create_participant_connection
method.
boto3 documentation
# create_participant_connection method definition
await def create_participant_connection(
self,
*,
ParticipantToken: str,
Type: Sequence[ConnectionTypeType] = ..., # (1)
ConnectParticipant: bool = ...,
) -> CreateParticipantConnectionResponseTypeDef: # (2)
...
# create_participant_connection method usage example with argument unpacking
kwargs: CreateParticipantConnectionRequestRequestTypeDef = { # (1)
"ParticipantToken": ...,
}
parent.create_participant_connection(**kwargs)
disconnect_participant#
Disconnects a participant.
Type annotations and code completion for session.create_client("connectparticipant").disconnect_participant
method.
boto3 documentation
# disconnect_participant method definition
await def disconnect_participant(
self,
*,
ConnectionToken: str,
ClientToken: str = ...,
) -> Dict[str, Any]:
...
# disconnect_participant method usage example with argument unpacking
kwargs: DisconnectParticipantRequestRequestTypeDef = { # (1)
"ConnectionToken": ...,
}
parent.disconnect_participant(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for session.create_client("connectparticipant").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
await 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 session.create_client("connectparticipant").get_attachment
method.
boto3 documentation
# get_attachment method definition
await def get_attachment(
self,
*,
AttachmentId: str,
ConnectionToken: str,
) -> GetAttachmentResponseTypeDef: # (1)
...
# get_attachment method usage example with argument unpacking
kwargs: GetAttachmentRequestRequestTypeDef = { # (1)
"AttachmentId": ...,
"ConnectionToken": ...,
}
parent.get_attachment(**kwargs)
get_transcript#
Retrieves a transcript of the session, including details about any attachments.
Type annotations and code completion for session.create_client("connectparticipant").get_transcript
method.
boto3 documentation
# get_transcript method definition
await def get_transcript(
self,
*,
ConnectionToken: str,
ContactId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
ScanDirection: ScanDirectionType = ..., # (1)
SortOrder: SortKeyType = ..., # (2)
StartPosition: StartPositionTypeDef = ..., # (3)
) -> GetTranscriptResponseTypeDef: # (4)
...
- See ScanDirectionType
- See SortKeyType
- See StartPositionTypeDef
- See GetTranscriptResponseTypeDef
# get_transcript method usage example with argument unpacking
kwargs: GetTranscriptRequestRequestTypeDef = { # (1)
"ConnectionToken": ...,
}
parent.get_transcript(**kwargs)
send_event#
Sends an event.
Type annotations and code completion for session.create_client("connectparticipant").send_event
method.
boto3 documentation
# send_event method definition
await def send_event(
self,
*,
ContentType: str,
ConnectionToken: str,
Content: str = ...,
ClientToken: str = ...,
) -> SendEventResponseTypeDef: # (1)
...
# send_event method usage example with argument unpacking
kwargs: SendEventRequestRequestTypeDef = { # (1)
"ContentType": ...,
"ConnectionToken": ...,
}
parent.send_event(**kwargs)
send_message#
Sends a message.
Type annotations and code completion for session.create_client("connectparticipant").send_message
method.
boto3 documentation
# send_message method definition
await def send_message(
self,
*,
ContentType: str,
Content: str,
ConnectionToken: str,
ClientToken: str = ...,
) -> SendMessageResponseTypeDef: # (1)
...
# send_message method usage example with argument unpacking
kwargs: SendMessageRequestRequestTypeDef = { # (1)
"ContentType": ...,
"Content": ...,
"ConnectionToken": ...,
}
parent.send_message(**kwargs)
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 session.create_client("connectparticipant").start_attachment_upload
method.
boto3 documentation
# start_attachment_upload method definition
await def start_attachment_upload(
self,
*,
ContentType: str,
AttachmentSizeInBytes: int,
AttachmentName: str,
ClientToken: str,
ConnectionToken: str,
) -> StartAttachmentUploadResponseTypeDef: # (1)
...
# start_attachment_upload method usage example with argument unpacking
kwargs: StartAttachmentUploadRequestRequestTypeDef = { # (1)
"ContentType": ...,
"AttachmentSizeInBytes": ...,
"AttachmentName": ...,
"ClientToken": ...,
"ConnectionToken": ...,
}
parent.start_attachment_upload(**kwargs)
__aenter__#
Type annotations and code completion for session.create_client("connectparticipant").__aenter__
method.
boto3 documentation
# __aenter__ method definition
await def __aenter__(
self,
) -> ConnectParticipantClient:
...
__aexit__#
Type annotations and code completion for session.create_client("connectparticipant").__aexit__
method.
boto3 documentation
# __aexit__ method definition
await def __aexit__(
self,
exc_type: Any,
exc_val: Any,
exc_tb: Any,
) -> Any:
...