You are viewing the documentation for an older major version of the AWS SDK for JavaScript.

The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.ConnectParticipant

Inherits:

AWS.Service

Object
AWS.Service
AWS.ConnectParticipant

show all

Identifier:: connectparticipant

API Version:: 2018-09-07

Defined in:: (unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

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.

Sending a Request Using ConnectParticipant

var connectparticipant = new AWS.ConnectParticipant();
connectparticipant.completeAttachmentUpload(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the ConnectParticipant object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var connectparticipant = new AWS.ConnectParticipant({apiVersion: '2018-09-07'});

You can also set the API version globally in AWS.config.apiVersions using the connectparticipant service identifier:

AWS.config.apiVersions = {
  connectparticipant: '2018-09-07',
  // other service API versions
};

var connectparticipant = new AWS.ConnectParticipant();

Version:

2018-09-07

Constructor Summary collapse

new AWS.ConnectParticipant(options = {}) ⇒ Object constructor
Constructs a service object.

Property Summary collapse

endpoint ⇒ AWS.Endpoint readwrite
An Endpoint object representing the endpoint URL for service requests.

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

completeAttachmentUpload(params = {}, callback) ⇒ AWS.Request
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
createParticipantConnection(params = {}, callback) ⇒ AWS.Request
Creates the participant's connection.
disconnectParticipant(params = {}, callback) ⇒ AWS.Request
Disconnects a participant.
getAttachment(params = {}, callback) ⇒ AWS.Request
Provides a pre-signed URL for download of a completed attachment.
getTranscript(params = {}, callback) ⇒ AWS.Request
Retrieves a transcript of the session, including details about any attachments.
sendEvent(params = {}, callback) ⇒ AWS.Request
Sends an event.
sendMessage(params = {}, callback) ⇒ AWS.Request
Sends a message.
startAttachmentUpload(params = {}, callback) ⇒ AWS.Request
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

.

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.ConnectParticipant(options = {}) ⇒ `Object`

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a ConnectParticipant object

var connectparticipant = new AWS.ConnectParticipant({apiVersion: '2018-09-07'});

Options Hash (options):

params (map) —
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
endpoint (String|AWS.Endpoint) —
The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.
accessKeyId (String) —
your AWS access key ID.
secretAccessKey (String) —
your AWS secret access key.
sessionToken (AWS.Credentials) —
the optional AWS session token to sign requests with.
credentials (AWS.Credentials) —
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
credentialProvider (AWS.CredentialProviderChain) —
the provider chain used to resolve credentials if no static credentials property is set.
region (String) —
the region to send service requests to. See AWS.ConnectParticipant.region for more information.
maxRetries (Integer) —
the maximum amount of retries to attempt with a request. See AWS.ConnectParticipant.maxRetries for more information.
maxRedirects (Integer) —
the maximum amount of redirects to follow with a request. See AWS.ConnectParticipant.maxRedirects for more information.
sslEnabled (Boolean) —
whether to enable SSL for requests.
paramValidation (Boolean|map) —
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
- max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
computeChecksums (Boolean) —
whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)
convertResponseTypes (Boolean) —
whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.
correctClockSkew (Boolean) —
whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.
s3ForcePathStyle (Boolean) —
whether to force path style URLs for S3 objects.
s3BucketEndpoint (Boolean) —
whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.
s3DisableBodySigning (Boolean) —
whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.
s3UsEast1RegionalEndpoint ('legacy'|'regional') —
when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy
s3UseArnRegion (Boolean) —
whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true
retryDelayOptions (map) —
A set of options to configure the retry delay on retryable errors. Currently supported options are:
- base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
- customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
httpOptions (map) —
A set of options to pass to the low-level HTTP request. Currently supported options are:
- proxy [String] — the URL to proxy requests through
- agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
- connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
- timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
- xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
- xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
apiVersion (String, Date) —
a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.
apiVersions (map<String, String|Date>) —
a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.
logger (#write, #log) —
an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests
systemClockOffset (Number) —
an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.
signatureVersion (String) —
the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.
signatureCache (Boolean) —
whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.
dynamoDbCrc32 (Boolean) —
whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.
useAccelerateEndpoint (Boolean) —
Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.
clientSideMonitoring (Boolean) —
whether to collect and publish this client's performance metrics of all its API requests.
endpointDiscoveryEnabled (Boolean|undefined) —
whether to call operations with endpoints given by service dynamically. Setting this
endpointCacheSize (Number) —
the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000
hostPrefixEnabled (Boolean) —
whether to marshal request parameters to the prefix of hostname. Defaults to true.
stsRegionalEndpoints ('legacy'|'regional') —
whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ `AWS.Endpoint` (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

(AWS.Endpoint) —
an Endpoint object representing the endpoint URL for service requests.

Method Details

completeAttachmentUpload(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

CompleteAttachmentUpload

Examples:

Calling the completeAttachmentUpload operation

var params = {
  AttachmentIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  ClientToken: 'STRING_VALUE', /* required */
  ConnectionToken: 'STRING_VALUE' /* required */
};
connectparticipant.completeAttachmentUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- AttachmentIds — (Array<String>)
  A list of unique identifiers for the attachments.
- ClientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  If a token is not provided, the SDK will use a version 4 UUID.
- ConnectionToken — (String)
  The authentication token associated with the participant's connection.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

createParticipantConnection(params = {}, callback) ⇒ `AWS.Request`

Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

Note: The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Service Reference:

CreateParticipantConnection

Examples:

Calling the createParticipantConnection operation

var params = {
  ParticipantToken: 'STRING_VALUE', /* required */
  Type: [ /* required */
    WEBSOCKET | CONNECTION_CREDENTIALS,
    /* more items */
  ]
};
connectparticipant.createParticipantConnection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- Type — (Array<String>)
  Type of connection information required.
- ParticipantToken — (String)
  This is a header parameter.
  
  The Participant Token as obtained from StartChatContact API response.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Websocket — (map)
    Creates the participant's websocket connection.
    
    Url — (String)
    The URL of the websocket.
    
    ConnectionExpiry — (String)
    The URL expiration timestamp in ISO date format.
    
    It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
  - ConnectionCredentials — (map)
    Creates the participant's connection credentials. The authentication token associated with the participant's connection.
    
    ConnectionToken — (String)
    The connection token.
    
    Expiry — (String)
    The expiration of the token.
    
    It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

disconnectParticipant(params = {}, callback) ⇒ `AWS.Request`

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Service Reference:

DisconnectParticipant

Examples:

Calling the disconnectParticipant operation

var params = {
  ConnectionToken: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connectparticipant.disconnectParticipant(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ClientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  If a token is not provided, the SDK will use a version 4 UUID.
- ConnectionToken — (String)
  The authentication token associated with the participant's connection.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getAttachment(params = {}, callback) ⇒ `AWS.Request`

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

Service Reference:

GetAttachment

Examples:

Calling the getAttachment operation

var params = {
  AttachmentId: 'STRING_VALUE', /* required */
  ConnectionToken: 'STRING_VALUE' /* required */
};
connectparticipant.getAttachment(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- AttachmentId — (String)
  A unique identifier for the attachment.
- ConnectionToken — (String)
  The authentication token associated with the participant's connection.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Url — (String)
    The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.
  - UrlExpiry — (String)
    The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

getTranscript(params = {}, callback) ⇒ `AWS.Request`

Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Service Reference:

GetTranscript

Examples:

Calling the getTranscript operation

var params = {
  ConnectionToken: 'STRING_VALUE', /* required */
  ContactId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ScanDirection: FORWARD | BACKWARD,
  SortOrder: DESCENDING | ASCENDING,
  StartPosition: {
    AbsoluteTime: 'STRING_VALUE',
    Id: 'STRING_VALUE',
    MostRecent: 'NUMBER_VALUE'
  }
};
connectparticipant.getTranscript(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ContactId — (String)
  The contactId from the current contact chain for which transcript is needed.
- MaxResults — (Integer)
  The maximum number of results to return in the page. Default: 10.
- NextToken — (String)
  The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
- ScanDirection — (String)
  The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
  Possible values include:
  - "FORWARD"
  - "BACKWARD"
- SortOrder — (String)
  The sort order for the records. Default: DESCENDING.
  Possible values include:
  - "DESCENDING"
  - "ASCENDING"
- StartPosition — (map)
  A filtering option for where to start.
  - Id — (String)
    The ID of the message or event where to start.
  - AbsoluteTime — (String)
    The time in ISO format where to start.
    
    It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
  - MostRecent — (Integer)
    The start position of the most recent message where you want to start.
- ConnectionToken — (String)
  The authentication token associated with the participant's connection.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - InitialContactId — (String)
    The initial contact ID for the contact.
  - Transcript — (Array<map>)
    The list of messages in the session.
    
    AbsoluteTime — (String)
    The time when the message or event was sent.
    
    It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
    
    Content — (String)
    The content of the message or event.
    
    ContentType — (String)
    The type of content of the item.
    
    Id — (String)
    The ID of the item.
    
    Type — (String)
    Type of the item: message or event.
    Possible values include:
    
    "TYPING"
    
    "PARTICIPANT_JOINED"
    
    "PARTICIPANT_LEFT"
    
    "CHAT_ENDED"
    
    "TRANSFER_SUCCEEDED"
    
    "TRANSFER_FAILED"
    
    "MESSAGE"
    
    "EVENT"
    
    "ATTACHMENT"
    
    "CONNECTION_ACK"
    
    ParticipantId — (String)
    The ID of the sender in the session.
    
    DisplayName — (String)
    The chat display name of the sender.
    
    ParticipantRole — (String)
    The role of the sender. For example, is it a customer, agent, or system.
    Possible values include:
    
    "AGENT"
    
    "CUSTOMER"
    
    "SYSTEM"
    
    Attachments — (Array<map>)
    Provides information about the attachments.
    
    ContentType — (String)
    Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
    
    AttachmentId — (String)
    A unique identifier for the attachment.
    
    AttachmentName — (String)
    A case-sensitive name of the attachment being uploaded.
    
    Status — (String)
    Status of the attachment.
    Possible values include:
    
    "APPROVED"
    
    "REJECTED"
    
    "IN_PROGRESS"
  - NextToken — (String)
    The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

sendEvent(params = {}, callback) ⇒ `AWS.Request`

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Service Reference:

SendEvent

Examples:

Calling the sendEvent operation

var params = {
  ConnectionToken: 'STRING_VALUE', /* required */
  ContentType: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Content: 'STRING_VALUE'
};
connectparticipant.sendEvent(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ContentType — (String)
  The content type of the request. Supported types are:
  - application/vnd.amazonaws.connect.event.typing
  - application/vnd.amazonaws.connect.event.connection.acknowledged
- Content — (String)
  The content of the event to be sent (for example, message text). This is not yet supported.
- ClientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  If a token is not provided, the SDK will use a version 4 UUID.
- ConnectionToken — (String)
  The authentication token associated with the participant's connection.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Id — (String)
    The ID of the response.
  - AbsoluteTime — (String)
    The time when the event was sent.
    
    It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

sendMessage(params = {}, callback) ⇒ `AWS.Request`

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Note: The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Service Reference:

SendMessage

Examples:

Calling the sendMessage operation

var params = {
  ConnectionToken: 'STRING_VALUE', /* required */
  Content: 'STRING_VALUE', /* required */
  ContentType: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE'
};
connectparticipant.sendMessage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ContentType — (String)
  The type of the content. Supported types are text/plain.
- Content — (String)
  The content of the message.
- ClientToken — (String)
  A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  If a token is not provided, the SDK will use a version 4 UUID.
- ConnectionToken — (String)
  The authentication token associated with the connection.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - Id — (String)
    The ID of the message.
  - AbsoluteTime — (String)
    The time when the message was sent.
    
    It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

startAttachmentUpload(params = {}, callback) ⇒ `AWS.Request`

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

Service Reference:

StartAttachmentUpload

Examples:

Calling the startAttachmentUpload operation

var params = {
  AttachmentName: 'STRING_VALUE', /* required */
  AttachmentSizeInBytes: 'NUMBER_VALUE', /* required */
  ClientToken: 'STRING_VALUE', /* required */
  ConnectionToken: 'STRING_VALUE', /* required */
  ContentType: 'STRING_VALUE' /* required */
};
connectparticipant.startAttachmentUpload(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

params (Object) (defaults to: {}) —
- ContentType — (String)
  Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
- AttachmentSizeInBytes — (Integer)
  The size of the attachment in bytes.
- AttachmentName — (String)
  A case-sensitive name of the attachment being uploaded.
- ClientToken — (String)
  A unique case sensitive identifier to support idempotency of request.
  If a token is not provided, the SDK will use a version 4 UUID.
- ConnectionToken — (String)
  The authentication token associated with the participant's connection.

Callback (callback):

function(err, data) { ... }

Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
- (AWS.Response) —
  the response object containing error, data properties, and the original request object.
Parameters:
- err (Error) —
  the error object returned from the request. Set to null if the request is successful.
- data (Object) —
  the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:
  - AttachmentId — (String)
    A unique identifier for the attachment.
  - UploadMetadata — (map)
    Fields to be used while uploading the attachment.
    
    Url — (String)
    The pre-signed URL using which file would be downloaded from Amazon S3 by the API caller.
    
    UrlExpiry — (String)
    The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
    
    HeadersToInclude — (map<String>)
    The headers to be provided while uploading the file to the URL.

Returns:

(AWS.Request) —
a handle to the operation request for subsequent event callback registration.

Class: AWS.ConnectParticipant

Overview

Service Description

Sending a Request Using ConnectParticipant

Locking the API Version

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

Method Summary collapse

Methods inherited from AWS.Service

Constructor Details

new AWS.ConnectParticipant(options = {}) ⇒ Object

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Method Details

completeAttachmentUpload(params = {}, callback) ⇒ AWS.Request

createParticipantConnection(params = {}, callback) ⇒ AWS.Request

disconnectParticipant(params = {}, callback) ⇒ AWS.Request

getAttachment(params = {}, callback) ⇒ AWS.Request

getTranscript(params = {}, callback) ⇒ AWS.Request

sendEvent(params = {}, callback) ⇒ AWS.Request

sendMessage(params = {}, callback) ⇒ AWS.Request

startAttachmentUpload(params = {}, callback) ⇒ AWS.Request

new AWS.ConnectParticipant(options = {}) ⇒ `Object`

endpoint ⇒ `AWS.Endpoint` (readwrite)

completeAttachmentUpload(params = {}, callback) ⇒ `AWS.Request`

createParticipantConnection(params = {}, callback) ⇒ `AWS.Request`

disconnectParticipant(params = {}, callback) ⇒ `AWS.Request`

getAttachment(params = {}, callback) ⇒ `AWS.Request`

getTranscript(params = {}, callback) ⇒ `AWS.Request`

sendEvent(params = {}, callback) ⇒ `AWS.Request`

sendMessage(params = {}, callback) ⇒ `AWS.Request`

startAttachmentUpload(params = {}, callback) ⇒ `AWS.Request`