paws (version 0.2.0)

connectparticipant: Amazon Connect Participant Service

Description

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect enables customer contacts through voice or chat.

The APIs described here are used by chat participants, such as agents and customers.

Usage

connectparticipant(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• access_key_id: AWS access key ID

• secret_access_key: AWS secret access key

• session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.

Service syntax

svc <- connectparticipant(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical"
  )
)

Operations

complete_attachment_upload	Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API
create_participant_connection	Creates the participant's connection
disconnect_participant	Disconnects a participant
get_attachment	Provides a pre-signed URL for download of a completed attachment
get_transcript	Retrieves a transcript of the session, including details about any attachments
send_event	Sends an event
send_message	Sends a message
start_attachment_upload	Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3

Examples

if (FALSE) {
svc <- connectparticipant()
svc$complete_attachment_upload(
  Foo = 123
)
}