docs(client-connectparticipant): Doc only update to GetTranscript API…

… reference guide to inform users about presence of events in the chat transcript.
aws · Feb 16, 2024 · fe761fa · fe761fa
1 parent 43bff29
commit fe761fa
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 36 deletions.
diff --git a/clients/client-connectparticipant/src/commands/CompleteAttachmentUploadCommand.ts b/clients/client-connectparticipant/src/commands/CompleteAttachmentUploadCommand.ts
@@ -33,7 +33,8 @@ export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmen
 /**
  * @public
  * <p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL
- *             provided in StartAttachmentUpload API. </p>
+ *             provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment
+ *             with that identifier is already being uploaded.</p>
  *          <note>
  *             <p>
  *                <code>ConnectionToken</code> is used for invoking this API instead of
@@ -70,7 +71,8 @@ export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmen
  *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>An attachment with that identifier is already being uploaded.</p>
+ *  <p>The requested operation conflicts with the current state of a service
+ *             resource associated with the request. </p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>This exception occurs when there is an internal failure in the Amazon Connect service.</p>

diff --git a/clients/client-connectparticipant/src/commands/GetTranscriptCommand.ts b/clients/client-connectparticipant/src/commands/GetTranscriptCommand.ts
@@ -34,11 +34,41 @@ export interface GetTranscriptCommandOutput extends GetTranscriptResponse, __Met
  * @public
  * <p>Retrieves a transcript of the session, including details about any attachments. For
  *             information about accessing past chat contact transcripts for a persistent chat, see
- *                 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>. </p>
+ *             <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>. </p>
+ *          <p>If you have a process that consumes events in the transcript of an chat that has ended, note that chat
+ *             transcripts contain the following event content types if the event has occurred
+ *             during the chat session:</p>
+ *          <ul>
+ *             <li>
+ *                <p>
+ *                   <code>application/vnd.amazonaws.connect.event.participant.left</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>application/vnd.amazonaws.connect.event.participant.joined</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>application/vnd.amazonaws.connect.event.chat.ended</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>application/vnd.amazonaws.connect.event.transfer.succeeded</code>
+ *                </p>
+ *             </li>
+ *             <li>
+ *                <p>
+ *                   <code>application/vnd.amazonaws.connect.event.transfer.failed</code>
+ *                </p>
+ *             </li>
+ *          </ul>
  *          <note>
  *             <p>
  *                <code>ConnectionToken</code> is used for invoking this API instead of
- *                     <code>ParticipantToken</code>.</p>
+ *                 <code>ParticipantToken</code>.</p>
  *          </note>
  *          <p>The Amazon Connect Participant Service APIs do not use <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature Version 4
  *                     authentication</a>.</p>

diff --git a/clients/client-connectparticipant/src/commands/SendEventCommand.ts b/clients/client-connectparticipant/src/commands/SendEventCommand.ts
@@ -32,7 +32,15 @@ export interface SendEventCommandOutput extends SendEventResponse, __MetadataBea
 
 /**
  * @public
- * <p>Sends an event. </p>
+ * <note>
+ *             <p>The <code>application/vnd.amazonaws.connect.event.connection.acknowledged</code>
+ *                 ContentType will no longer be supported starting December 31, 2024. This event has
+ *                 been migrated to the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API using the
+ *                     <code>ConnectParticipant</code> field.</p>
+ *          </note>
+ *          <p>Sends an event. Message receipts are not supported when there are more than two active
+ *             participants in the chat. Using the SendEvent API for message receipts when a supervisor
+ *             is barged-in will result in a conflict exception.</p>
  *          <note>
  *             <p>
  *                <code>ConnectionToken</code> is used for invoking this API instead of
@@ -71,7 +79,8 @@ export interface SendEventCommandOutput extends SendEventResponse, __MetadataBea
  *  <p>You do not have sufficient access to perform this action.</p>
  *
  * @throws {@link ConflictException} (client fault)
- *  <p>An attachment with that identifier is already being uploaded.</p>
+ *  <p>The requested operation conflicts with the current state of a service
+ *             resource associated with the request. </p>
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>This exception occurs when there is an internal failure in the Amazon Connect service.</p>

diff --git a/clients/client-connectparticipant/src/models/models_0.ts b/clients/client-connectparticipant/src/models/models_0.ts
@@ -58,7 +58,8 @@ export interface CompleteAttachmentUploadResponse {}
 
 /**
  * @public
- * <p>An attachment with that identifier is already being uploaded.</p>
+ * <p>The requested operation conflicts with the current state of a service
+ *             resource associated with the request. </p>
  */
 export class ConflictException extends __BaseException {
   readonly name: "ConflictException" = "ConflictException";
@@ -186,9 +187,9 @@ export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType
 export interface CreateParticipantConnectionRequest {
   /**
    * @public
-   * <p>Type of connection information required. If you need <code>CONNECTION_CREDENTIALS</code> along with marking
-   *             participant as connected, pass <code>CONNECTION_CREDENTIALS</code> in
-   *             <code>Type</code>.</p>
+   * <p>Type of connection information required. If you need
+   *                 <code>CONNECTION_CREDENTIALS</code> along with marking participant as connected,
+   *             pass <code>CONNECTION_CREDENTIALS</code> in <code>Type</code>.</p>
    */
   Type?: ConnectionType[];
 
@@ -273,8 +274,8 @@ export interface CreateParticipantConnectionResponse {
 export interface DescribeViewRequest {
   /**
    * @public
-   * <p>An encrypted token originating from the interactive message of a ShowView block operation.
-   *             Represents the desired view.</p>
+   * <p>An encrypted token originating from the interactive message of a ShowView block
+   *             operation. Represents the desired view.</p>
    */
   ViewToken: string | undefined;
 
@@ -287,12 +288,14 @@ export interface DescribeViewRequest {
 
 /**
  * @public
- * <p>View content containing all content necessary to render a view except for runtime input data.</p>
+ * <p>View content containing all content necessary to render a view except for runtime
+ *             input data.</p>
  */
 export interface ViewContent {
   /**
    * @public
-   * <p>The schema representing the input data that the view template must be supplied to render.</p>
+   * <p>The schema representing the input data that the view template must be supplied to
+   *             render.</p>
    */
   InputSchema?: string;
 
@@ -311,7 +314,8 @@ export interface ViewContent {
 
 /**
  * @public
- * <p>A view resource object. Contains metadata and content necessary to render the view.</p>
+ * <p>A view resource object. Contains metadata and content necessary to render the
+ *             view.</p>
  */
 export interface View {
   /**
@@ -340,7 +344,8 @@ export interface View {
 
   /**
    * @public
-   * <p>View content containing all content necessary to render a view except for runtime input data.</p>
+   * <p>View content containing all content necessary to render a view except for runtime
+   *             input data.</p>
    */
   Content?: ViewContent;
 }
@@ -351,7 +356,8 @@ export interface View {
 export interface DescribeViewResponse {
   /**
    * @public
-   * <p>A view resource object. Contains metadata and content necessary to render the view.</p>
+   * <p>A view resource object. Contains metadata and content necessary to render the
+   *             view.</p>
    */
   View?: View;
 }
@@ -825,7 +831,8 @@ export interface SendEventRequest {
    *                <p>application/vnd.amazonaws.connect.event.typing</p>
    *             </li>
    *             <li>
-   *                <p>application/vnd.amazonaws.connect.event.connection.acknowledged</p>
+   *                <p>application/vnd.amazonaws.connect.event.connection.acknowledged (will be
+   *                     deprecated on December 31, 2024) </p>
    *             </li>
    *             <li>
    *                <p>application/vnd.amazonaws.connect.event.message.delivered</p>
@@ -887,8 +894,8 @@ export interface SendMessageRequest {
   /**
    * @public
    * <p>The type of the content. Supported types are <code>text/plain</code>,
-   *             <code>text/markdown</code>, <code>application/json</code>, and
-   *             <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
+   *                 <code>text/markdown</code>, <code>application/json</code>, and
+   *                 <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
    */
   ContentType: string | undefined;
 
@@ -905,8 +912,9 @@ export interface SendMessageRequest {
    *                     Maximum of 12000. </p>
    *             </li>
    *             <li>
-   *                <p>For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the Length
-   *                     Constraints are Minimum of 1, Maximum of 12288.</p>
+   *                <p>For
+   *                         <code>application/vnd.amazonaws.connect.message.interactive.response</code>,
+   *                     the Length Constraints are Minimum of 1, Maximum of 12288.</p>
    *             </li>
    *          </ul>
    */