@aws-sdk/client-connect 3.369.0 → 3.370.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 +16 -0
- package/dist-cjs/Connect.js +4 -0
- package/dist-cjs/commands/DeleteQueueCommand.js +46 -0
- package/dist-cjs/commands/DeleteRoutingProfileCommand.js +46 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +135 -8
- package/dist-es/Connect.js +4 -0
- package/dist-es/commands/DeleteQueueCommand.js +42 -0
- package/dist-es/commands/DeleteRoutingProfileCommand.js +42 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +123 -0
- package/dist-types/Connect.d.ts +14 -0
- package/dist-types/ConnectClient.d.ts +4 -2
- package/dist-types/commands/CreateEvaluationFormCommand.d.ts +3 -4
- package/dist-types/commands/CreateParticipantCommand.d.ts +1 -1
- package/dist-types/commands/CreatePromptCommand.d.ts +1 -3
- package/dist-types/commands/DeleteQueueCommand.d.ts +90 -0
- package/dist-types/commands/DeleteRoutingProfileCommand.d.ts +90 -0
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +1 -2
- package/dist-types/commands/SearchHoursOfOperationsCommand.d.ts +1 -2
- package/dist-types/commands/UpdateEvaluationFormCommand.d.ts +3 -4
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +60 -220
- package/dist-types/models/models_1.d.ts +188 -55
- package/dist-types/models/models_2.d.ts +54 -1
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/ts3.4/Connect.d.ts +34 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
- package/dist-types/ts3.4/commands/DeleteQueueCommand.d.ts +33 -0
- package/dist-types/ts3.4/commands/DeleteRoutingProfileCommand.d.ts +37 -0
- package/dist-types/ts3.4/commands/GetCurrentMetricDataCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +2 -0
- package/dist-types/ts3.4/models/models_0.d.ts +18 -23
- package/dist-types/ts3.4/models/models_1.d.ts +15 -11
- package/dist-types/ts3.4/models/models_2.d.ts +12 -2
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
- package/package.json +16 -17
|
@@ -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
|
-
*
|
|
53
|
+
* <p>The version of the evaluation form to activate. If the version property is not provided, the latest version of the
|
|
54
|
+
* evaluation form is activated.</p>
|
|
55
55
|
*/
|
|
56
56
|
EvaluationFormVersion: number | undefined;
|
|
57
57
|
}
|
|
@@ -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
|
-
*
|
|
1800
|
+
* <p>The token used by the chat participant to call <code>CreateParticipantConnection</code>. The participant
|
|
1801
|
+
* token is valid for the lifetime of a chat participant.</p>
|
|
1802
1802
|
*/
|
|
1803
1803
|
ParticipantCredentials?: ParticipantTokenCredentials;
|
|
1804
1804
|
/**
|
|
@@ -3191,41 +3191,15 @@ export interface DeletePromptRequest {
|
|
|
3191
3191
|
/**
|
|
3192
3192
|
* @public
|
|
3193
3193
|
*/
|
|
3194
|
-
export interface
|
|
3195
|
-
/**
|
|
3196
|
-
* <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>
|
|
3197
|
-
*/
|
|
3198
|
-
InstanceId: string | undefined;
|
|
3199
|
-
/**
|
|
3200
|
-
* <p>The identifier for the quick connect.</p>
|
|
3201
|
-
*/
|
|
3202
|
-
QuickConnectId: string | undefined;
|
|
3203
|
-
}
|
|
3204
|
-
/**
|
|
3205
|
-
* @public
|
|
3206
|
-
*/
|
|
3207
|
-
export interface DeleteRuleRequest {
|
|
3194
|
+
export interface DeleteQueueRequest {
|
|
3208
3195
|
/**
|
|
3209
3196
|
* <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>
|
|
3210
3197
|
*/
|
|
3211
3198
|
InstanceId: string | undefined;
|
|
3212
3199
|
/**
|
|
3213
|
-
* <p>
|
|
3214
|
-
*/
|
|
3215
|
-
RuleId: string | undefined;
|
|
3216
|
-
}
|
|
3217
|
-
/**
|
|
3218
|
-
* @public
|
|
3219
|
-
*/
|
|
3220
|
-
export interface DeleteSecurityProfileRequest {
|
|
3221
|
-
/**
|
|
3222
|
-
* <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>
|
|
3223
|
-
*/
|
|
3224
|
-
InstanceId: string | undefined;
|
|
3225
|
-
/**
|
|
3226
|
-
* <p>The identifier for the security profle.</p>
|
|
3200
|
+
* <p>The identifier for the queue.</p>
|
|
3227
3201
|
*/
|
|
3228
|
-
|
|
3202
|
+
QueueId: string | undefined;
|
|
3229
3203
|
}
|
|
3230
3204
|
/**
|
|
3231
3205
|
* @public
|
|
@@ -3265,6 +3239,58 @@ export declare class ResourceInUseException extends __BaseException {
|
|
|
3265
3239
|
*/
|
|
3266
3240
|
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
3267
3241
|
}
|
|
3242
|
+
/**
|
|
3243
|
+
* @public
|
|
3244
|
+
*/
|
|
3245
|
+
export interface DeleteQuickConnectRequest {
|
|
3246
|
+
/**
|
|
3247
|
+
* <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>
|
|
3248
|
+
*/
|
|
3249
|
+
InstanceId: string | undefined;
|
|
3250
|
+
/**
|
|
3251
|
+
* <p>The identifier for the quick connect.</p>
|
|
3252
|
+
*/
|
|
3253
|
+
QuickConnectId: string | undefined;
|
|
3254
|
+
}
|
|
3255
|
+
/**
|
|
3256
|
+
* @public
|
|
3257
|
+
*/
|
|
3258
|
+
export interface DeleteRoutingProfileRequest {
|
|
3259
|
+
/**
|
|
3260
|
+
* <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>
|
|
3261
|
+
*/
|
|
3262
|
+
InstanceId: string | undefined;
|
|
3263
|
+
/**
|
|
3264
|
+
* <p>The identifier of the routing profile.</p>
|
|
3265
|
+
*/
|
|
3266
|
+
RoutingProfileId: string | undefined;
|
|
3267
|
+
}
|
|
3268
|
+
/**
|
|
3269
|
+
* @public
|
|
3270
|
+
*/
|
|
3271
|
+
export interface DeleteRuleRequest {
|
|
3272
|
+
/**
|
|
3273
|
+
* <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>
|
|
3274
|
+
*/
|
|
3275
|
+
InstanceId: string | undefined;
|
|
3276
|
+
/**
|
|
3277
|
+
* <p>A unique identifier for the rule.</p>
|
|
3278
|
+
*/
|
|
3279
|
+
RuleId: string | undefined;
|
|
3280
|
+
}
|
|
3281
|
+
/**
|
|
3282
|
+
* @public
|
|
3283
|
+
*/
|
|
3284
|
+
export interface DeleteSecurityProfileRequest {
|
|
3285
|
+
/**
|
|
3286
|
+
* <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>
|
|
3287
|
+
*/
|
|
3288
|
+
InstanceId: string | undefined;
|
|
3289
|
+
/**
|
|
3290
|
+
* <p>The identifier for the security profle.</p>
|
|
3291
|
+
*/
|
|
3292
|
+
SecurityProfileId: string | undefined;
|
|
3293
|
+
}
|
|
3268
3294
|
/**
|
|
3269
3295
|
* @public
|
|
3270
3296
|
*/
|
|
@@ -4040,7 +4066,7 @@ export interface Instance {
|
|
|
4040
4066
|
*/
|
|
4041
4067
|
OutboundCallsEnabled?: boolean;
|
|
4042
4068
|
/**
|
|
4043
|
-
* <p>This URL allows contact center users to access Amazon Connect admin website.</p>
|
|
4069
|
+
* <p>This URL allows contact center users to access the Amazon Connect admin website.</p>
|
|
4044
4070
|
*/
|
|
4045
4071
|
InstanceAccessUrl?: string;
|
|
4046
4072
|
}
|
|
@@ -5592,192 +5618,6 @@ export declare const SortOrder: {
|
|
|
5592
5618
|
* @public
|
|
5593
5619
|
*/
|
|
5594
5620
|
export type SortOrder = (typeof SortOrder)[keyof typeof SortOrder];
|
|
5595
|
-
/**
|
|
5596
|
-
* @public
|
|
5597
|
-
* <p>The way to sort the resulting response based on metrics. By default resources are sorted
|
|
5598
|
-
* based on <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The metric collection is sorted
|
|
5599
|
-
* based on the input metrics.</p>
|
|
5600
|
-
*/
|
|
5601
|
-
export interface CurrentMetricSortCriteria {
|
|
5602
|
-
/**
|
|
5603
|
-
* <p>The current metric names.</p>
|
|
5604
|
-
*/
|
|
5605
|
-
SortByMetric?: CurrentMetricName | string;
|
|
5606
|
-
/**
|
|
5607
|
-
* <p>The way to sort.</p>
|
|
5608
|
-
*/
|
|
5609
|
-
SortOrder?: SortOrder | string;
|
|
5610
|
-
}
|
|
5611
|
-
/**
|
|
5612
|
-
* @public
|
|
5613
|
-
*/
|
|
5614
|
-
export interface GetCurrentMetricDataRequest {
|
|
5615
|
-
/**
|
|
5616
|
-
* <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>
|
|
5617
|
-
*/
|
|
5618
|
-
InstanceId: string | undefined;
|
|
5619
|
-
/**
|
|
5620
|
-
* <p>The filters to apply to returned metrics. You can filter up to the following limits:</p>
|
|
5621
|
-
* <ul>
|
|
5622
|
-
* <li>
|
|
5623
|
-
* <p>Queues: 100</p>
|
|
5624
|
-
* </li>
|
|
5625
|
-
* <li>
|
|
5626
|
-
* <p>Routing profiles: 100</p>
|
|
5627
|
-
* </li>
|
|
5628
|
-
* <li>
|
|
5629
|
-
* <p>Channels: 3 (VOICE, CHAT, and TASK channels are supported.)</p>
|
|
5630
|
-
* </li>
|
|
5631
|
-
* </ul>
|
|
5632
|
-
* <p>Metric data is retrieved only for the resources associated with the queues or routing
|
|
5633
|
-
* profiles, and by any channels included in the filter. (You cannot filter by both queue AND
|
|
5634
|
-
* routing profile.) You can include both resource IDs and resource ARNs in the same request. </p>
|
|
5635
|
-
* <p>Currently tagging is only supported on the resources that are passed in the filter.</p>
|
|
5636
|
-
*/
|
|
5637
|
-
Filters: Filters | undefined;
|
|
5638
|
-
/**
|
|
5639
|
-
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
5640
|
-
* <code>QUEUE</code>, the metrics returned apply to each queue rather than aggregated for all
|
|
5641
|
-
* queues. </p>
|
|
5642
|
-
* <ul>
|
|
5643
|
-
* <li>
|
|
5644
|
-
* <p>If you group by <code>CHANNEL</code>, you should include a Channels filter.
|
|
5645
|
-
* VOICE, CHAT, and TASK channels are supported.</p>
|
|
5646
|
-
* </li>
|
|
5647
|
-
* <li>
|
|
5648
|
-
* <p>If you group by <code>ROUTING_PROFILE</code>, you must include either a queue or routing
|
|
5649
|
-
* profile filter. In addition, a routing profile filter is required for metrics
|
|
5650
|
-
* <code>CONTACTS_SCHEDULED</code>, <code>CONTACTS_IN_QUEUE</code>, and <code>
|
|
5651
|
-
* OLDEST_CONTACT_AGE</code>.</p>
|
|
5652
|
-
* </li>
|
|
5653
|
-
* <li>
|
|
5654
|
-
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics is
|
|
5655
|
-
* returned.</p>
|
|
5656
|
-
* </li>
|
|
5657
|
-
* </ul>
|
|
5658
|
-
*/
|
|
5659
|
-
Groupings?: (Grouping | string)[];
|
|
5660
|
-
/**
|
|
5661
|
-
* <p>The metrics to retrieve. Specify the name and unit for each metric. The following metrics
|
|
5662
|
-
* are available. For a description of all the metrics, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time Metrics
|
|
5663
|
-
* Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
5664
|
-
* <dl>
|
|
5665
|
-
* <dt>AGENTS_AFTER_CONTACT_WORK</dt>
|
|
5666
|
-
* <dd>
|
|
5667
|
-
* <p>Unit: COUNT</p>
|
|
5668
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time">ACW</a>
|
|
5669
|
-
* </p>
|
|
5670
|
-
* </dd>
|
|
5671
|
-
* <dt>AGENTS_AVAILABLE</dt>
|
|
5672
|
-
* <dd>
|
|
5673
|
-
* <p>Unit: COUNT</p>
|
|
5674
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time">Available</a>
|
|
5675
|
-
* </p>
|
|
5676
|
-
* </dd>
|
|
5677
|
-
* <dt>AGENTS_ERROR</dt>
|
|
5678
|
-
* <dd>
|
|
5679
|
-
* <p>Unit: COUNT</p>
|
|
5680
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time">Error</a>
|
|
5681
|
-
* </p>
|
|
5682
|
-
* </dd>
|
|
5683
|
-
* <dt>AGENTS_NON_PRODUCTIVE</dt>
|
|
5684
|
-
* <dd>
|
|
5685
|
-
* <p>Unit: COUNT</p>
|
|
5686
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time">NPT (Non-Productive Time)</a>
|
|
5687
|
-
* </p>
|
|
5688
|
-
* </dd>
|
|
5689
|
-
* <dt>AGENTS_ON_CALL</dt>
|
|
5690
|
-
* <dd>
|
|
5691
|
-
* <p>Unit: COUNT</p>
|
|
5692
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time">On
|
|
5693
|
-
* contact</a>
|
|
5694
|
-
* </p>
|
|
5695
|
-
* </dd>
|
|
5696
|
-
* <dt>AGENTS_ON_CONTACT</dt>
|
|
5697
|
-
* <dd>
|
|
5698
|
-
* <p>Unit: COUNT</p>
|
|
5699
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time">On
|
|
5700
|
-
* contact</a>
|
|
5701
|
-
* </p>
|
|
5702
|
-
* </dd>
|
|
5703
|
-
* <dt>AGENTS_ONLINE</dt>
|
|
5704
|
-
* <dd>
|
|
5705
|
-
* <p>Unit: COUNT</p>
|
|
5706
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time">Online</a>
|
|
5707
|
-
* </p>
|
|
5708
|
-
* </dd>
|
|
5709
|
-
* <dt>AGENTS_STAFFED</dt>
|
|
5710
|
-
* <dd>
|
|
5711
|
-
* <p>Unit: COUNT</p>
|
|
5712
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time">Staffed</a>
|
|
5713
|
-
* </p>
|
|
5714
|
-
* </dd>
|
|
5715
|
-
* <dt>CONTACTS_IN_QUEUE</dt>
|
|
5716
|
-
* <dd>
|
|
5717
|
-
* <p>Unit: COUNT</p>
|
|
5718
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time">In
|
|
5719
|
-
* queue</a>
|
|
5720
|
-
* </p>
|
|
5721
|
-
* </dd>
|
|
5722
|
-
* <dt>CONTACTS_SCHEDULED</dt>
|
|
5723
|
-
* <dd>
|
|
5724
|
-
* <p>Unit: COUNT</p>
|
|
5725
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time">Scheduled</a>
|
|
5726
|
-
* </p>
|
|
5727
|
-
* </dd>
|
|
5728
|
-
* <dt>OLDEST_CONTACT_AGE</dt>
|
|
5729
|
-
* <dd>
|
|
5730
|
-
* <p>Unit: SECONDS</p>
|
|
5731
|
-
* <p>When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. </p>
|
|
5732
|
-
* <p>When you do not use groupings, Unit says SECONDS but the Value is returned in
|
|
5733
|
-
* MILLISECONDS. For example, if you get a response like this:</p>
|
|
5734
|
-
* <p>
|
|
5735
|
-
* <code>\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \}, "Value": 24113.0
|
|
5736
|
-
* </code>\}</p>
|
|
5737
|
-
* <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p>
|
|
5738
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time">Oldest</a>
|
|
5739
|
-
* </p>
|
|
5740
|
-
* </dd>
|
|
5741
|
-
* <dt>SLOTS_ACTIVE</dt>
|
|
5742
|
-
* <dd>
|
|
5743
|
-
* <p>Unit: COUNT</p>
|
|
5744
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time">Active</a>
|
|
5745
|
-
* </p>
|
|
5746
|
-
* </dd>
|
|
5747
|
-
* <dt>SLOTS_AVAILABLE</dt>
|
|
5748
|
-
* <dd>
|
|
5749
|
-
* <p>Unit: COUNT</p>
|
|
5750
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time">Availability</a>
|
|
5751
|
-
* </p>
|
|
5752
|
-
* </dd>
|
|
5753
|
-
* </dl>
|
|
5754
|
-
*/
|
|
5755
|
-
CurrentMetrics: CurrentMetric[] | undefined;
|
|
5756
|
-
/**
|
|
5757
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
5758
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
5759
|
-
* <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use
|
|
5760
|
-
* the token must use the same request parameters as the request that generated the token.</p>
|
|
5761
|
-
*/
|
|
5762
|
-
NextToken?: string;
|
|
5763
|
-
/**
|
|
5764
|
-
* <p>The maximum number of results to return per page.</p>
|
|
5765
|
-
*/
|
|
5766
|
-
MaxResults?: number;
|
|
5767
|
-
/**
|
|
5768
|
-
* <p>The way to sort the resulting response based on metrics. You can enter one sort criteria. By
|
|
5769
|
-
* default resources are sorted based on <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The
|
|
5770
|
-
* metric collection is sorted based on the input metrics.</p>
|
|
5771
|
-
* <p>Note the following:</p>
|
|
5772
|
-
* <ul>
|
|
5773
|
-
* <li>
|
|
5774
|
-
* <p>Sorting on <code>SLOTS_ACTIVE</code> and <code>SLOTS_AVAILABLE</code> is not
|
|
5775
|
-
* supported.</p>
|
|
5776
|
-
* </li>
|
|
5777
|
-
* </ul>
|
|
5778
|
-
*/
|
|
5779
|
-
SortCriteria?: CurrentMetricSortCriteria[];
|
|
5780
|
-
}
|
|
5781
5621
|
/**
|
|
5782
5622
|
* @internal
|
|
5783
5623
|
*/
|
|
@@ -1,6 +1,192 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { ActionSummary, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, CurrentMetric, DirectoryType, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, Filters, Grouping, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Prompt, Queue, QueueReference, QueueStatus, QuickConnect, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
3
|
+
import { ActionSummary, AgentContactReference, AgentStatusReference, AgentStatusState, AgentStatusSummary, AgentStatusType, Attribute, Channel, ContactFlowModuleState, ContactFlowState, ContactFlowType, ContactState, CurrentMetric, CurrentMetricName, DirectoryType, EvaluationAnswerData, EvaluationFormQuestion, EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, Filters, Grouping, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationConfig, InstanceAttributeType, InstanceStatus, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, MediaConcurrency, MonitorCapability, OutboundCallerConfig, PhoneNumberCountryCode, PhoneNumberType, Prompt, Queue, QueueReference, QueueStatus, QuickConnect, QuickConnectConfig, QuickConnectType, Reference, ReferenceType, RoutingProfile, RoutingProfileQueueConfig, RuleAction, RulePublishStatus, SortOrder, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, Unit, UseCaseType, UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
* <p>The way to sort the resulting response based on metrics. By default resources are sorted
|
|
7
|
+
* based on <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The metric collection is sorted
|
|
8
|
+
* based on the input metrics.</p>
|
|
9
|
+
*/
|
|
10
|
+
export interface CurrentMetricSortCriteria {
|
|
11
|
+
/**
|
|
12
|
+
* <p>The current metric names.</p>
|
|
13
|
+
*/
|
|
14
|
+
SortByMetric?: CurrentMetricName | string;
|
|
15
|
+
/**
|
|
16
|
+
* <p>The way to sort.</p>
|
|
17
|
+
*/
|
|
18
|
+
SortOrder?: SortOrder | string;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
*/
|
|
23
|
+
export interface GetCurrentMetricDataRequest {
|
|
24
|
+
/**
|
|
25
|
+
* <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>
|
|
26
|
+
*/
|
|
27
|
+
InstanceId: string | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* <p>The filters to apply to returned metrics. You can filter up to the following limits:</p>
|
|
30
|
+
* <ul>
|
|
31
|
+
* <li>
|
|
32
|
+
* <p>Queues: 100</p>
|
|
33
|
+
* </li>
|
|
34
|
+
* <li>
|
|
35
|
+
* <p>Routing profiles: 100</p>
|
|
36
|
+
* </li>
|
|
37
|
+
* <li>
|
|
38
|
+
* <p>Channels: 3 (VOICE, CHAT, and TASK channels are supported.)</p>
|
|
39
|
+
* </li>
|
|
40
|
+
* </ul>
|
|
41
|
+
* <p>Metric data is retrieved only for the resources associated with the queues or routing
|
|
42
|
+
* profiles, and by any channels included in the filter. (You cannot filter by both queue AND
|
|
43
|
+
* routing profile.) You can include both resource IDs and resource ARNs in the same request. </p>
|
|
44
|
+
* <p>Currently tagging is only supported on the resources that are passed in the filter.</p>
|
|
45
|
+
*/
|
|
46
|
+
Filters: Filters | undefined;
|
|
47
|
+
/**
|
|
48
|
+
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
49
|
+
* <code>QUEUE</code>, the metrics returned apply to each queue rather than aggregated for all
|
|
50
|
+
* queues. </p>
|
|
51
|
+
* <ul>
|
|
52
|
+
* <li>
|
|
53
|
+
* <p>If you group by <code>CHANNEL</code>, you should include a Channels filter.
|
|
54
|
+
* VOICE, CHAT, and TASK channels are supported.</p>
|
|
55
|
+
* </li>
|
|
56
|
+
* <li>
|
|
57
|
+
* <p>If you group by <code>ROUTING_PROFILE</code>, you must include either a queue or routing
|
|
58
|
+
* profile filter. In addition, a routing profile filter is required for metrics
|
|
59
|
+
* <code>CONTACTS_SCHEDULED</code>, <code>CONTACTS_IN_QUEUE</code>, and <code>
|
|
60
|
+
* OLDEST_CONTACT_AGE</code>.</p>
|
|
61
|
+
* </li>
|
|
62
|
+
* <li>
|
|
63
|
+
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics is
|
|
64
|
+
* returned.</p>
|
|
65
|
+
* </li>
|
|
66
|
+
* </ul>
|
|
67
|
+
*/
|
|
68
|
+
Groupings?: (Grouping | string)[];
|
|
69
|
+
/**
|
|
70
|
+
* <p>The metrics to retrieve. Specify the name and unit for each metric. The following metrics
|
|
71
|
+
* are available. For a description of all the metrics, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time Metrics
|
|
72
|
+
* Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
73
|
+
* <dl>
|
|
74
|
+
* <dt>AGENTS_AFTER_CONTACT_WORK</dt>
|
|
75
|
+
* <dd>
|
|
76
|
+
* <p>Unit: COUNT</p>
|
|
77
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time">ACW</a>
|
|
78
|
+
* </p>
|
|
79
|
+
* </dd>
|
|
80
|
+
* <dt>AGENTS_AVAILABLE</dt>
|
|
81
|
+
* <dd>
|
|
82
|
+
* <p>Unit: COUNT</p>
|
|
83
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time">Available</a>
|
|
84
|
+
* </p>
|
|
85
|
+
* </dd>
|
|
86
|
+
* <dt>AGENTS_ERROR</dt>
|
|
87
|
+
* <dd>
|
|
88
|
+
* <p>Unit: COUNT</p>
|
|
89
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time">Error</a>
|
|
90
|
+
* </p>
|
|
91
|
+
* </dd>
|
|
92
|
+
* <dt>AGENTS_NON_PRODUCTIVE</dt>
|
|
93
|
+
* <dd>
|
|
94
|
+
* <p>Unit: COUNT</p>
|
|
95
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time">NPT (Non-Productive Time)</a>
|
|
96
|
+
* </p>
|
|
97
|
+
* </dd>
|
|
98
|
+
* <dt>AGENTS_ON_CALL</dt>
|
|
99
|
+
* <dd>
|
|
100
|
+
* <p>Unit: COUNT</p>
|
|
101
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time">On
|
|
102
|
+
* contact</a>
|
|
103
|
+
* </p>
|
|
104
|
+
* </dd>
|
|
105
|
+
* <dt>AGENTS_ON_CONTACT</dt>
|
|
106
|
+
* <dd>
|
|
107
|
+
* <p>Unit: COUNT</p>
|
|
108
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time">On
|
|
109
|
+
* contact</a>
|
|
110
|
+
* </p>
|
|
111
|
+
* </dd>
|
|
112
|
+
* <dt>AGENTS_ONLINE</dt>
|
|
113
|
+
* <dd>
|
|
114
|
+
* <p>Unit: COUNT</p>
|
|
115
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time">Online</a>
|
|
116
|
+
* </p>
|
|
117
|
+
* </dd>
|
|
118
|
+
* <dt>AGENTS_STAFFED</dt>
|
|
119
|
+
* <dd>
|
|
120
|
+
* <p>Unit: COUNT</p>
|
|
121
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time">Staffed</a>
|
|
122
|
+
* </p>
|
|
123
|
+
* </dd>
|
|
124
|
+
* <dt>CONTACTS_IN_QUEUE</dt>
|
|
125
|
+
* <dd>
|
|
126
|
+
* <p>Unit: COUNT</p>
|
|
127
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time">In
|
|
128
|
+
* queue</a>
|
|
129
|
+
* </p>
|
|
130
|
+
* </dd>
|
|
131
|
+
* <dt>CONTACTS_SCHEDULED</dt>
|
|
132
|
+
* <dd>
|
|
133
|
+
* <p>Unit: COUNT</p>
|
|
134
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time">Scheduled</a>
|
|
135
|
+
* </p>
|
|
136
|
+
* </dd>
|
|
137
|
+
* <dt>OLDEST_CONTACT_AGE</dt>
|
|
138
|
+
* <dd>
|
|
139
|
+
* <p>Unit: SECONDS</p>
|
|
140
|
+
* <p>When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. </p>
|
|
141
|
+
* <p>When you do not use groupings, Unit says SECONDS but the Value is returned in
|
|
142
|
+
* MILLISECONDS. For example, if you get a response like this:</p>
|
|
143
|
+
* <p>
|
|
144
|
+
* <code>\{ "Metric": \{ "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \}, "Value": 24113.0
|
|
145
|
+
* </code>\}</p>
|
|
146
|
+
* <p>The actual OLDEST_CONTACT_AGE is 24 seconds.</p>
|
|
147
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time">Oldest</a>
|
|
148
|
+
* </p>
|
|
149
|
+
* </dd>
|
|
150
|
+
* <dt>SLOTS_ACTIVE</dt>
|
|
151
|
+
* <dd>
|
|
152
|
+
* <p>Unit: COUNT</p>
|
|
153
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time">Active</a>
|
|
154
|
+
* </p>
|
|
155
|
+
* </dd>
|
|
156
|
+
* <dt>SLOTS_AVAILABLE</dt>
|
|
157
|
+
* <dd>
|
|
158
|
+
* <p>Unit: COUNT</p>
|
|
159
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time">Availability</a>
|
|
160
|
+
* </p>
|
|
161
|
+
* </dd>
|
|
162
|
+
* </dl>
|
|
163
|
+
*/
|
|
164
|
+
CurrentMetrics: CurrentMetric[] | undefined;
|
|
165
|
+
/**
|
|
166
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
167
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
168
|
+
* <p>The token expires after 5 minutes from the time it is created. Subsequent requests that use
|
|
169
|
+
* the token must use the same request parameters as the request that generated the token.</p>
|
|
170
|
+
*/
|
|
171
|
+
NextToken?: string;
|
|
172
|
+
/**
|
|
173
|
+
* <p>The maximum number of results to return per page.</p>
|
|
174
|
+
*/
|
|
175
|
+
MaxResults?: number;
|
|
176
|
+
/**
|
|
177
|
+
* <p>The way to sort the resulting response based on metrics. You can enter one sort criteria. By
|
|
178
|
+
* default resources are sorted based on <code>AGENTS_ONLINE</code>, <code>DESCENDING</code>. The
|
|
179
|
+
* metric collection is sorted based on the input metrics.</p>
|
|
180
|
+
* <p>Note the following:</p>
|
|
181
|
+
* <ul>
|
|
182
|
+
* <li>
|
|
183
|
+
* <p>Sorting on <code>SLOTS_ACTIVE</code> and <code>SLOTS_AVAILABLE</code> is not
|
|
184
|
+
* supported.</p>
|
|
185
|
+
* </li>
|
|
186
|
+
* </ul>
|
|
187
|
+
*/
|
|
188
|
+
SortCriteria?: CurrentMetricSortCriteria[];
|
|
189
|
+
}
|
|
4
190
|
/**
|
|
5
191
|
* @public
|
|
6
192
|
* <p>Contains the data for a real-time metric.</p>
|
|
@@ -2155,7 +2341,7 @@ export interface InstanceSummary {
|
|
|
2155
2341
|
*/
|
|
2156
2342
|
OutboundCallsEnabled?: boolean;
|
|
2157
2343
|
/**
|
|
2158
|
-
* <p>This URL allows contact center users to access Amazon Connect admin website.</p>
|
|
2344
|
+
* <p>This URL allows contact center users to access the Amazon Connect admin website.</p>
|
|
2159
2345
|
*/
|
|
2160
2346
|
InstanceAccessUrl?: string;
|
|
2161
2347
|
}
|
|
@@ -6307,59 +6493,6 @@ export interface HoursOfOperationSearchCriteria {
|
|
|
6307
6493
|
*/
|
|
6308
6494
|
StringCondition?: StringCondition;
|
|
6309
6495
|
}
|
|
6310
|
-
/**
|
|
6311
|
-
* @public
|
|
6312
|
-
* <p>The search criteria to be used to return prompts.</p>
|
|
6313
|
-
*/
|
|
6314
|
-
export interface PromptSearchCriteria {
|
|
6315
|
-
/**
|
|
6316
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6317
|
-
*/
|
|
6318
|
-
OrConditions?: PromptSearchCriteria[];
|
|
6319
|
-
/**
|
|
6320
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6321
|
-
*/
|
|
6322
|
-
AndConditions?: PromptSearchCriteria[];
|
|
6323
|
-
/**
|
|
6324
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6325
|
-
* <note>
|
|
6326
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
6327
|
-
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
6328
|
-
* </note>
|
|
6329
|
-
*/
|
|
6330
|
-
StringCondition?: StringCondition;
|
|
6331
|
-
}
|
|
6332
|
-
/**
|
|
6333
|
-
* @public
|
|
6334
|
-
* <p>The search criteria to be used to return queues.</p>
|
|
6335
|
-
* <note>
|
|
6336
|
-
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
6337
|
-
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
6338
|
-
* outside of this range will throw invalid results. </p>
|
|
6339
|
-
* </note>
|
|
6340
|
-
*/
|
|
6341
|
-
export interface QueueSearchCriteria {
|
|
6342
|
-
/**
|
|
6343
|
-
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
6344
|
-
*/
|
|
6345
|
-
OrConditions?: QueueSearchCriteria[];
|
|
6346
|
-
/**
|
|
6347
|
-
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
6348
|
-
*/
|
|
6349
|
-
AndConditions?: QueueSearchCriteria[];
|
|
6350
|
-
/**
|
|
6351
|
-
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
6352
|
-
* <note>
|
|
6353
|
-
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
6354
|
-
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
6355
|
-
* </note>
|
|
6356
|
-
*/
|
|
6357
|
-
StringCondition?: StringCondition;
|
|
6358
|
-
/**
|
|
6359
|
-
* <p>The type of queue.</p>
|
|
6360
|
-
*/
|
|
6361
|
-
QueueTypeCondition?: SearchableQueueType | string;
|
|
6362
|
-
}
|
|
6363
6496
|
/**
|
|
6364
6497
|
* @internal
|
|
6365
6498
|
*/
|
|
@@ -1,5 +1,58 @@
|
|
|
1
1
|
import { Evaluation, EvaluationFormScoringStrategy } from "./models_0";
|
|
2
|
-
import { EvaluationForm, EvaluationFormContent, EvaluationFormItem, HierarchyGroupCondition, HoursOfOperationSearchCriteria, HoursOfOperationSearchFilter,
|
|
2
|
+
import { EvaluationForm, EvaluationFormContent, EvaluationFormItem, HierarchyGroupCondition, HoursOfOperationSearchCriteria, HoursOfOperationSearchFilter, PromptSearchFilter, QueueSearchFilter, QuickConnectSearchFilter, RoutingProfileSearchFilter, SearchableQueueType, SecurityProfilesSearchFilter, StringCondition, UserSearchFilter } from "./models_1";
|
|
3
|
+
/**
|
|
4
|
+
* @public
|
|
5
|
+
* <p>The search criteria to be used to return prompts.</p>
|
|
6
|
+
*/
|
|
7
|
+
export interface PromptSearchCriteria {
|
|
8
|
+
/**
|
|
9
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
10
|
+
*/
|
|
11
|
+
OrConditions?: PromptSearchCriteria[];
|
|
12
|
+
/**
|
|
13
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
14
|
+
*/
|
|
15
|
+
AndConditions?: PromptSearchCriteria[];
|
|
16
|
+
/**
|
|
17
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
18
|
+
* <note>
|
|
19
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
20
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
21
|
+
* </note>
|
|
22
|
+
*/
|
|
23
|
+
StringCondition?: StringCondition;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* @public
|
|
27
|
+
* <p>The search criteria to be used to return queues.</p>
|
|
28
|
+
* <note>
|
|
29
|
+
* <p>The <code>name</code> and <code>description</code> fields support "contains" queries with
|
|
30
|
+
* a minimum of 2 characters and a maximum of 25 characters. Any queries with character lengths
|
|
31
|
+
* outside of this range will throw invalid results. </p>
|
|
32
|
+
* </note>
|
|
33
|
+
*/
|
|
34
|
+
export interface QueueSearchCriteria {
|
|
35
|
+
/**
|
|
36
|
+
* <p>A list of conditions which would be applied together with an OR condition.</p>
|
|
37
|
+
*/
|
|
38
|
+
OrConditions?: QueueSearchCriteria[];
|
|
39
|
+
/**
|
|
40
|
+
* <p>A list of conditions which would be applied together with an AND condition.</p>
|
|
41
|
+
*/
|
|
42
|
+
AndConditions?: QueueSearchCriteria[];
|
|
43
|
+
/**
|
|
44
|
+
* <p>A leaf node condition which can be used to specify a string condition.</p>
|
|
45
|
+
* <note>
|
|
46
|
+
* <p>The currently supported values for <code>FieldName</code> are <code>name</code>,
|
|
47
|
+
* <code>description</code>, and <code>resourceID</code>.</p>
|
|
48
|
+
* </note>
|
|
49
|
+
*/
|
|
50
|
+
StringCondition?: StringCondition;
|
|
51
|
+
/**
|
|
52
|
+
* <p>The type of queue.</p>
|
|
53
|
+
*/
|
|
54
|
+
QueueTypeCondition?: SearchableQueueType | string;
|
|
55
|
+
}
|
|
3
56
|
/**
|
|
4
57
|
* @public
|
|
5
58
|
* <p>The search criteria to be used to return quick connects.</p>
|