Skip to content

Commit fe761fa

Browse files
author
awstools
committed
docs(client-connectparticipant): Doc only update to GetTranscript API reference guide to inform users about presence of events in the chat transcript.
1 parent 43bff29 commit fe761fa

File tree

5 files changed

+85
-36
lines changed

5 files changed

+85
-36
lines changed

‎clients/client-connectparticipant/src/commands/CompleteAttachmentUploadCommand.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmen
3333
/**
3434
* @public
3535
* <p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL
36-
* provided in StartAttachmentUpload API. </p>
36+
* provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment
37+
* with that identifier is already being uploaded.</p>
3738
* <note>
3839
* <p>
3940
* <code>ConnectionToken</code> is used for invoking this API instead of
@@ -70,7 +71,8 @@ export interface CompleteAttachmentUploadCommandOutput extends CompleteAttachmen
7071
* <p>You do not have sufficient access to perform this action.</p>
7172
*
7273
* @throws {@link ConflictException} (client fault)
73-
* <p>An attachment with that identifier is already being uploaded.</p>
74+
* <p>The requested operation conflicts with the current state of a service
75+
* resource associated with the request. </p>
7476
*
7577
* @throws {@link InternalServerException} (server fault)
7678
* <p>This exception occurs when there is an internal failure in the Amazon Connect service.</p>

‎clients/client-connectparticipant/src/commands/GetTranscriptCommand.ts

+32-2
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,41 @@ export interface GetTranscriptCommandOutput extends GetTranscriptResponse, __Met
3434
* @public
3535
* <p>Retrieves a transcript of the session, including details about any attachments. For
3636
* information about accessing past chat contact transcripts for a persistent chat, see
37-
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>. </p>
37+
* <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>. </p>
38+
* <p>If you have a process that consumes events in the transcript of an chat that has ended, note that chat
39+
* transcripts contain the following event content types if the event has occurred
40+
* during the chat session:</p>
41+
* <ul>
42+
* <li>
43+
* <p>
44+
* <code>application/vnd.amazonaws.connect.event.participant.left</code>
45+
* </p>
46+
* </li>
47+
* <li>
48+
* <p>
49+
* <code>application/vnd.amazonaws.connect.event.participant.joined</code>
50+
* </p>
51+
* </li>
52+
* <li>
53+
* <p>
54+
* <code>application/vnd.amazonaws.connect.event.chat.ended</code>
55+
* </p>
56+
* </li>
57+
* <li>
58+
* <p>
59+
* <code>application/vnd.amazonaws.connect.event.transfer.succeeded</code>
60+
* </p>
61+
* </li>
62+
* <li>
63+
* <p>
64+
* <code>application/vnd.amazonaws.connect.event.transfer.failed</code>
65+
* </p>
66+
* </li>
67+
* </ul>
3868
* <note>
3969
* <p>
4070
* <code>ConnectionToken</code> is used for invoking this API instead of
41-
* <code>ParticipantToken</code>.</p>
71+
* <code>ParticipantToken</code>.</p>
4272
* </note>
4373
* <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
4474
* authentication</a>.</p>

‎clients/client-connectparticipant/src/commands/SendEventCommand.ts

+11-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,15 @@ export interface SendEventCommandOutput extends SendEventResponse, __MetadataBea
3232

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

‎clients/client-connectparticipant/src/models/models_0.ts

+24-16
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,8 @@ export interface CompleteAttachmentUploadResponse {}
5858

5959
/**
6060
* @public
61-
* <p>An attachment with that identifier is already being uploaded.</p>
61+
* <p>The requested operation conflicts with the current state of a service
62+
* resource associated with the request. </p>
6263
*/
6364
export class ConflictException extends __BaseException {
6465
readonly name: "ConflictException" = "ConflictException";
@@ -186,9 +187,9 @@ export type ConnectionType = (typeof ConnectionType)[keyof typeof ConnectionType
186187
export interface CreateParticipantConnectionRequest {
187188
/**
188189
* @public
189-
* <p>Type of connection information required. If you need <code>CONNECTION_CREDENTIALS</code> along with marking
190-
* participant as connected, pass <code>CONNECTION_CREDENTIALS</code> in
191-
* <code>Type</code>.</p>
190+
* <p>Type of connection information required. If you need
191+
* <code>CONNECTION_CREDENTIALS</code> along with marking participant as connected,
192+
* pass <code>CONNECTION_CREDENTIALS</code> in <code>Type</code>.</p>
192193
*/
193194
Type?: ConnectionType[];
194195

@@ -273,8 +274,8 @@ export interface CreateParticipantConnectionResponse {
273274
export interface DescribeViewRequest {
274275
/**
275276
* @public
276-
* <p>An encrypted token originating from the interactive message of a ShowView block operation.
277-
* Represents the desired view.</p>
277+
* <p>An encrypted token originating from the interactive message of a ShowView block
278+
* operation. Represents the desired view.</p>
278279
*/
279280
ViewToken: string | undefined;
280281

@@ -287,12 +288,14 @@ export interface DescribeViewRequest {
287288

288289
/**
289290
* @public
290-
* <p>View content containing all content necessary to render a view except for runtime input data.</p>
291+
* <p>View content containing all content necessary to render a view except for runtime
292+
* input data.</p>
291293
*/
292294
export interface ViewContent {
293295
/**
294296
* @public
295-
* <p>The schema representing the input data that the view template must be supplied to render.</p>
297+
* <p>The schema representing the input data that the view template must be supplied to
298+
* render.</p>
296299
*/
297300
InputSchema?: string;
298301

@@ -311,7 +314,8 @@ export interface ViewContent {
311314

312315
/**
313316
* @public
314-
* <p>A view resource object. Contains metadata and content necessary to render the view.</p>
317+
* <p>A view resource object. Contains metadata and content necessary to render the
318+
* view.</p>
315319
*/
316320
export interface View {
317321
/**
@@ -340,7 +344,8 @@ export interface View {
340344

341345
/**
342346
* @public
343-
* <p>View content containing all content necessary to render a view except for runtime input data.</p>
347+
* <p>View content containing all content necessary to render a view except for runtime
348+
* input data.</p>
344349
*/
345350
Content?: ViewContent;
346351
}
@@ -351,7 +356,8 @@ export interface View {
351356
export interface DescribeViewResponse {
352357
/**
353358
* @public
354-
* <p>A view resource object. Contains metadata and content necessary to render the view.</p>
359+
* <p>A view resource object. Contains metadata and content necessary to render the
360+
* view.</p>
355361
*/
356362
View?: View;
357363
}
@@ -825,7 +831,8 @@ export interface SendEventRequest {
825831
* <p>application/vnd.amazonaws.connect.event.typing</p>
826832
* </li>
827833
* <li>
828-
* <p>application/vnd.amazonaws.connect.event.connection.acknowledged</p>
834+
* <p>application/vnd.amazonaws.connect.event.connection.acknowledged (will be
835+
* deprecated on December 31, 2024) </p>
829836
* </li>
830837
* <li>
831838
* <p>application/vnd.amazonaws.connect.event.message.delivered</p>
@@ -887,8 +894,8 @@ export interface SendMessageRequest {
887894
/**
888895
* @public
889896
* <p>The type of the content. Supported types are <code>text/plain</code>,
890-
* <code>text/markdown</code>, <code>application/json</code>, and
891-
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
897+
* <code>text/markdown</code>, <code>application/json</code>, and
898+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
892899
*/
893900
ContentType: string | undefined;
894901

@@ -905,8 +912,9 @@ export interface SendMessageRequest {
905912
* Maximum of 12000. </p>
906913
* </li>
907914
* <li>
908-
* <p>For <code>application/vnd.amazonaws.connect.message.interactive.response</code>, the Length
909-
* Constraints are Minimum of 1, Maximum of 12288.</p>
915+
* <p>For
916+
* <code>application/vnd.amazonaws.connect.message.interactive.response</code>,
917+
* the Length Constraints are Minimum of 1, Maximum of 12288.</p>
910918
* </li>
911919
* </ul>
912920
*/

0 commit comments

Comments
 (0)