@aws-sdk/client-connectparticipant 3.863.0 → 3.870.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist-cjs/index.js CHANGED
@@ -23,6 +23,7 @@ var index_exports = {};
23
23
  __export(index_exports, {
24
24
  AccessDeniedException: () => AccessDeniedException,
25
25
  ArtifactStatus: () => ArtifactStatus,
26
+ AttendeeFilterSensitiveLog: () => AttendeeFilterSensitiveLog,
26
27
  CancelParticipantAuthenticationCommand: () => CancelParticipantAuthenticationCommand,
27
28
  ChatItemType: () => ChatItemType,
28
29
  CompleteAttachmentUploadCommand: () => CompleteAttachmentUploadCommand,
@@ -30,8 +31,10 @@ __export(index_exports, {
30
31
  ConnectParticipant: () => ConnectParticipant,
31
32
  ConnectParticipantClient: () => ConnectParticipantClient,
32
33
  ConnectParticipantServiceException: () => ConnectParticipantServiceException,
34
+ ConnectionDataFilterSensitiveLog: () => ConnectionDataFilterSensitiveLog,
33
35
  ConnectionType: () => ConnectionType,
34
36
  CreateParticipantConnectionCommand: () => CreateParticipantConnectionCommand,
37
+ CreateParticipantConnectionResponseFilterSensitiveLog: () => CreateParticipantConnectionResponseFilterSensitiveLog,
35
38
  DescribeViewCommand: () => DescribeViewCommand,
36
39
  DescribeViewResponseFilterSensitiveLog: () => DescribeViewResponseFilterSensitiveLog,
37
40
  DisconnectParticipantCommand: () => DisconnectParticipantCommand,
@@ -39,6 +42,7 @@ __export(index_exports, {
39
42
  GetAuthenticationUrlCommand: () => GetAuthenticationUrlCommand,
40
43
  GetTranscriptCommand: () => GetTranscriptCommand,
41
44
  InternalServerException: () => InternalServerException,
45
+ MeetingFeatureStatus: () => MeetingFeatureStatus,
42
46
  ParticipantRole: () => ParticipantRole,
43
47
  ResourceNotFoundException: () => ResourceNotFoundException,
44
48
  ResourceType: () => ResourceType,
@@ -352,8 +356,13 @@ var ServiceQuotaExceededException = class _ServiceQuotaExceededException extends
352
356
  };
353
357
  var ConnectionType = {
354
358
  CONNECTION_CREDENTIALS: "CONNECTION_CREDENTIALS",
359
+ WEBRTC_CONNECTION: "WEBRTC_CONNECTION",
355
360
  WEBSOCKET: "WEBSOCKET"
356
361
  };
362
+ var MeetingFeatureStatus = {
363
+ AVAILABLE: "AVAILABLE",
364
+ UNAVAILABLE: "UNAVAILABLE"
365
+ };
357
366
  var ResourceType = {
358
367
  CONTACT: "CONTACT",
359
368
  CONTACT_FLOW: "CONTACT_FLOW",
@@ -430,6 +439,18 @@ var ChatItemType = {
430
439
  TRANSFER_SUCCEEDED: "TRANSFER_SUCCEEDED",
431
440
  TYPING: "TYPING"
432
441
  };
442
+ var AttendeeFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
443
+ ...obj,
444
+ ...obj.JoinToken && { JoinToken: import_smithy_client.SENSITIVE_STRING }
445
+ }), "AttendeeFilterSensitiveLog");
446
+ var ConnectionDataFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
447
+ ...obj,
448
+ ...obj.Attendee && { Attendee: AttendeeFilterSensitiveLog(obj.Attendee) }
449
+ }), "ConnectionDataFilterSensitiveLog");
450
+ var CreateParticipantConnectionResponseFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
451
+ ...obj,
452
+ ...obj.WebRTCConnection && { WebRTCConnection: ConnectionDataFilterSensitiveLog(obj.WebRTCConnection) }
453
+ }), "CreateParticipantConnectionResponseFilterSensitiveLog");
433
454
  var ViewContentFilterSensitiveLog = /* @__PURE__ */ __name((obj) => ({
434
455
  ...obj,
435
456
  ...obj.InputSchema && { InputSchema: import_smithy_client.SENSITIVE_STRING },
@@ -664,6 +685,7 @@ var de_CreateParticipantConnectionCommand = /* @__PURE__ */ __name(async (output
664
685
  const data = (0, import_smithy_client.expectNonNull)((0, import_smithy_client.expectObject)(await (0, import_core2.parseJsonBody)(output.body, context)), "body");
665
686
  const doc = (0, import_smithy_client.take)(data, {
666
687
  ConnectionCredentials: import_smithy_client._json,
688
+ WebRTCConnection: import_smithy_client._json,
667
689
  Websocket: import_smithy_client._json
668
690
  });
669
691
  Object.assign(contents, doc);
@@ -961,7 +983,7 @@ var CreateParticipantConnectionCommand = class extends import_smithy_client.Comm
961
983
  (0, import_middleware_serde.getSerdePlugin)(config, this.serialize, this.deserialize),
962
984
  (0, import_middleware_endpoint.getEndpointPlugin)(config, Command.getEndpointParameterInstructions())
963
985
  ];
964
- }).s("AmazonConnectParticipantServiceLambda", "CreateParticipantConnection", {}).n("ConnectParticipantClient", "CreateParticipantConnectionCommand").f(void 0, void 0).ser(se_CreateParticipantConnectionCommand).de(de_CreateParticipantConnectionCommand).build() {
986
+ }).s("AmazonConnectParticipantServiceLambda", "CreateParticipantConnection", {}).n("ConnectParticipantClient", "CreateParticipantConnectionCommand").f(void 0, CreateParticipantConnectionResponseFilterSensitiveLog).ser(se_CreateParticipantConnectionCommand).de(de_CreateParticipantConnectionCommand).build() {
965
987
  static {
966
988
  __name(this, "CreateParticipantConnectionCommand");
967
989
  }
@@ -1138,6 +1160,7 @@ var paginateGetTranscript = (0, import_core.createPaginator)(ConnectParticipantC
1138
1160
  ConflictException,
1139
1161
  ServiceQuotaExceededException,
1140
1162
  ConnectionType,
1163
+ MeetingFeatureStatus,
1141
1164
  ResourceType,
1142
1165
  ResourceNotFoundException,
1143
1166
  ScanDirection,
@@ -1145,6 +1168,9 @@ var paginateGetTranscript = (0, import_core.createPaginator)(ConnectParticipantC
1145
1168
  ArtifactStatus,
1146
1169
  ParticipantRole,
1147
1170
  ChatItemType,
1171
+ AttendeeFilterSensitiveLog,
1172
+ ConnectionDataFilterSensitiveLog,
1173
+ CreateParticipantConnectionResponseFilterSensitiveLog,
1148
1174
  ViewContentFilterSensitiveLog,
1149
1175
  ViewFilterSensitiveLog,
1150
1176
  DescribeViewResponseFilterSensitiveLog
@@ -2,6 +2,7 @@ import { getEndpointPlugin } from "@smithy/middleware-endpoint";
2
2
  import { getSerdePlugin } from "@smithy/middleware-serde";
3
3
  import { Command as $Command } from "@smithy/smithy-client";
4
4
  import { commonParams } from "../endpoint/EndpointParameters";
5
+ import { CreateParticipantConnectionResponseFilterSensitiveLog, } from "../models/models_0";
5
6
  import { de_CreateParticipantConnectionCommand, se_CreateParticipantConnectionCommand, } from "../protocols/Aws_restJson1";
6
7
  export { $Command };
7
8
  export class CreateParticipantConnectionCommand extends $Command
@@ -15,7 +16,7 @@ export class CreateParticipantConnectionCommand extends $Command
15
16
  })
16
17
  .s("AmazonConnectParticipantServiceLambda", "CreateParticipantConnection", {})
17
18
  .n("ConnectParticipantClient", "CreateParticipantConnectionCommand")
18
- .f(void 0, void 0)
19
+ .f(void 0, CreateParticipantConnectionResponseFilterSensitiveLog)
19
20
  .ser(se_CreateParticipantConnectionCommand)
20
21
  .de(de_CreateParticipantConnectionCommand)
21
22
  .build() {
@@ -86,8 +86,13 @@ export class ServiceQuotaExceededException extends __BaseException {
86
86
  }
87
87
  export const ConnectionType = {
88
88
  CONNECTION_CREDENTIALS: "CONNECTION_CREDENTIALS",
89
+ WEBRTC_CONNECTION: "WEBRTC_CONNECTION",
89
90
  WEBSOCKET: "WEBSOCKET",
90
91
  };
92
+ export const MeetingFeatureStatus = {
93
+ AVAILABLE: "AVAILABLE",
94
+ UNAVAILABLE: "UNAVAILABLE",
95
+ };
91
96
  export const ResourceType = {
92
97
  CONTACT: "CONTACT",
93
98
  CONTACT_FLOW: "CONTACT_FLOW",
@@ -150,6 +155,18 @@ export const ChatItemType = {
150
155
  TRANSFER_SUCCEEDED: "TRANSFER_SUCCEEDED",
151
156
  TYPING: "TYPING",
152
157
  };
158
+ export const AttendeeFilterSensitiveLog = (obj) => ({
159
+ ...obj,
160
+ ...(obj.JoinToken && { JoinToken: SENSITIVE_STRING }),
161
+ });
162
+ export const ConnectionDataFilterSensitiveLog = (obj) => ({
163
+ ...obj,
164
+ ...(obj.Attendee && { Attendee: AttendeeFilterSensitiveLog(obj.Attendee) }),
165
+ });
166
+ export const CreateParticipantConnectionResponseFilterSensitiveLog = (obj) => ({
167
+ ...obj,
168
+ ...(obj.WebRTCConnection && { WebRTCConnection: ConnectionDataFilterSensitiveLog(obj.WebRTCConnection) }),
169
+ });
153
170
  export const ViewContentFilterSensitiveLog = (obj) => ({
154
171
  ...obj,
155
172
  ...(obj.InputSchema && { InputSchema: SENSITIVE_STRING }),
@@ -201,6 +201,7 @@ export const de_CreateParticipantConnectionCommand = async (output, context) =>
201
201
  const data = __expectNonNull(__expectObject(await parseBody(output.body, context)), "body");
202
202
  const doc = take(data, {
203
203
  ConnectionCredentials: _json,
204
+ WebRTCConnection: _json,
204
205
  Websocket: _json,
205
206
  });
206
207
  Object.assign(contents, doc);
@@ -33,6 +33,13 @@ declare const CancelParticipantAuthenticationCommand_base: {
33
33
  * <p>The current supported channel is chat. This API is not supported for Apple
34
34
  * Messages for Business, WhatsApp, or SMS chats.</p>
35
35
  * </note>
36
+ * <note>
37
+ * <p>
38
+ * <code>ConnectionToken</code> is used for invoking this API instead of
39
+ * <code>ParticipantToken</code>.</p>
40
+ * </note>
41
+ * <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
42
+ * authentication</a>.</p>
36
43
  * @example
37
44
  * Use a bare-bones client and the command you need to make an API call.
38
45
  * ```javascript
@@ -30,7 +30,7 @@ declare const CompleteAttachmentUploadCommand_base: {
30
30
  * <p>Allows you to confirm that the attachment has been uploaded using the pre-signed URL
31
31
  * provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment
32
32
  * with that identifier is already being uploaded.</p>
33
- * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p>
33
+ * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>
34
34
  * <note>
35
35
  * <p>
36
36
  * <code>ConnectionToken</code> is used for invoking this API instead of
@@ -28,17 +28,20 @@ declare const CreateParticipantConnectionCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Creates the participant's connection. </p>
31
- * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p>
31
+ * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>
32
+ * <p>For WebRTC security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-webrtc-security">Amazon Connect WebRTC security best practices</a>. </p>
32
33
  * <note>
33
34
  * <p>
34
35
  * <code>ParticipantToken</code> is used for invoking this API instead of
35
36
  * <code>ConnectionToken</code>.</p>
36
37
  * </note>
37
38
  * <p>The participant token is valid for the lifetime of the participant – until they are
38
- * part of a contact.</p>
39
- * <p>The response URL for <code>WEBSOCKET</code> Type has a connect expiry timeout of 100s.
40
- * Clients must manually connect to the returned websocket URL and subscribe to the desired
41
- * topic. </p>
39
+ * part of a contact. For WebRTC participants, if they leave or are disconnected for 60
40
+ * seconds, a new participant needs to be created using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateParticipant.html">CreateParticipant</a> API. </p>
41
+ * <p>
42
+ * <b>For <code>WEBSOCKET</code> Type</b>: </p>
43
+ * <p>The response URL for has a connect expiry timeout of 100s. Clients must manually
44
+ * connect to the returned websocket URL and subscribe to the desired topic. </p>
42
45
  * <p>For chat, you need to publish the following on the established websocket
43
46
  * connection:</p>
44
47
  * <p>
@@ -47,6 +50,18 @@ declare const CreateParticipantConnectionCommand_base: {
47
50
  * <p>Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter,
48
51
  * clients need to call this API again to obtain a new websocket URL and perform the same
49
52
  * steps as before.</p>
53
+ * <p>The expiry time for the connection token is different than the
54
+ * <code>ChatDurationInMinutes</code>. Expiry time for the connection token is 1
55
+ * day.</p>
56
+ * <p>
57
+ * <b>For <code>WEBRTC_CONNECTION</code> Type</b>: </p>
58
+ * <p>The response includes connection data required for the client application to join the
59
+ * call using the Amazon Chime SDK client libraries. The WebRTCConnection response contains
60
+ * Meeting and Attendee information needed to establish the media connection. </p>
61
+ * <p>The attendee join token in WebRTCConnection response is valid for the lifetime of the
62
+ * participant in the call. If a participant leaves or is disconnected for 60 seconds,
63
+ * their participant credentials will no longer be valid, and a new participant will need
64
+ * to be created to rejoin the call. </p>
50
65
  * <p>
51
66
  * <b>Message streaming support</b>: This API can also be used
52
67
  * together with the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a> API to create a participant connection for chat
@@ -55,9 +70,16 @@ declare const CreateParticipantConnectionCommand_base: {
55
70
  * message streaming</a> in the <i>Amazon Connect Administrator
56
71
  * Guide</i>.</p>
57
72
  * <p>
73
+ * <b>Multi-user web, in-app, video calling support</b>: </p>
74
+ * <p>For WebRTC calls, this API is used in conjunction with the CreateParticipant API to
75
+ * enable multi-party calling. The StartWebRTCContact API creates the initial contact and
76
+ * routes it to an agent, while CreateParticipant adds additional participants to the
77
+ * ongoing call. For more information about multi-party WebRTC calls, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-multiuser-inapp.html">Enable multi-user web, in-app, and video calling</a> in the <i>Amazon Connect
78
+ * Administrator Guide</i>. </p>
79
+ * <p>
58
80
  * <b>Feature specifications</b>: For information about feature
59
- * specifications, such as the allowed number of open websocket connections per
60
- * participant, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator
81
+ * specifications, such as the allowed number of open websocket connections per participant
82
+ * or maximum number of WebRTC participants, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator
61
83
  * Guide</i>. </p>
62
84
  * <note>
63
85
  * <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
@@ -71,7 +93,7 @@ declare const CreateParticipantConnectionCommand_base: {
71
93
  * const client = new ConnectParticipantClient(config);
72
94
  * const input = { // CreateParticipantConnectionRequest
73
95
  * Type: [ // ConnectionTypeList
74
- * "WEBSOCKET" || "CONNECTION_CREDENTIALS",
96
+ * "WEBSOCKET" || "CONNECTION_CREDENTIALS" || "WEBRTC_CONNECTION",
75
97
  * ],
76
98
  * ParticipantToken: "STRING_VALUE", // required
77
99
  * ConnectParticipant: true || false,
@@ -87,6 +109,28 @@ declare const CreateParticipantConnectionCommand_base: {
87
109
  * // ConnectionToken: "STRING_VALUE",
88
110
  * // Expiry: "STRING_VALUE",
89
111
  * // },
112
+ * // WebRTCConnection: { // ConnectionData
113
+ * // Attendee: { // Attendee
114
+ * // AttendeeId: "STRING_VALUE",
115
+ * // JoinToken: "STRING_VALUE",
116
+ * // },
117
+ * // Meeting: { // Meeting
118
+ * // MediaRegion: "STRING_VALUE",
119
+ * // MediaPlacement: { // MediaPlacement
120
+ * // AudioHostUrl: "STRING_VALUE",
121
+ * // AudioFallbackUrl: "STRING_VALUE",
122
+ * // SignalingUrl: "STRING_VALUE",
123
+ * // TurnControlUrl: "STRING_VALUE",
124
+ * // EventIngestionUrl: "STRING_VALUE",
125
+ * // },
126
+ * // MeetingFeatures: { // MeetingFeaturesConfiguration
127
+ * // Audio: { // AudioFeatures
128
+ * // EchoReduction: "AVAILABLE" || "UNAVAILABLE",
129
+ * // },
130
+ * // },
131
+ * // MeetingId: "STRING_VALUE",
132
+ * // },
133
+ * // },
90
134
  * // };
91
135
  *
92
136
  * ```
@@ -28,7 +28,7 @@ declare const DescribeViewCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Retrieves the view for the specified view token.</p>
31
- * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p>
31
+ * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -28,7 +28,7 @@ declare const DisconnectParticipantCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Disconnects a participant. </p>
31
- * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p>
31
+ * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>
32
32
  * <note>
33
33
  * <p>
34
34
  * <code>ConnectionToken</code> is used for invoking this API instead of
@@ -29,11 +29,21 @@ declare const GetAttachmentCommand_base: {
29
29
  /**
30
30
  * <p>Provides a pre-signed URL for download of a completed attachment. This is an
31
31
  * asynchronous API for use with active contacts.</p>
32
- * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p>
32
+ * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>
33
33
  * <note>
34
- * <p>
35
- * <code>ConnectionToken</code> is used for invoking this API instead of
36
- * <code>ParticipantToken</code>.</p>
34
+ * <ul>
35
+ * <li>
36
+ * <p>The participant role <code>CUSTOM_BOT</code> is not permitted to access
37
+ * attachments customers may upload. An <code>AccessDeniedException</code> can
38
+ * indicate that the participant may be a CUSTOM_BOT, and it doesn't have
39
+ * access to attachments.</p>
40
+ * </li>
41
+ * <li>
42
+ * <p>
43
+ * <code>ConnectionToken</code> is used for invoking this API instead of
44
+ * <code>ParticipantToken</code>.</p>
45
+ * </li>
46
+ * </ul>
37
47
  * </note>
38
48
  * <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
39
49
  * authentication</a>.</p>
@@ -42,6 +42,13 @@ declare const GetAuthenticationUrlCommand_base: {
42
42
  * </li>
43
43
  * </ul>
44
44
  * </note>
45
+ * <note>
46
+ * <p>
47
+ * <code>ConnectionToken</code> is used for invoking this API instead of
48
+ * <code>ParticipantToken</code>.</p>
49
+ * </note>
50
+ * <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
51
+ * authentication</a>.</p>
45
52
  * @example
46
53
  * Use a bare-bones client and the command you need to make an API call.
47
54
  * ```javascript
@@ -30,14 +30,14 @@ declare const GetTranscriptCommand_base: {
30
30
  * <p>Retrieves a transcript of the session, including details about any attachments. For
31
31
  * information about accessing past chat contact transcripts for a persistent chat, see
32
32
  * <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a>. </p>
33
- * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p>
33
+ * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>
34
34
  * <p>If you have a process that consumes events in the transcript of an chat that has
35
35
  * ended, note that chat transcripts contain the following event content types if the event
36
36
  * has occurred during the chat session:</p>
37
37
  * <ul>
38
38
  * <li>
39
39
  * <p>
40
- * <code>application/vnd.amazonaws.connect.event.participant.left</code>
40
+ * <code>application/vnd.amazonaws.connect.event.participant.invited</code>
41
41
  * </p>
42
42
  * </li>
43
43
  * <li>
@@ -47,6 +47,11 @@ declare const GetTranscriptCommand_base: {
47
47
  * </li>
48
48
  * <li>
49
49
  * <p>
50
+ * <code>application/vnd.amazonaws.connect.event.participant.left</code>
51
+ * </p>
52
+ * </li>
53
+ * <li>
54
+ * <p>
50
55
  * <code>application/vnd.amazonaws.connect.event.chat.ended</code>
51
56
  * </p>
52
57
  * </li>
@@ -29,14 +29,14 @@ declare const SendEventCommand_base: {
29
29
  /**
30
30
  * <note>
31
31
  * <p>The <code>application/vnd.amazonaws.connect.event.connection.acknowledged</code>
32
- * ContentType will no longer be supported starting December 31, 2024. This event has
33
- * been migrated to the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API using the
32
+ * ContentType is no longer maintained since December 31, 2024. This event has been
33
+ * migrated to the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API using the
34
34
  * <code>ConnectParticipant</code> field.</p>
35
35
  * </note>
36
36
  * <p>Sends an event. Message receipts are not supported when there are more than two active
37
37
  * participants in the chat. Using the SendEvent API for message receipts when a supervisor
38
38
  * is barged-in will result in a conflict exception.</p>
39
- * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p>
39
+ * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>
40
40
  * <note>
41
41
  * <p>
42
42
  * <code>ConnectionToken</code> is used for invoking this API instead of
@@ -28,7 +28,7 @@ declare const SendMessageCommand_base: {
28
28
  };
29
29
  /**
30
30
  * <p>Sends a message.</p>
31
- * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p>
31
+ * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>
32
32
  * <note>
33
33
  * <p>
34
34
  * <code>ConnectionToken</code> is used for invoking this API instead of
@@ -29,7 +29,7 @@ declare const StartAttachmentUploadCommand_base: {
29
29
  /**
30
30
  * <p>Provides a pre-signed Amazon S3 URL in response for uploading the file directly to
31
31
  * S3.</p>
32
- * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>.</p>
32
+ * <p>For security recommendations, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a>. </p>
33
33
  * <note>
34
34
  * <p>
35
35
  * <code>ConnectionToken</code> is used for invoking this API instead of
@@ -134,6 +134,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
134
134
  */
135
135
  export declare const ConnectionType: {
136
136
  readonly CONNECTION_CREDENTIALS: "CONNECTION_CREDENTIALS";
137
+ readonly WEBRTC_CONNECTION: "WEBRTC_CONNECTION";
137
138
  readonly WEBSOCKET: "WEBSOCKET";
138
139
  };
139
140
  /**
@@ -184,6 +185,129 @@ export interface ConnectionCredentials {
184
185
  */
185
186
  Expiry?: string | undefined;
186
187
  }
188
+ /**
189
+ * <p>The attendee information, including attendee ID and join token.</p>
190
+ * @public
191
+ */
192
+ export interface Attendee {
193
+ /**
194
+ * <p>The Amazon Chime SDK attendee ID.</p>
195
+ * @public
196
+ */
197
+ AttendeeId?: string | undefined;
198
+ /**
199
+ * <p>The join token used by the Amazon Chime SDK attendee.</p>
200
+ * @public
201
+ */
202
+ JoinToken?: string | undefined;
203
+ }
204
+ /**
205
+ * <p>A set of endpoints used by clients to connect to the media service group for an Amazon Chime SDK meeting.</p>
206
+ * @public
207
+ */
208
+ export interface MediaPlacement {
209
+ /**
210
+ * <p>The audio host URL.</p>
211
+ * @public
212
+ */
213
+ AudioHostUrl?: string | undefined;
214
+ /**
215
+ * <p>The audio fallback URL.</p>
216
+ * @public
217
+ */
218
+ AudioFallbackUrl?: string | undefined;
219
+ /**
220
+ * <p>The signaling URL.</p>
221
+ * @public
222
+ */
223
+ SignalingUrl?: string | undefined;
224
+ /**
225
+ * <p>The turn control URL.</p>
226
+ * @public
227
+ */
228
+ TurnControlUrl?: string | undefined;
229
+ /**
230
+ * <p>The event ingestion URL to which you send client meeting events.</p>
231
+ * @public
232
+ */
233
+ EventIngestionUrl?: string | undefined;
234
+ }
235
+ /**
236
+ * @public
237
+ * @enum
238
+ */
239
+ export declare const MeetingFeatureStatus: {
240
+ readonly AVAILABLE: "AVAILABLE";
241
+ readonly UNAVAILABLE: "UNAVAILABLE";
242
+ };
243
+ /**
244
+ * @public
245
+ */
246
+ export type MeetingFeatureStatus = (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus];
247
+ /**
248
+ * <p>Has audio-specific configurations as the operating parameter for Echo Reduction.</p>
249
+ * @public
250
+ */
251
+ export interface AudioFeatures {
252
+ /**
253
+ * <p>Makes echo reduction available to clients who connect to the meeting.</p>
254
+ * @public
255
+ */
256
+ EchoReduction?: MeetingFeatureStatus | undefined;
257
+ }
258
+ /**
259
+ * <p>The configuration settings of the features available to a meeting.</p>
260
+ * @public
261
+ */
262
+ export interface MeetingFeaturesConfiguration {
263
+ /**
264
+ * <p>The configuration settings for the audio features available to a meeting.</p>
265
+ * @public
266
+ */
267
+ Audio?: AudioFeatures | undefined;
268
+ }
269
+ /**
270
+ * <p>A meeting created using the Amazon Chime SDK.</p>
271
+ * @public
272
+ */
273
+ export interface Meeting {
274
+ /**
275
+ * <p>The Amazon Web Services Region in which you create the meeting.</p>
276
+ * @public
277
+ */
278
+ MediaRegion?: string | undefined;
279
+ /**
280
+ * <p>The media placement for the meeting.</p>
281
+ * @public
282
+ */
283
+ MediaPlacement?: MediaPlacement | undefined;
284
+ /**
285
+ * <p>The configuration settings of the features available to a meeting.</p>
286
+ * @public
287
+ */
288
+ MeetingFeatures?: MeetingFeaturesConfiguration | undefined;
289
+ /**
290
+ * <p>The Amazon Chime SDK meeting ID.</p>
291
+ * @public
292
+ */
293
+ MeetingId?: string | undefined;
294
+ }
295
+ /**
296
+ * <p>Information required to join the call.</p>
297
+ * @public
298
+ */
299
+ export interface ConnectionData {
300
+ /**
301
+ * <p>The attendee information, including attendee ID and join token.</p>
302
+ * @public
303
+ */
304
+ Attendee?: Attendee | undefined;
305
+ /**
306
+ * <p>A meeting created using the Amazon Chime SDK.</p>
307
+ * @public
308
+ */
309
+ Meeting?: Meeting | undefined;
310
+ }
187
311
  /**
188
312
  * <p>The websocket for the participant's connection.</p>
189
313
  * @public
@@ -217,6 +341,12 @@ export interface CreateParticipantConnectionResponse {
217
341
  * @public
218
342
  */
219
343
  ConnectionCredentials?: ConnectionCredentials | undefined;
344
+ /**
345
+ * <p>Creates the participant's WebRTC connection data required for the client application
346
+ * (mobile application or website) to connect to the call. </p>
347
+ * @public
348
+ */
349
+ WebRTCConnection?: ConnectionData | undefined;
220
350
  }
221
351
  /**
222
352
  * @public
@@ -748,8 +878,8 @@ export interface SendEventRequest {
748
878
  * <p>application/vnd.amazonaws.connect.event.typing</p>
749
879
  * </li>
750
880
  * <li>
751
- * <p>application/vnd.amazonaws.connect.event.connection.acknowledged (will be
752
- * deprecated on December 31, 2024) </p>
881
+ * <p>application/vnd.amazonaws.connect.event.connection.acknowledged (is no longer
882
+ * maintained since December 31, 2024) </p>
753
883
  * </li>
754
884
  * <li>
755
885
  * <p>application/vnd.amazonaws.connect.event.message.delivered</p>
@@ -804,9 +934,15 @@ export interface SendEventResponse {
804
934
  */
805
935
  export interface SendMessageRequest {
806
936
  /**
807
- * <p>The type of the content. Supported types are <code>text/plain</code>,
937
+ * <p>The type of the content. Possible types are <code>text/plain</code>,
808
938
  * <code>text/markdown</code>, <code>application/json</code>, and
809
- * <code>application/vnd.amazonaws.connect.message.interactive.response</code>.</p>
939
+ * <code>application/vnd.amazonaws.connect.message.interactive.response</code>.
940
+ * </p>
941
+ * <p>Supported types on the contact are configured through
942
+ * <code>SupportedMessagingContentTypes</code> on <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartChatContact.html">StartChatContact</a>
943
+ * and <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html">StartOutboundChatContact</a>.</p>
944
+ * <p> For Apple Messages for Business, SMS, and WhatsApp Business Messaging contacts, only
945
+ * <code>text/plain</code> is supported.</p>
810
946
  * @public
811
947
  */
812
948
  ContentType: string | undefined;
@@ -931,6 +1067,18 @@ export interface StartAttachmentUploadResponse {
931
1067
  */
932
1068
  UploadMetadata?: UploadMetadata | undefined;
933
1069
  }
1070
+ /**
1071
+ * @internal
1072
+ */
1073
+ export declare const AttendeeFilterSensitiveLog: (obj: Attendee) => any;
1074
+ /**
1075
+ * @internal
1076
+ */
1077
+ export declare const ConnectionDataFilterSensitiveLog: (obj: ConnectionData) => any;
1078
+ /**
1079
+ * @internal
1080
+ */
1081
+ export declare const CreateParticipantConnectionResponseFilterSensitiveLog: (obj: CreateParticipantConnectionResponse) => any;
934
1082
  /**
935
1083
  * @internal
936
1084
  */
@@ -59,6 +59,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
59
59
  }
60
60
  export declare const ConnectionType: {
61
61
  readonly CONNECTION_CREDENTIALS: "CONNECTION_CREDENTIALS";
62
+ readonly WEBRTC_CONNECTION: "WEBRTC_CONNECTION";
62
63
  readonly WEBSOCKET: "WEBSOCKET";
63
64
  };
64
65
  export type ConnectionType =
@@ -72,6 +73,39 @@ export interface ConnectionCredentials {
72
73
  ConnectionToken?: string | undefined;
73
74
  Expiry?: string | undefined;
74
75
  }
76
+ export interface Attendee {
77
+ AttendeeId?: string | undefined;
78
+ JoinToken?: string | undefined;
79
+ }
80
+ export interface MediaPlacement {
81
+ AudioHostUrl?: string | undefined;
82
+ AudioFallbackUrl?: string | undefined;
83
+ SignalingUrl?: string | undefined;
84
+ TurnControlUrl?: string | undefined;
85
+ EventIngestionUrl?: string | undefined;
86
+ }
87
+ export declare const MeetingFeatureStatus: {
88
+ readonly AVAILABLE: "AVAILABLE";
89
+ readonly UNAVAILABLE: "UNAVAILABLE";
90
+ };
91
+ export type MeetingFeatureStatus =
92
+ (typeof MeetingFeatureStatus)[keyof typeof MeetingFeatureStatus];
93
+ export interface AudioFeatures {
94
+ EchoReduction?: MeetingFeatureStatus | undefined;
95
+ }
96
+ export interface MeetingFeaturesConfiguration {
97
+ Audio?: AudioFeatures | undefined;
98
+ }
99
+ export interface Meeting {
100
+ MediaRegion?: string | undefined;
101
+ MediaPlacement?: MediaPlacement | undefined;
102
+ MeetingFeatures?: MeetingFeaturesConfiguration | undefined;
103
+ MeetingId?: string | undefined;
104
+ }
105
+ export interface ConnectionData {
106
+ Attendee?: Attendee | undefined;
107
+ Meeting?: Meeting | undefined;
108
+ }
75
109
  export interface Websocket {
76
110
  Url?: string | undefined;
77
111
  ConnectionExpiry?: string | undefined;
@@ -79,6 +113,7 @@ export interface Websocket {
79
113
  export interface CreateParticipantConnectionResponse {
80
114
  Websocket?: Websocket | undefined;
81
115
  ConnectionCredentials?: ConnectionCredentials | undefined;
116
+ WebRTCConnection?: ConnectionData | undefined;
82
117
  }
83
118
  export interface DescribeViewRequest {
84
119
  ViewToken: string | undefined;
@@ -268,6 +303,13 @@ export interface StartAttachmentUploadResponse {
268
303
  AttachmentId?: string | undefined;
269
304
  UploadMetadata?: UploadMetadata | undefined;
270
305
  }
306
+ export declare const AttendeeFilterSensitiveLog: (obj: Attendee) => any;
307
+ export declare const ConnectionDataFilterSensitiveLog: (
308
+ obj: ConnectionData
309
+ ) => any;
310
+ export declare const CreateParticipantConnectionResponseFilterSensitiveLog: (
311
+ obj: CreateParticipantConnectionResponse
312
+ ) => any;
271
313
  export declare const ViewContentFilterSensitiveLog: (obj: ViewContent) => any;
272
314
  export declare const ViewFilterSensitiveLog: (obj: View) => any;
273
315
  export declare const DescribeViewResponseFilterSensitiveLog: (
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-connectparticipant",
3
3
  "description": "AWS SDK for JavaScript Connectparticipant Client for Node.js, Browser and React Native",
4
- "version": "3.863.0",
4
+ "version": "3.870.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-connectparticipant",
@@ -20,17 +20,17 @@
20
20
  "dependencies": {
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
- "@aws-sdk/core": "3.863.0",
24
- "@aws-sdk/credential-provider-node": "3.863.0",
23
+ "@aws-sdk/core": "3.864.0",
24
+ "@aws-sdk/credential-provider-node": "3.864.0",
25
25
  "@aws-sdk/middleware-host-header": "3.862.0",
26
26
  "@aws-sdk/middleware-logger": "3.862.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.862.0",
28
- "@aws-sdk/middleware-user-agent": "3.863.0",
28
+ "@aws-sdk/middleware-user-agent": "3.864.0",
29
29
  "@aws-sdk/region-config-resolver": "3.862.0",
30
30
  "@aws-sdk/types": "3.862.0",
31
31
  "@aws-sdk/util-endpoints": "3.862.0",
32
32
  "@aws-sdk/util-user-agent-browser": "3.862.0",
33
- "@aws-sdk/util-user-agent-node": "3.863.0",
33
+ "@aws-sdk/util-user-agent-node": "3.864.0",
34
34
  "@smithy/config-resolver": "^4.1.5",
35
35
  "@smithy/core": "^3.8.0",
36
36
  "@smithy/fetch-http-handler": "^5.1.1",