@aws-sdk/client-connect 3.744.0 → 3.749.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/README.md +8 -0
- package/dist-cjs/index.js +72 -7
- package/dist-es/Connect.js +2 -0
- package/dist-es/commands/ListAnalyticsDataLakeDataSetsCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +50 -3
- package/dist-types/Connect.d.ts +7 -0
- package/dist-types/ConnectClient.d.ts +3 -2
- package/dist-types/commands/AssociateApprovedOriginCommand.d.ts +1 -0
- package/dist-types/commands/AssociateBotCommand.d.ts +1 -0
- package/dist-types/commands/AssociateInstanceStorageConfigCommand.d.ts +1 -0
- package/dist-types/commands/AssociateLambdaFunctionCommand.d.ts +1 -0
- package/dist-types/commands/AssociateLexBotCommand.d.ts +1 -0
- package/dist-types/commands/AssociateSecurityKeyCommand.d.ts +1 -0
- package/dist-types/commands/BatchAssociateAnalyticsDataSetCommand.d.ts +1 -0
- package/dist-types/commands/CreateContactCommand.d.ts +5 -1
- package/dist-types/commands/DeleteInstanceCommand.d.ts +1 -0
- package/dist-types/commands/DescribeAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/commands/DescribeContactCommand.d.ts +11 -3
- package/dist-types/commands/DisassociateApprovedOriginCommand.d.ts +1 -0
- package/dist-types/commands/DisassociateBotCommand.d.ts +1 -0
- package/dist-types/commands/DisassociateInstanceStorageConfigCommand.d.ts +1 -0
- package/dist-types/commands/DisassociateLambdaFunctionCommand.d.ts +1 -0
- package/dist-types/commands/DisassociateLexBotCommand.d.ts +1 -0
- package/dist-types/commands/DisassociateSecurityKeyCommand.d.ts +1 -0
- package/dist-types/commands/ImportPhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/ListAnalyticsDataAssociationsCommand.d.ts +1 -0
- package/dist-types/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +95 -0
- package/dist-types/commands/ListAuthenticationProfilesCommand.d.ts +1 -1
- package/dist-types/commands/ListQueuesCommand.d.ts +2 -1
- package/dist-types/commands/ListQuickConnectsCommand.d.ts +1 -2
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +1 -1
- package/dist-types/commands/StartChatContactCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAuthenticationProfileCommand.d.ts +1 -1
- package/dist-types/commands/UpdateInstanceAttributeCommand.d.ts +1 -0
- package/dist-types/commands/UpdateInstanceStorageConfigCommand.d.ts +1 -0
- package/dist-types/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.d.ts +1 -1
- package/dist-types/commands/UpdateTrafficDistributionCommand.d.ts +5 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +68 -4
- package/dist-types/models/models_1.d.ts +157 -92
- package/dist-types/models/models_2.d.ts +116 -76
- package/dist-types/models/models_3.d.ts +73 -5
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/Connect.d.ts +17 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/ListAnalyticsDataLakeDataSetsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListQueuesCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/ListQuickConnectsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdateRoutingProfileAgentAvailabilityTimerCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoutingProfileConcurrencyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateRoutingProfileDefaultOutboundQueueCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +8 -0
- package/dist-types/ts3.4/models/models_1.d.ts +19 -18
- package/dist-types/ts3.4/models/models_2.d.ts +22 -17
- package/dist-types/ts3.4/models/models_3.d.ts +17 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +11 -11
|
@@ -243,7 +243,7 @@ export interface DescribeAuthenticationProfileRequest {
|
|
|
243
243
|
}
|
|
244
244
|
/**
|
|
245
245
|
* <p>This API is in preview release for Amazon Connect and is subject to change. To
|
|
246
|
-
* request access to this API, contact Amazon Web
|
|
246
|
+
* request access to this API, contact Amazon Web ServicesSupport.</p>
|
|
247
247
|
* <p>Information about an authentication profile. An authentication profile is a resource that
|
|
248
248
|
* stores the authentication settings for users in your contact center. You use authentication
|
|
249
249
|
* profiles to set up IP address range restrictions and session timeouts. For more information, see
|
|
@@ -3158,6 +3158,14 @@ export interface DisassociateApprovedOriginRequest {
|
|
|
3158
3158
|
* @public
|
|
3159
3159
|
*/
|
|
3160
3160
|
Origin: string | undefined;
|
|
3161
|
+
/**
|
|
3162
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3163
|
+
* request. If not provided, the Amazon Web Services
|
|
3164
|
+
* SDK populates this field. For more information about idempotency, see
|
|
3165
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3166
|
+
* @public
|
|
3167
|
+
*/
|
|
3168
|
+
ClientToken?: string | undefined;
|
|
3161
3169
|
}
|
|
3162
3170
|
/**
|
|
3163
3171
|
* @public
|
|
@@ -3178,6 +3186,14 @@ export interface DisassociateBotRequest {
|
|
|
3178
3186
|
* @public
|
|
3179
3187
|
*/
|
|
3180
3188
|
LexV2Bot?: LexV2Bot | undefined;
|
|
3189
|
+
/**
|
|
3190
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3191
|
+
* request. If not provided, the Amazon Web Services
|
|
3192
|
+
* SDK populates this field. For more information about idempotency, see
|
|
3193
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3194
|
+
* @public
|
|
3195
|
+
*/
|
|
3196
|
+
ClientToken?: string | undefined;
|
|
3181
3197
|
}
|
|
3182
3198
|
/**
|
|
3183
3199
|
* @public
|
|
@@ -3235,6 +3251,14 @@ export interface DisassociateInstanceStorageConfigRequest {
|
|
|
3235
3251
|
* @public
|
|
3236
3252
|
*/
|
|
3237
3253
|
ResourceType: InstanceStorageResourceType | undefined;
|
|
3254
|
+
/**
|
|
3255
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3256
|
+
* request. If not provided, the Amazon Web Services
|
|
3257
|
+
* SDK populates this field. For more information about idempotency, see
|
|
3258
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3259
|
+
* @public
|
|
3260
|
+
*/
|
|
3261
|
+
ClientToken?: string | undefined;
|
|
3238
3262
|
}
|
|
3239
3263
|
/**
|
|
3240
3264
|
* @public
|
|
@@ -3250,6 +3274,14 @@ export interface DisassociateLambdaFunctionRequest {
|
|
|
3250
3274
|
* @public
|
|
3251
3275
|
*/
|
|
3252
3276
|
FunctionArn: string | undefined;
|
|
3277
|
+
/**
|
|
3278
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3279
|
+
* request. If not provided, the Amazon Web Services
|
|
3280
|
+
* SDK populates this field. For more information about idempotency, see
|
|
3281
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3282
|
+
* @public
|
|
3283
|
+
*/
|
|
3284
|
+
ClientToken?: string | undefined;
|
|
3253
3285
|
}
|
|
3254
3286
|
/**
|
|
3255
3287
|
* @public
|
|
@@ -3270,6 +3302,14 @@ export interface DisassociateLexBotRequest {
|
|
|
3270
3302
|
* @public
|
|
3271
3303
|
*/
|
|
3272
3304
|
LexRegion: string | undefined;
|
|
3305
|
+
/**
|
|
3306
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3307
|
+
* request. If not provided, the Amazon Web Services
|
|
3308
|
+
* SDK populates this field. For more information about idempotency, see
|
|
3309
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3310
|
+
* @public
|
|
3311
|
+
*/
|
|
3312
|
+
ClientToken?: string | undefined;
|
|
3273
3313
|
}
|
|
3274
3314
|
/**
|
|
3275
3315
|
* @public
|
|
@@ -3340,6 +3380,14 @@ export interface DisassociateSecurityKeyRequest {
|
|
|
3340
3380
|
* @public
|
|
3341
3381
|
*/
|
|
3342
3382
|
AssociationId: string | undefined;
|
|
3383
|
+
/**
|
|
3384
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
3385
|
+
* request. If not provided, the Amazon Web Services
|
|
3386
|
+
* SDK populates this field. For more information about idempotency, see
|
|
3387
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
3388
|
+
* @public
|
|
3389
|
+
*/
|
|
3390
|
+
ClientToken?: string | undefined;
|
|
3343
3391
|
}
|
|
3344
3392
|
/**
|
|
3345
3393
|
* @public
|
|
@@ -5103,14 +5151,16 @@ export interface GetMetricDataV2Request {
|
|
|
5103
5151
|
* <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |<code>CASE_TEMPLATE_ARN</code> |
|
|
5104
5152
|
* <code>CASE_STATUS</code> | <code>CHANNEL</code> |
|
|
5105
5153
|
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
|
|
5106
|
-
* <code>
|
|
5107
|
-
* <code>
|
|
5108
|
-
* <code>
|
|
5109
|
-
* <code>
|
|
5110
|
-
* <code>
|
|
5111
|
-
* <code>
|
|
5112
|
-
* <code>
|
|
5113
|
-
* <code>
|
|
5154
|
+
* <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> |
|
|
5155
|
+
* <code>EVALUATION_QUESTION</code> | <code>EVALUATION_SOURCE</code> | <code>FEATURE</code> |
|
|
5156
|
+
* <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> |
|
|
5157
|
+
* <code>FLOWS_NEXT_RESOURCE_ID</code> | <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> |
|
|
5158
|
+
* <code>FLOWS_OUTCOME_TYPE</code> | <code>FLOWS_RESOURCE_ID</code> | <code>FORM_VERSION</code> |
|
|
5159
|
+
* <code>INITIATION_METHOD</code> | <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> |
|
|
5160
|
+
* <code>INVOKING_RESOURCE_TYPE</code> | <code>PARENT_FLOWS_RESOURCE_ID</code> |
|
|
5161
|
+
* <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> |
|
|
5162
|
+
* <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> | <code>Q_CONNECT_ENABLED</code> |
|
|
5163
|
+
* </p>
|
|
5114
5164
|
* </li>
|
|
5115
5165
|
* <li>
|
|
5116
5166
|
* <p>
|
|
@@ -5164,13 +5214,19 @@ export interface GetMetricDataV2Request {
|
|
|
5164
5214
|
* <code>CAMPAIGN</code> | <code>CAMPAIGN_DELIVERY_EVENT_TYPE</code> |
|
|
5165
5215
|
* <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
|
|
5166
5216
|
* <code>contact/segmentAttributes/connect:Subtype</code> | <code>DISCONNECT_REASON</code> |
|
|
5217
|
+
* <code>EVALUATION_FORM</code> | <code>EVALUATION_SECTION</code> |
|
|
5218
|
+
* <code>EVALUATION_QUESTION</code> | <code>EVALUATION_SOURCE</code> |
|
|
5167
5219
|
* <code>FLOWS_RESOURCE_ID</code> | <code>FLOWS_MODULE_RESOURCE_ID</code> |
|
|
5168
5220
|
* <code>FLOW_ACTION_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_OUTCOME_TYPE</code> |
|
|
5169
|
-
* <code>
|
|
5170
|
-
* <code>
|
|
5171
|
-
* <code>
|
|
5172
|
-
*
|
|
5221
|
+
* <code>FORM_VERSION</code> | <code>INITIATION_METHOD</code> |
|
|
5222
|
+
* <code>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>INVOKING_RESOURCE_TYPE</code> |
|
|
5223
|
+
* <code>PARENT_FLOWS_RESOURCE_ID</code> | <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> |
|
|
5224
|
+
* <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> |
|
|
5225
|
+
* <code>ROUTING_STEP_EXPRESSION</code>
|
|
5173
5226
|
* </p>
|
|
5227
|
+
* <p>Type: Array of strings</p>
|
|
5228
|
+
* <p>Array Members: Maximum number of 4 items</p>
|
|
5229
|
+
* <p>Required: No</p>
|
|
5174
5230
|
* @public
|
|
5175
5231
|
*/
|
|
5176
5232
|
Groupings?: string[] | undefined;
|
|
@@ -5363,6 +5419,14 @@ export interface GetMetricDataV2Request {
|
|
|
5363
5419
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-dials-historical">Average dials per minute</a>
|
|
5364
5420
|
* </p>
|
|
5365
5421
|
* </dd>
|
|
5422
|
+
* <dt>AVG_EVALUATION_SCORE</dt>
|
|
5423
|
+
* <dd>
|
|
5424
|
+
* <p>Unit: Percent</p>
|
|
5425
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID,
|
|
5426
|
+
* Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile</p>
|
|
5427
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-evaluation-score-historical">Average agent evaluation score</a>
|
|
5428
|
+
* </p>
|
|
5429
|
+
* </dd>
|
|
5366
5430
|
* <dt>AVG_FLOW_TIME</dt>
|
|
5367
5431
|
* <dd>
|
|
5368
5432
|
* <p>Unit: Seconds</p>
|
|
@@ -5532,6 +5596,14 @@ export interface GetMetricDataV2Request {
|
|
|
5532
5596
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-wait-time-historical">Average wait time after customer connection</a>
|
|
5533
5597
|
* </p>
|
|
5534
5598
|
* </dd>
|
|
5599
|
+
* <dt>AVG_WEIGHTED_EVALUATION_SCORE</dt>
|
|
5600
|
+
* <dd>
|
|
5601
|
+
* <p>Unit: Percent</p>
|
|
5602
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID,
|
|
5603
|
+
* Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile</p>
|
|
5604
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-weighted-agent-evaluation-score-historical">Average weighted agent evaluation score</a>
|
|
5605
|
+
* </p>
|
|
5606
|
+
* </dd>
|
|
5535
5607
|
* <dt>BOT_CONVERSATIONS_COMPLETED</dt>
|
|
5536
5608
|
* <dd>
|
|
5537
5609
|
* <p>Unit: Count</p>
|
|
@@ -5794,6 +5866,14 @@ export interface GetMetricDataV2Request {
|
|
|
5794
5866
|
* delivery modes. </p>
|
|
5795
5867
|
* </note>
|
|
5796
5868
|
* </dd>
|
|
5869
|
+
* <dt>EVALUATIONS_PERFORMED</dt>
|
|
5870
|
+
* <dd>
|
|
5871
|
+
* <p>Unit: Count</p>
|
|
5872
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form
|
|
5873
|
+
* Version, Queue, Routing Profile</p>
|
|
5874
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#evaluations-performed-historical">Evaluations performed</a>
|
|
5875
|
+
* </p>
|
|
5876
|
+
* </dd>
|
|
5797
5877
|
* <dt>FLOWS_OUTCOME</dt>
|
|
5798
5878
|
* <dd>
|
|
5799
5879
|
* <p>Unit: Count</p>
|
|
@@ -5847,6 +5927,14 @@ export interface GetMetricDataV2Request {
|
|
|
5847
5927
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical">Minimum flow time</a>
|
|
5848
5928
|
* </p>
|
|
5849
5929
|
* </dd>
|
|
5930
|
+
* <dt>PERCENT_AUTOMATIC_FAILS</dt>
|
|
5931
|
+
* <dd>
|
|
5932
|
+
* <p>Unit: Percent</p>
|
|
5933
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form
|
|
5934
|
+
* Version, Queue, Routing Profile</p>
|
|
5935
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#percent-evaluation-automatic-failures-historical">Automatic fails percent</a>
|
|
5936
|
+
* </p>
|
|
5937
|
+
* </dd>
|
|
5850
5938
|
* <dt>PERCENT_BOT_CONVERSATIONS_OUTCOME</dt>
|
|
5851
5939
|
* <dd>
|
|
5852
5940
|
* <p>Unit: Percent</p>
|
|
@@ -6577,6 +6665,61 @@ export interface ListAnalyticsDataAssociationsResponse {
|
|
|
6577
6665
|
*/
|
|
6578
6666
|
NextToken?: string | undefined;
|
|
6579
6667
|
}
|
|
6668
|
+
/**
|
|
6669
|
+
* @public
|
|
6670
|
+
*/
|
|
6671
|
+
export interface ListAnalyticsDataLakeDataSetsRequest {
|
|
6672
|
+
/**
|
|
6673
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
6674
|
+
* @public
|
|
6675
|
+
*/
|
|
6676
|
+
InstanceId: string | undefined;
|
|
6677
|
+
/**
|
|
6678
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
6679
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
6680
|
+
* @public
|
|
6681
|
+
*/
|
|
6682
|
+
NextToken?: string | undefined;
|
|
6683
|
+
/**
|
|
6684
|
+
* <p>The maximum number of results to return per page.</p>
|
|
6685
|
+
* @public
|
|
6686
|
+
*/
|
|
6687
|
+
MaxResults?: number | undefined;
|
|
6688
|
+
}
|
|
6689
|
+
/**
|
|
6690
|
+
* <p>Information about datasets that are available to associate with: <code>DataSetId</code>,
|
|
6691
|
+
* <code>DataSetName</code>.</p>
|
|
6692
|
+
* @public
|
|
6693
|
+
*/
|
|
6694
|
+
export interface AnalyticsDataSetsResult {
|
|
6695
|
+
/**
|
|
6696
|
+
* <p>The identifier of the dataset.</p>
|
|
6697
|
+
* @public
|
|
6698
|
+
*/
|
|
6699
|
+
DataSetId?: string | undefined;
|
|
6700
|
+
/**
|
|
6701
|
+
* <p>The name of the dataset.</p>
|
|
6702
|
+
* @public
|
|
6703
|
+
*/
|
|
6704
|
+
DataSetName?: string | undefined;
|
|
6705
|
+
}
|
|
6706
|
+
/**
|
|
6707
|
+
* @public
|
|
6708
|
+
*/
|
|
6709
|
+
export interface ListAnalyticsDataLakeDataSetsResponse {
|
|
6710
|
+
/**
|
|
6711
|
+
* <p>An array of successful results: <code>DataSetId</code>, <code>DataSetName</code>. This is a
|
|
6712
|
+
* paginated API, so <code>nextToken</code> is given if there are more results to be
|
|
6713
|
+
* returned.</p>
|
|
6714
|
+
* @public
|
|
6715
|
+
*/
|
|
6716
|
+
Results?: AnalyticsDataSetsResult[] | undefined;
|
|
6717
|
+
/**
|
|
6718
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
6719
|
+
* @public
|
|
6720
|
+
*/
|
|
6721
|
+
NextToken?: string | undefined;
|
|
6722
|
+
}
|
|
6580
6723
|
/**
|
|
6581
6724
|
* @public
|
|
6582
6725
|
*/
|
|
@@ -6731,7 +6874,7 @@ export interface ListAuthenticationProfilesRequest {
|
|
|
6731
6874
|
}
|
|
6732
6875
|
/**
|
|
6733
6876
|
* <p>This API is in preview release for Amazon Connect and is subject to change. To
|
|
6734
|
-
* request access to this API, contact Amazon Web
|
|
6877
|
+
* request access to this API, contact Amazon Web ServicesSupport.</p>
|
|
6735
6878
|
* <p>A summary of a given authentication profile.</p>
|
|
6736
6879
|
* @public
|
|
6737
6880
|
*/
|
|
@@ -8678,84 +8821,6 @@ export interface ListQueuesRequest {
|
|
|
8678
8821
|
*/
|
|
8679
8822
|
MaxResults?: number | undefined;
|
|
8680
8823
|
}
|
|
8681
|
-
/**
|
|
8682
|
-
* <p>Contains summary information about a queue.</p>
|
|
8683
|
-
* @public
|
|
8684
|
-
*/
|
|
8685
|
-
export interface QueueSummary {
|
|
8686
|
-
/**
|
|
8687
|
-
* <p>The identifier of the queue.</p>
|
|
8688
|
-
* @public
|
|
8689
|
-
*/
|
|
8690
|
-
Id?: string | undefined;
|
|
8691
|
-
/**
|
|
8692
|
-
* <p>The Amazon Resource Name (ARN) of the queue.</p>
|
|
8693
|
-
* @public
|
|
8694
|
-
*/
|
|
8695
|
-
Arn?: string | undefined;
|
|
8696
|
-
/**
|
|
8697
|
-
* <p>The name of the queue.</p>
|
|
8698
|
-
* @public
|
|
8699
|
-
*/
|
|
8700
|
-
Name?: string | undefined;
|
|
8701
|
-
/**
|
|
8702
|
-
* <p>The type of queue.</p>
|
|
8703
|
-
* @public
|
|
8704
|
-
*/
|
|
8705
|
-
QueueType?: QueueType | undefined;
|
|
8706
|
-
/**
|
|
8707
|
-
* <p>The timestamp when this resource was last modified.</p>
|
|
8708
|
-
* @public
|
|
8709
|
-
*/
|
|
8710
|
-
LastModifiedTime?: Date | undefined;
|
|
8711
|
-
/**
|
|
8712
|
-
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
8713
|
-
* @public
|
|
8714
|
-
*/
|
|
8715
|
-
LastModifiedRegion?: string | undefined;
|
|
8716
|
-
}
|
|
8717
|
-
/**
|
|
8718
|
-
* @public
|
|
8719
|
-
*/
|
|
8720
|
-
export interface ListQueuesResponse {
|
|
8721
|
-
/**
|
|
8722
|
-
* <p>Information about the queues.</p>
|
|
8723
|
-
* @public
|
|
8724
|
-
*/
|
|
8725
|
-
QueueSummaryList?: QueueSummary[] | undefined;
|
|
8726
|
-
/**
|
|
8727
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8728
|
-
* @public
|
|
8729
|
-
*/
|
|
8730
|
-
NextToken?: string | undefined;
|
|
8731
|
-
}
|
|
8732
|
-
/**
|
|
8733
|
-
* @public
|
|
8734
|
-
*/
|
|
8735
|
-
export interface ListQuickConnectsRequest {
|
|
8736
|
-
/**
|
|
8737
|
-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8738
|
-
* @public
|
|
8739
|
-
*/
|
|
8740
|
-
InstanceId: string | undefined;
|
|
8741
|
-
/**
|
|
8742
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8743
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8744
|
-
* @public
|
|
8745
|
-
*/
|
|
8746
|
-
NextToken?: string | undefined;
|
|
8747
|
-
/**
|
|
8748
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8749
|
-
* @public
|
|
8750
|
-
*/
|
|
8751
|
-
MaxResults?: number | undefined;
|
|
8752
|
-
/**
|
|
8753
|
-
* <p>The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are
|
|
8754
|
-
* prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).</p>
|
|
8755
|
-
* @public
|
|
8756
|
-
*/
|
|
8757
|
-
QuickConnectTypes?: QuickConnectType[] | undefined;
|
|
8758
|
-
}
|
|
8759
8824
|
/**
|
|
8760
8825
|
* @internal
|
|
8761
8826
|
*/
|
|
@@ -1,7 +1,85 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { ActionSummary,
|
|
4
|
-
import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QuickConnect, QuickConnectSummary, RoutingProfile, SortOrder, TrafficDistributionGroupStatus } from "./models_1";
|
|
3
|
+
import { ActionSummary, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, MonitorCapability, OutboundCallerConfig, OutboundEmailConfig, ParticipantRole, PredefinedAttributeValues, QuickConnectConfig, QuickConnectType, Reference, RehydrationType, RulePublishStatus, StringComparisonType, StringCondition, TagCondition, TaskTemplateStatus, UseCaseType, UserPhoneConfig, UserProficiency, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QueueStatus, QueueType, QuickConnect, QuickConnectSummary, RoutingProfile, SortOrder, TrafficDistributionGroupStatus } from "./models_1";
|
|
5
|
+
/**
|
|
6
|
+
* <p>Contains summary information about a queue.</p>
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export interface QueueSummary {
|
|
10
|
+
/**
|
|
11
|
+
* <p>The identifier of the queue.</p>
|
|
12
|
+
* @public
|
|
13
|
+
*/
|
|
14
|
+
Id?: string | undefined;
|
|
15
|
+
/**
|
|
16
|
+
* <p>The Amazon Resource Name (ARN) of the queue.</p>
|
|
17
|
+
* @public
|
|
18
|
+
*/
|
|
19
|
+
Arn?: string | undefined;
|
|
20
|
+
/**
|
|
21
|
+
* <p>The name of the queue.</p>
|
|
22
|
+
* @public
|
|
23
|
+
*/
|
|
24
|
+
Name?: string | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* <p>The type of queue.</p>
|
|
27
|
+
* @public
|
|
28
|
+
*/
|
|
29
|
+
QueueType?: QueueType | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* <p>The timestamp when this resource was last modified.</p>
|
|
32
|
+
* @public
|
|
33
|
+
*/
|
|
34
|
+
LastModifiedTime?: Date | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
37
|
+
* @public
|
|
38
|
+
*/
|
|
39
|
+
LastModifiedRegion?: string | undefined;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* @public
|
|
43
|
+
*/
|
|
44
|
+
export interface ListQueuesResponse {
|
|
45
|
+
/**
|
|
46
|
+
* <p>Information about the queues.</p>
|
|
47
|
+
* @public
|
|
48
|
+
*/
|
|
49
|
+
QueueSummaryList?: QueueSummary[] | undefined;
|
|
50
|
+
/**
|
|
51
|
+
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
52
|
+
* @public
|
|
53
|
+
*/
|
|
54
|
+
NextToken?: string | undefined;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* @public
|
|
58
|
+
*/
|
|
59
|
+
export interface ListQuickConnectsRequest {
|
|
60
|
+
/**
|
|
61
|
+
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
62
|
+
* @public
|
|
63
|
+
*/
|
|
64
|
+
InstanceId: string | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
67
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
68
|
+
* @public
|
|
69
|
+
*/
|
|
70
|
+
NextToken?: string | undefined;
|
|
71
|
+
/**
|
|
72
|
+
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
MaxResults?: number | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* <p>The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are
|
|
78
|
+
* prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).</p>
|
|
79
|
+
* @public
|
|
80
|
+
*/
|
|
81
|
+
QuickConnectTypes?: QuickConnectType[] | undefined;
|
|
82
|
+
}
|
|
5
83
|
/**
|
|
6
84
|
* @public
|
|
7
85
|
*/
|
|
@@ -3093,34 +3171,41 @@ export interface SearchResourceTagsRequest {
|
|
|
3093
3171
|
InstanceId: string | undefined;
|
|
3094
3172
|
/**
|
|
3095
3173
|
* <p>The list of resource types to be used to search tags from. If not provided or if any empty
|
|
3096
|
-
* list is provided, this API will search from all supported resource types
|
|
3174
|
+
* list is provided, this API will search from all supported resource types. Note that lowercase and
|
|
3175
|
+
* - are required.</p>
|
|
3097
3176
|
* <p class="title">
|
|
3098
3177
|
* <b>Supported resource types</b>
|
|
3099
3178
|
* </p>
|
|
3100
3179
|
* <ul>
|
|
3101
3180
|
* <li>
|
|
3102
|
-
* <p>
|
|
3181
|
+
* <p>agent</p>
|
|
3182
|
+
* </li>
|
|
3183
|
+
* <li>
|
|
3184
|
+
* <p>agent-state</p>
|
|
3103
3185
|
* </li>
|
|
3104
3186
|
* <li>
|
|
3105
|
-
* <p>
|
|
3187
|
+
* <p>routing-profile</p>
|
|
3106
3188
|
* </li>
|
|
3107
3189
|
* <li>
|
|
3108
|
-
* <p>
|
|
3190
|
+
* <p>standard-queue</p>
|
|
3109
3191
|
* </li>
|
|
3110
3192
|
* <li>
|
|
3111
|
-
* <p>
|
|
3193
|
+
* <p>security-profile</p>
|
|
3112
3194
|
* </li>
|
|
3113
3195
|
* <li>
|
|
3114
|
-
* <p>
|
|
3196
|
+
* <p>operating-hours</p>
|
|
3115
3197
|
* </li>
|
|
3116
3198
|
* <li>
|
|
3117
|
-
* <p>
|
|
3199
|
+
* <p>prompt</p>
|
|
3118
3200
|
* </li>
|
|
3119
3201
|
* <li>
|
|
3120
|
-
* <p>
|
|
3202
|
+
* <p>contact-flow</p>
|
|
3121
3203
|
* </li>
|
|
3122
3204
|
* <li>
|
|
3123
|
-
* <p>
|
|
3205
|
+
* <p>flow- module</p>
|
|
3206
|
+
* </li>
|
|
3207
|
+
* <li>
|
|
3208
|
+
* <p>transfer-destination (also known as quick connect)</p>
|
|
3124
3209
|
* </li>
|
|
3125
3210
|
* </ul>
|
|
3126
3211
|
* @public
|
|
@@ -5565,8 +5650,9 @@ export interface UpdateContactAttributesRequest {
|
|
|
5565
5650
|
* other contact attributes.</p>
|
|
5566
5651
|
* <p>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys
|
|
5567
5652
|
* can include only alphanumeric, dash, and underscore characters.</p>
|
|
5568
|
-
* <p>
|
|
5569
|
-
*
|
|
5653
|
+
* <p>In the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Set contact attributes</a>
|
|
5654
|
+
* block, when the attributes for a contact exceed 32 KB, the contact is routed down the Error
|
|
5655
|
+
* branch of the flow. As a mitigation, consider the following options:</p>
|
|
5570
5656
|
* <ul>
|
|
5571
5657
|
* <li>
|
|
5572
5658
|
* <p>Remove unnecessary attributes by setting their values to empty.</p>
|
|
@@ -5999,7 +6085,7 @@ export interface UpdateInstanceAttributeRequest {
|
|
|
5999
6085
|
* <p>The type of attribute.</p>
|
|
6000
6086
|
* <note>
|
|
6001
6087
|
* <p>Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature,
|
|
6002
|
-
* contact Amazon Web
|
|
6088
|
+
* contact Amazon Web ServicesSupport for allowlisting.</p>
|
|
6003
6089
|
* </note>
|
|
6004
6090
|
* @public
|
|
6005
6091
|
*/
|
|
@@ -6009,6 +6095,14 @@ export interface UpdateInstanceAttributeRequest {
|
|
|
6009
6095
|
* @public
|
|
6010
6096
|
*/
|
|
6011
6097
|
Value: string | undefined;
|
|
6098
|
+
/**
|
|
6099
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
6100
|
+
* request. If not provided, the Amazon Web Services
|
|
6101
|
+
* SDK populates this field. For more information about idempotency, see
|
|
6102
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
6103
|
+
* @public
|
|
6104
|
+
*/
|
|
6105
|
+
ClientToken?: string | undefined;
|
|
6012
6106
|
}
|
|
6013
6107
|
/**
|
|
6014
6108
|
* @public
|
|
@@ -6034,6 +6128,14 @@ export interface UpdateInstanceStorageConfigRequest {
|
|
|
6034
6128
|
* @public
|
|
6035
6129
|
*/
|
|
6036
6130
|
StorageConfig: InstanceStorageConfig | undefined;
|
|
6131
|
+
/**
|
|
6132
|
+
* <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the
|
|
6133
|
+
* request. If not provided, the Amazon Web Services
|
|
6134
|
+
* SDK populates this field. For more information about idempotency, see
|
|
6135
|
+
* <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</p>
|
|
6136
|
+
* @public
|
|
6137
|
+
*/
|
|
6138
|
+
ClientToken?: string | undefined;
|
|
6037
6139
|
}
|
|
6038
6140
|
/**
|
|
6039
6141
|
* @public
|
|
@@ -6558,68 +6660,6 @@ export interface UpdateQuickConnectNameRequest {
|
|
|
6558
6660
|
*/
|
|
6559
6661
|
Description?: string | undefined;
|
|
6560
6662
|
}
|
|
6561
|
-
/**
|
|
6562
|
-
* @public
|
|
6563
|
-
*/
|
|
6564
|
-
export interface UpdateRoutingProfileAgentAvailabilityTimerRequest {
|
|
6565
|
-
/**
|
|
6566
|
-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
6567
|
-
* @public
|
|
6568
|
-
*/
|
|
6569
|
-
InstanceId: string | undefined;
|
|
6570
|
-
/**
|
|
6571
|
-
* <p>The identifier of the routing profile.</p>
|
|
6572
|
-
* @public
|
|
6573
|
-
*/
|
|
6574
|
-
RoutingProfileId: string | undefined;
|
|
6575
|
-
/**
|
|
6576
|
-
* <p>Whether agents with this routing profile will have their routing order calculated based on
|
|
6577
|
-
* <i>time since their last inbound contact</i> or <i>longest idle
|
|
6578
|
-
* time</i>. </p>
|
|
6579
|
-
* @public
|
|
6580
|
-
*/
|
|
6581
|
-
AgentAvailabilityTimer: AgentAvailabilityTimer | undefined;
|
|
6582
|
-
}
|
|
6583
|
-
/**
|
|
6584
|
-
* @public
|
|
6585
|
-
*/
|
|
6586
|
-
export interface UpdateRoutingProfileConcurrencyRequest {
|
|
6587
|
-
/**
|
|
6588
|
-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
6589
|
-
* @public
|
|
6590
|
-
*/
|
|
6591
|
-
InstanceId: string | undefined;
|
|
6592
|
-
/**
|
|
6593
|
-
* <p>The identifier of the routing profile.</p>
|
|
6594
|
-
* @public
|
|
6595
|
-
*/
|
|
6596
|
-
RoutingProfileId: string | undefined;
|
|
6597
|
-
/**
|
|
6598
|
-
* <p>The channels that agents can handle in the Contact Control Panel (CCP).</p>
|
|
6599
|
-
* @public
|
|
6600
|
-
*/
|
|
6601
|
-
MediaConcurrencies: MediaConcurrency[] | undefined;
|
|
6602
|
-
}
|
|
6603
|
-
/**
|
|
6604
|
-
* @public
|
|
6605
|
-
*/
|
|
6606
|
-
export interface UpdateRoutingProfileDefaultOutboundQueueRequest {
|
|
6607
|
-
/**
|
|
6608
|
-
* <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
6609
|
-
* @public
|
|
6610
|
-
*/
|
|
6611
|
-
InstanceId: string | undefined;
|
|
6612
|
-
/**
|
|
6613
|
-
* <p>The identifier of the routing profile.</p>
|
|
6614
|
-
* @public
|
|
6615
|
-
*/
|
|
6616
|
-
RoutingProfileId: string | undefined;
|
|
6617
|
-
/**
|
|
6618
|
-
* <p>The identifier for the default outbound queue.</p>
|
|
6619
|
-
* @public
|
|
6620
|
-
*/
|
|
6621
|
-
DefaultOutboundQueueId: string | undefined;
|
|
6622
|
-
}
|
|
6623
6663
|
/**
|
|
6624
6664
|
* @internal
|
|
6625
6665
|
*/
|