@aws-sdk/client-connect 3.363.0 → 3.366.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-types/commands/CreateEvaluationFormCommand.d.ts +4 -3
- package/dist-types/commands/CreateParticipantCommand.d.ts +1 -1
- package/dist-types/commands/CreatePromptCommand.d.ts +3 -1
- package/dist-types/commands/CreateQueueCommand.d.ts +4 -0
- package/dist-types/commands/DeleteEvaluationFormCommand.d.ts +2 -2
- package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +2 -1
- package/dist-types/commands/SearchQueuesCommand.d.ts +1 -2
- package/dist-types/commands/SearchResourceTagsCommand.d.ts +2 -2
- package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +1 -2
- package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +1 -2
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +4 -3
- package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +4 -3
- package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +11 -11
- package/dist-types/models/models_1.d.ts +19 -16
- package/dist-types/models/models_2.d.ts +3 -3
- package/package.json +1 -1
|
@@ -24,9 +24,10 @@ export interface CreateEvaluationFormCommandOutput extends CreateEvaluationFormR
|
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* @public
|
|
27
|
-
* <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be
|
|
28
|
-
* questions related to agent performance, and create sections to organize such
|
|
29
|
-
* cannot be duplicated within the same evaluation
|
|
27
|
+
* <p>Creates an evaluation form in the specified Amazon Connect instance. The form can be
|
|
28
|
+
* used to define questions related to agent performance, and create sections to organize such
|
|
29
|
+
* questions. Question and section identifiers cannot be duplicated within the same evaluation
|
|
30
|
+
* form.</p>
|
|
30
31
|
* @example
|
|
31
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
32
33
|
* ```javascript
|
|
@@ -24,7 +24,7 @@ export interface CreateParticipantCommandOutput extends CreateParticipantRespons
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>Adds a new participant into an on-going chat contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html">Customize chat
|
|
27
|
-
*
|
|
27
|
+
* flow experiences by integrating custom participants</a>.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -23,7 +23,9 @@ export interface CreatePromptCommandOutput extends CreatePromptResponse, __Metad
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Creates a prompt. For more information about prompts, such as supported file types and
|
|
26
|
+
* <p>Creates a prompt. For more information about prompts, such as supported file types and
|
|
27
|
+
* maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator's
|
|
28
|
+
* Guide</i>.</p>
|
|
27
29
|
* @example
|
|
28
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
31
|
* ```javascript
|
|
@@ -35,6 +35,10 @@ export interface CreateQueueCommandOutput extends CreateQueueResponse, __Metadat
|
|
|
35
35
|
* in
|
|
36
36
|
* this scenario, you will receive a
|
|
37
37
|
* <code>ResourceNotFoundException</code>.</p>
|
|
38
|
+
* <p>Only use the phone number ARN format that doesn't contain <code>instance</code> in the
|
|
39
|
+
* path, for example, <code>arn:aws:connect:us-east-1:1234567890:phone-number/uuid</code>. This is
|
|
40
|
+
* the same ARN format that is returned when you call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a>
|
|
41
|
+
* API.</p>
|
|
38
42
|
* </important>
|
|
39
43
|
* @example
|
|
40
44
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -26,8 +26,8 @@ export interface DeleteEvaluationFormCommandOutput extends __MetadataBearer {
|
|
|
26
26
|
* <p>Deletes an evaluation form in the specified Amazon Connect instance. </p>
|
|
27
27
|
* <ul>
|
|
28
28
|
* <li>
|
|
29
|
-
* <p>If the version
|
|
30
|
-
*
|
|
29
|
+
* <p>If the version property is provided, only the specified version of the evaluation form is
|
|
30
|
+
* deleted.</p>
|
|
31
31
|
* </li>
|
|
32
32
|
* <li>
|
|
33
33
|
* <p>If no version is provided, then the full form (all versions) is deleted.</p>
|
|
@@ -24,7 +24,8 @@ export interface SearchHoursOfOperationsCommandOutput extends SearchHoursOfOpera
|
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* @public
|
|
27
|
-
* <p>Searches the hours of operation in an Amazon Connect instance, with optional
|
|
27
|
+
* <p>Searches the hours of operation in an Amazon Connect instance, with optional
|
|
28
|
+
* filtering.</p>
|
|
28
29
|
* @example
|
|
29
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
31
|
* ```javascript
|
|
@@ -24,8 +24,7 @@ export interface SearchQueuesCommandOutput extends SearchQueuesResponse, __Metad
|
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* @public
|
|
27
|
-
* <p>
|
|
28
|
-
* <p>Searches queues in an Amazon Connect instance, with optional filtering.</p>
|
|
27
|
+
* <p>Searches queues in an Amazon Connect instance, with optional filtering.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
|
@@ -76,8 +76,8 @@ export interface SearchResourceTagsCommandOutput extends SearchResourceTagsRespo
|
|
|
76
76
|
* <p>The request is not valid.</p>
|
|
77
77
|
*
|
|
78
78
|
* @throws {@link MaximumResultReturnedException} (client fault)
|
|
79
|
-
* <p>Maximum number (1000) of tags have been returned with current request. Consider
|
|
80
|
-
*
|
|
79
|
+
* <p>Maximum number (1000) of tags have been returned with current request. Consider changing
|
|
80
|
+
* request parameters to get more tags.</p>
|
|
81
81
|
*
|
|
82
82
|
* @throws {@link ResourceNotFoundException} (client fault)
|
|
83
83
|
* <p>The specified resource was not found.</p>
|
|
@@ -24,8 +24,7 @@ export interface SearchRoutingProfilesCommandOutput extends SearchRoutingProfile
|
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* @public
|
|
27
|
-
* <p>
|
|
28
|
-
* <p>Searches routing profiles in an Amazon Connect instance, with optional filtering.</p>
|
|
27
|
+
* <p>Searches routing profiles in an Amazon Connect instance, with optional filtering.</p>
|
|
29
28
|
* @example
|
|
30
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
31
30
|
* ```javascript
|
|
@@ -24,8 +24,7 @@ export interface SearchSecurityProfilesCommandOutput extends SearchSecurityProfi
|
|
|
24
24
|
}
|
|
25
25
|
/**
|
|
26
26
|
* @public
|
|
27
|
-
* <p>
|
|
28
|
-
* <p>Searches security profiles in an Amazon Connect instance, with optional
|
|
27
|
+
* <p>Searches security profiles in an Amazon Connect instance, with optional
|
|
29
28
|
* filtering.</p>
|
|
30
29
|
* @example
|
|
31
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -24,9 +24,10 @@ export interface SuspendContactRecordingCommandOutput extends SuspendContactReco
|
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
26
|
* <p>When a contact is being recorded, this API suspends recording the call or screen. For
|
|
27
|
-
* example, you might suspend the call or screen recording while collecting sensitive
|
|
28
|
-
*
|
|
29
|
-
* <p>The period of time that the recording is suspended is filled with silence in the final
|
|
27
|
+
* example, you might suspend the call or screen recording while collecting sensitive information,
|
|
28
|
+
* such as a credit card number. Then use ResumeContactRecording to restart recording.</p>
|
|
29
|
+
* <p>The period of time that the recording is suspended is filled with silence in the final
|
|
30
|
+
* recording.</p>
|
|
30
31
|
* <p>Voice and screen recordings are supported.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -25,9 +25,10 @@ export interface UpdateEvaluationFormCommandOutput extends UpdateEvaluationFormR
|
|
|
25
25
|
/**
|
|
26
26
|
* @public
|
|
27
27
|
* <p>Updates details about a specific evaluation form version in the specified Amazon Connect
|
|
28
|
-
* instance. Question and section
|
|
29
|
-
*
|
|
30
|
-
* <p>This operation does not support partial updates. Instead it does a full update of evaluation
|
|
28
|
+
* instance. Question and section identifiers cannot be duplicated within the same evaluation
|
|
29
|
+
* form.</p>
|
|
30
|
+
* <p>This operation does not support partial updates. Instead it does a full update of evaluation
|
|
31
|
+
* form content.</p>
|
|
31
32
|
* @example
|
|
32
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
34
|
* ```javascript
|
|
@@ -36,6 +36,10 @@ export interface UpdateQueueOutboundCallerConfigCommandOutput extends __Metadata
|
|
|
36
36
|
* in
|
|
37
37
|
* this scenario, you will receive a
|
|
38
38
|
* <code>ResourceNotFoundException</code>.</p>
|
|
39
|
+
* <p>Only use the phone number ARN format that doesn't contain <code>instance</code> in the
|
|
40
|
+
* path, for example, <code>arn:aws:connect:us-east-1:1234567890:phone-number/uuid</code>. This is
|
|
41
|
+
* the same ARN format that is returned when you call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a>
|
|
42
|
+
* API.</p>
|
|
39
43
|
* </important>
|
|
40
44
|
* @example
|
|
41
45
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -50,8 +50,8 @@ export interface ActivateEvaluationFormRequest {
|
|
|
50
50
|
*/
|
|
51
51
|
EvaluationFormId: string | undefined;
|
|
52
52
|
/**
|
|
53
|
-
* <p>The version of the evaluation form to activate. If the version property is not provided, the
|
|
54
|
-
* evaluation form is activated.</p>
|
|
53
|
+
* <p>The version of the evaluation form to activate. If the version property is not provided, the
|
|
54
|
+
* latest version of the evaluation form is activated.</p>
|
|
55
55
|
*/
|
|
56
56
|
EvaluationFormVersion: number | undefined;
|
|
57
57
|
}
|
|
@@ -1262,10 +1262,10 @@ export interface SingleSelectQuestionRuleCategoryAutomation {
|
|
|
1262
1262
|
*/
|
|
1263
1263
|
Category: string | undefined;
|
|
1264
1264
|
/**
|
|
1265
|
-
* <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>,
|
|
1266
|
-
* option is applied when the contact data includes the category. Similarly, if the
|
|
1267
|
-
* <code>NOT_PRESENT</code>, then the option is applied when the contact data does not
|
|
1268
|
-
* category.</p>
|
|
1265
|
+
* <p>The condition to apply for the automation option. If the condition is <code>PRESENT</code>,
|
|
1266
|
+
* then the option is applied when the contact data includes the category. Similarly, if the
|
|
1267
|
+
* condition is <code>NOT_PRESENT</code>, then the option is applied when the contact data does not
|
|
1268
|
+
* include the category.</p>
|
|
1269
1269
|
*/
|
|
1270
1270
|
Condition: SingleSelectQuestionRuleCategoryAutomationCondition | string | undefined;
|
|
1271
1271
|
/**
|
|
@@ -1797,8 +1797,8 @@ export interface ParticipantTokenCredentials {
|
|
|
1797
1797
|
*/
|
|
1798
1798
|
export interface CreateParticipantResponse {
|
|
1799
1799
|
/**
|
|
1800
|
-
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The
|
|
1801
|
-
* token is valid for the lifetime of a chat participant.</p>
|
|
1800
|
+
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The
|
|
1801
|
+
* participant token is valid for the lifetime of a chat participant.</p>
|
|
1802
1802
|
*/
|
|
1803
1803
|
ParticipantCredentials?: ParticipantTokenCredentials;
|
|
1804
1804
|
/**
|
|
@@ -3481,9 +3481,9 @@ export interface Contact {
|
|
|
3481
3481
|
* when the contact arrived. For <code>OUTBOUND</code>, this is when the agent began dialing. For
|
|
3482
3482
|
* <code>CALLBACK</code>, this is when the callback contact was created. For <code>TRANSFER</code>
|
|
3483
3483
|
* and <code>QUEUE_TRANSFER</code>, this is when the transfer was initiated. For <code>API</code>,
|
|
3484
|
-
* this is when the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent
|
|
3485
|
-
* dialing the external participant. For <code>MONITOR</code>, this is when the supervisor
|
|
3486
|
-
* listening to a contact.</p>
|
|
3484
|
+
* this is when the request arrived. For <code>EXTERNAL_OUTBOUND</code>, this is when the agent
|
|
3485
|
+
* started dialing the external participant. For <code>MONITOR</code>, this is when the supervisor
|
|
3486
|
+
* started listening to a contact.</p>
|
|
3487
3487
|
*/
|
|
3488
3488
|
InitiationTimestamp?: Date;
|
|
3489
3489
|
/**
|
|
@@ -711,7 +711,8 @@ export interface MetricFilterV2 {
|
|
|
711
711
|
* <p>The key to use for filtering data. </p>
|
|
712
712
|
* <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.
|
|
713
713
|
* These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>
|
|
714
|
-
* in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's
|
|
714
|
+
* in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's
|
|
715
|
+
* Guide</i>. </p>
|
|
715
716
|
*/
|
|
716
717
|
MetricFilterKey?: string;
|
|
717
718
|
/**
|
|
@@ -825,10 +826,10 @@ export interface GetMetricDataV2Request {
|
|
|
825
826
|
* <li>
|
|
826
827
|
* <p>
|
|
827
828
|
* <b>Filter values</b>: A maximum of 100 filter values are
|
|
828
|
-
* supported in a single request.
|
|
829
|
-
*
|
|
830
|
-
*
|
|
831
|
-
*
|
|
829
|
+
* supported in a single request. VOICE, CHAT, and TASK are valid <code>filterValue</code> for the CHANNEL
|
|
830
|
+
* filter key. They do not count towards limitation of 100 filter values. For example, a
|
|
831
|
+
* GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total
|
|
832
|
+
* of 100 filter values, along with 3 channel filters.</p>
|
|
832
833
|
* </li>
|
|
833
834
|
* </ul>
|
|
834
835
|
*/
|
|
@@ -3804,8 +3805,8 @@ export interface SearchQuickConnectsResponse {
|
|
|
3804
3805
|
}
|
|
3805
3806
|
/**
|
|
3806
3807
|
* @public
|
|
3807
|
-
* <p>Maximum number (1000) of tags have been returned with current request. Consider
|
|
3808
|
-
*
|
|
3808
|
+
* <p>Maximum number (1000) of tags have been returned with current request. Consider changing
|
|
3809
|
+
* request parameters to get more tags.</p>
|
|
3809
3810
|
*/
|
|
3810
3811
|
export declare class MaximumResultReturnedException extends __BaseException {
|
|
3811
3812
|
readonly name: "MaximumResultReturnedException";
|
|
@@ -3830,11 +3831,13 @@ export interface TagSearchCondition {
|
|
|
3830
3831
|
*/
|
|
3831
3832
|
tagValue?: string;
|
|
3832
3833
|
/**
|
|
3833
|
-
* <p>The type of comparison to be made when evaluating the tag key in tag search
|
|
3834
|
+
* <p>The type of comparison to be made when evaluating the tag key in tag search
|
|
3835
|
+
* condition.</p>
|
|
3834
3836
|
*/
|
|
3835
3837
|
tagKeyComparisonType?: StringComparisonType | string;
|
|
3836
3838
|
/**
|
|
3837
|
-
* <p>The type of comparison to be made when evaluating the tag value in tag search
|
|
3839
|
+
* <p>The type of comparison to be made when evaluating the tag value in tag search
|
|
3840
|
+
* condition.</p>
|
|
3838
3841
|
*/
|
|
3839
3842
|
tagValueComparisonType?: StringComparisonType | string;
|
|
3840
3843
|
}
|
|
@@ -3858,13 +3861,13 @@ export interface SearchResourceTagsRequest {
|
|
|
3858
3861
|
*/
|
|
3859
3862
|
InstanceId: string | undefined;
|
|
3860
3863
|
/**
|
|
3861
|
-
* <p>The list of resource types to be used to search tags from. If not provided or if any empty
|
|
3862
|
-
* is provided, this API will search from all supported resource types.</p>
|
|
3864
|
+
* <p>The list of resource types to be used to search tags from. If not provided or if any empty
|
|
3865
|
+
* list is provided, this API will search from all supported resource types.</p>
|
|
3863
3866
|
*/
|
|
3864
3867
|
ResourceTypes?: string[];
|
|
3865
3868
|
/**
|
|
3866
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
3867
|
-
* next request to retrieve the next set of results.</p>
|
|
3869
|
+
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
3870
|
+
* the next request to retrieve the next set of results.</p>
|
|
3868
3871
|
*/
|
|
3869
3872
|
NextToken?: string;
|
|
3870
3873
|
/**
|
|
@@ -6299,7 +6302,7 @@ export interface HoursOfOperationSearchCriteria {
|
|
|
6299
6302
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6300
6303
|
* <note>
|
|
6301
6304
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
6302
|
-
*
|
|
6305
|
+
* <code>description</code>, <code>timezone</code>, and <code>resourceID</code>.</p>
|
|
6303
6306
|
* </note>
|
|
6304
6307
|
*/
|
|
6305
6308
|
StringCondition?: StringCondition;
|
|
@@ -6321,7 +6324,7 @@ export interface PromptSearchCriteria {
|
|
|
6321
6324
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6322
6325
|
* <note>
|
|
6323
6326
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
6324
|
-
*
|
|
6327
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
6325
6328
|
* </note>
|
|
6326
6329
|
*/
|
|
6327
6330
|
StringCondition?: StringCondition;
|
|
@@ -6348,7 +6351,7 @@ export interface QueueSearchCriteria {
|
|
|
6348
6351
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6349
6352
|
* <note>
|
|
6350
6353
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
6351
|
-
*
|
|
6354
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
6352
6355
|
* </note>
|
|
6353
6356
|
*/
|
|
6354
6357
|
StringCondition?: StringCondition;
|
|
@@ -17,7 +17,7 @@ export interface QuickConnectSearchCriteria {
|
|
|
17
17
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
18
18
|
* <note>
|
|
19
19
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
20
|
-
*
|
|
20
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
21
21
|
* </note>
|
|
22
22
|
*/
|
|
23
23
|
StringCondition?: StringCondition;
|
|
@@ -44,7 +44,7 @@ export interface RoutingProfileSearchCriteria {
|
|
|
44
44
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
45
45
|
* <note>
|
|
46
46
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
47
|
-
*
|
|
47
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
48
48
|
* </note>
|
|
49
49
|
*/
|
|
50
50
|
StringCondition?: StringCondition;
|
|
@@ -140,7 +140,7 @@ export interface UserSearchCriteria {
|
|
|
140
140
|
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
141
141
|
* <note>
|
|
142
142
|
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
143
|
-
*
|
|
143
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
144
144
|
* </note>
|
|
145
145
|
*/
|
|
146
146
|
StringCondition?: StringCondition;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-connect",
|
|
3
3
|
"description": "AWS SDK for JavaScript Connect Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.366.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|