@aws-sdk/client-connect 3.799.0 → 3.803.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 +102 -3
- package/dist-es/models/models_0.js +6 -0
- package/dist-es/models/models_1.js +20 -0
- package/dist-es/protocols/Aws_restJson1.js +67 -0
- package/dist-types/commands/CreateContactCommand.d.ts +3 -2
- package/dist-types/commands/DeletePromptCommand.d.ts +1 -1
- package/dist-types/commands/DeletePushNotificationRegistrationCommand.d.ts +1 -2
- package/dist-types/commands/DescribeContactCommand.d.ts +46 -2
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/GetMetricDataCommand.d.ts +2 -2
- package/dist-types/commands/GetMetricDataV2Command.d.ts +2 -2
- package/dist-types/commands/ListPhoneNumbersV2Command.d.ts +2 -1
- package/dist-types/commands/ListPredefinedAttributesCommand.d.ts +1 -1
- package/dist-types/commands/ListPromptsCommand.d.ts +1 -1
- package/dist-types/commands/ListQueueQuickConnectsCommand.d.ts +1 -2
- package/dist-types/commands/SuspendContactRecordingCommand.d.ts +3 -5
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +2 -1
- package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/commands/UpdatePromptCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueMaxContactsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueNameCommand.d.ts +1 -1
- package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +68 -37
- package/dist-types/models/models_1.d.ts +426 -360
- package/dist-types/models/models_2.d.ts +225 -192
- package/dist-types/models/models_3.d.ts +225 -7
- package/dist-types/ts3.4/commands/DeletePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePushNotificationRegistrationCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/ListPhoneNumbersV2Command.d.ts +2 -4
- package/dist-types/ts3.4/commands/ListPredefinedAttributesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPromptsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListQueueQuickConnectsCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/UpdatePhoneNumberCommand.d.ts +2 -4
- package/dist-types/ts3.4/commands/UpdatePhoneNumberMetadataCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdatePromptCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueMaxContactsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueNameCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +18 -9
- package/dist-types/ts3.4/models/models_1.d.ts +62 -51
- package/dist-types/ts3.4/models/models_2.d.ts +51 -48
- package/dist-types/ts3.4/models/models_3.d.ts +56 -0
- package/package.json +4 -4
|
@@ -1,6 +1,42 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
|
|
3
|
-
import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PredefinedAttributeValues, QueueReference, QuickConnectConfig, ReferenceStatus, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
3
|
+
import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PredefinedAttributeValues, QueueReference, QuickConnectConfig, ReferenceStatus, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, SourceType, StorageType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface DeletePromptRequest {
|
|
8
|
+
/**
|
|
9
|
+
* <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>
|
|
10
|
+
* @public
|
|
11
|
+
*/
|
|
12
|
+
InstanceId: string | undefined;
|
|
13
|
+
/**
|
|
14
|
+
* <p>A unique identifier for the prompt.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
PromptId: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export interface DeletePushNotificationRegistrationRequest {
|
|
23
|
+
/**
|
|
24
|
+
* <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
|
|
25
|
+
* Amazon Resource Name (ARN) of the instance.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
InstanceId: string | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p>The identifier for the registration.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
RegistrationId: string | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* <p>The identifier of the contact within the Amazon Connect instance.</p>
|
|
36
|
+
* @public
|
|
37
|
+
*/
|
|
38
|
+
ContactId: string | undefined;
|
|
39
|
+
}
|
|
4
40
|
/**
|
|
5
41
|
* @public
|
|
6
42
|
*/
|
|
@@ -425,6 +461,78 @@ export declare const AnsweringMachineDetectionStatus: {
|
|
|
425
461
|
* @public
|
|
426
462
|
*/
|
|
427
463
|
export type AnsweringMachineDetectionStatus = (typeof AnsweringMachineDetectionStatus)[keyof typeof AnsweringMachineDetectionStatus];
|
|
464
|
+
/**
|
|
465
|
+
* <p>A map of string key/value pairs that contain user-defined attributes which are lightly typed
|
|
466
|
+
* within the contact. This object is used only for task contacts. </p>
|
|
467
|
+
* @public
|
|
468
|
+
*/
|
|
469
|
+
export interface ContactDetails {
|
|
470
|
+
/**
|
|
471
|
+
* <p>The name of the contact details.</p>
|
|
472
|
+
* @public
|
|
473
|
+
*/
|
|
474
|
+
Name?: string | undefined;
|
|
475
|
+
/**
|
|
476
|
+
* <p>Teh description of the contact details.</p>
|
|
477
|
+
* @public
|
|
478
|
+
*/
|
|
479
|
+
Description?: string | undefined;
|
|
480
|
+
}
|
|
481
|
+
/**
|
|
482
|
+
* @public
|
|
483
|
+
* @enum
|
|
484
|
+
*/
|
|
485
|
+
export declare const Status: {
|
|
486
|
+
readonly COMPLETE: "COMPLETE";
|
|
487
|
+
readonly DELETED: "DELETED";
|
|
488
|
+
readonly IN_PROGRESS: "IN_PROGRESS";
|
|
489
|
+
};
|
|
490
|
+
/**
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
export type Status = (typeof Status)[keyof typeof Status];
|
|
494
|
+
/**
|
|
495
|
+
* <p>Information about the contact evaluations where the key is the FormId, which is a unique
|
|
496
|
+
* identifier for the form.</p>
|
|
497
|
+
* @public
|
|
498
|
+
*/
|
|
499
|
+
export interface ContactEvaluation {
|
|
500
|
+
/**
|
|
501
|
+
* <p>The <code>FormId</code> of the contact evaluation.</p>
|
|
502
|
+
* @public
|
|
503
|
+
*/
|
|
504
|
+
FormId?: string | undefined;
|
|
505
|
+
/**
|
|
506
|
+
* <p>The Amazon Resource Name for the evaluation form. It is always present.</p>
|
|
507
|
+
* @public
|
|
508
|
+
*/
|
|
509
|
+
EvaluationArn?: string | undefined;
|
|
510
|
+
/**
|
|
511
|
+
* <p>The status of the evaluation.</p>
|
|
512
|
+
* @public
|
|
513
|
+
*/
|
|
514
|
+
Status?: Status | undefined;
|
|
515
|
+
/**
|
|
516
|
+
* <p>The date and time when the evaluation was started, in UTC time.</p>
|
|
517
|
+
* @public
|
|
518
|
+
*/
|
|
519
|
+
StartTimestamp?: Date | undefined;
|
|
520
|
+
/**
|
|
521
|
+
* <p>The date and time when the evaluation was submitted, in UTC time.</p>
|
|
522
|
+
* @public
|
|
523
|
+
*/
|
|
524
|
+
EndTimestamp?: Date | undefined;
|
|
525
|
+
/**
|
|
526
|
+
* <p>The date and time when the evaluation was deleted, in UTC time.</p>
|
|
527
|
+
* @public
|
|
528
|
+
*/
|
|
529
|
+
DeleteTimestamp?: Date | undefined;
|
|
530
|
+
/**
|
|
531
|
+
* <p>The path where evaluation was exported.</p>
|
|
532
|
+
* @public
|
|
533
|
+
*/
|
|
534
|
+
ExportLocation?: string | undefined;
|
|
535
|
+
}
|
|
428
536
|
/**
|
|
429
537
|
* <p>Information about the Customer on the contact.</p>
|
|
430
538
|
* @public
|
|
@@ -536,6 +644,124 @@ export interface QueueInfo {
|
|
|
536
644
|
*/
|
|
537
645
|
EnqueueTimestamp?: Date | undefined;
|
|
538
646
|
}
|
|
647
|
+
/**
|
|
648
|
+
* @public
|
|
649
|
+
* @enum
|
|
650
|
+
*/
|
|
651
|
+
export declare const MediaStreamType: {
|
|
652
|
+
readonly AUDIO: "AUDIO";
|
|
653
|
+
readonly VIDEO: "VIDEO";
|
|
654
|
+
};
|
|
655
|
+
/**
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
export type MediaStreamType = (typeof MediaStreamType)[keyof typeof MediaStreamType];
|
|
659
|
+
/**
|
|
660
|
+
* @public
|
|
661
|
+
* @enum
|
|
662
|
+
*/
|
|
663
|
+
export declare const ParticipantType: {
|
|
664
|
+
readonly AGENT: "AGENT";
|
|
665
|
+
readonly ALL: "ALL";
|
|
666
|
+
readonly CUSTOMER: "CUSTOMER";
|
|
667
|
+
readonly MANAGER: "MANAGER";
|
|
668
|
+
readonly THIRDPARTY: "THIRDPARTY";
|
|
669
|
+
};
|
|
670
|
+
/**
|
|
671
|
+
* @public
|
|
672
|
+
*/
|
|
673
|
+
export type ParticipantType = (typeof ParticipantType)[keyof typeof ParticipantType];
|
|
674
|
+
/**
|
|
675
|
+
* @public
|
|
676
|
+
* @enum
|
|
677
|
+
*/
|
|
678
|
+
export declare const RecordingStatus: {
|
|
679
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
680
|
+
readonly DELETED: "DELETED";
|
|
681
|
+
};
|
|
682
|
+
/**
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
export type RecordingStatus = (typeof RecordingStatus)[keyof typeof RecordingStatus];
|
|
686
|
+
/**
|
|
687
|
+
* <p>Information about a voice recording, chat transcript, or screen recording.</p>
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
export interface RecordingInfo {
|
|
691
|
+
/**
|
|
692
|
+
* <p>Where the recording/transcript is stored.</p>
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
StorageType?: StorageType | undefined;
|
|
696
|
+
/**
|
|
697
|
+
* <p>The location, in Amazon S3, for the recording/transcript.</p>
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
Location?: string | undefined;
|
|
701
|
+
/**
|
|
702
|
+
* <p>Information about the media stream used during the conversation.</p>
|
|
703
|
+
* @public
|
|
704
|
+
*/
|
|
705
|
+
MediaStreamType?: MediaStreamType | undefined;
|
|
706
|
+
/**
|
|
707
|
+
* <p>Information about the conversation participant, whether they are an agent or contact. The
|
|
708
|
+
* participant types are as follows:</p>
|
|
709
|
+
* <ul>
|
|
710
|
+
* <li>
|
|
711
|
+
* <p>All</p>
|
|
712
|
+
* </li>
|
|
713
|
+
* <li>
|
|
714
|
+
* <p>Manager</p>
|
|
715
|
+
* </li>
|
|
716
|
+
* <li>
|
|
717
|
+
* <p>Agent</p>
|
|
718
|
+
* </li>
|
|
719
|
+
* <li>
|
|
720
|
+
* <p>Customer</p>
|
|
721
|
+
* </li>
|
|
722
|
+
* <li>
|
|
723
|
+
* <p>Thirdparty</p>
|
|
724
|
+
* </li>
|
|
725
|
+
* <li>
|
|
726
|
+
* <p>Supervisor</p>
|
|
727
|
+
* </li>
|
|
728
|
+
* </ul>
|
|
729
|
+
* @public
|
|
730
|
+
*/
|
|
731
|
+
ParticipantType?: ParticipantType | undefined;
|
|
732
|
+
/**
|
|
733
|
+
* <p>The number that identifies the Kinesis Video Streams fragment where the customer audio
|
|
734
|
+
* stream started.</p>
|
|
735
|
+
* @public
|
|
736
|
+
*/
|
|
737
|
+
FragmentStartNumber?: string | undefined;
|
|
738
|
+
/**
|
|
739
|
+
* <p>The number that identifies the Kinesis Video Streams fragment where the customer audio
|
|
740
|
+
* stream stopped.</p>
|
|
741
|
+
* @public
|
|
742
|
+
*/
|
|
743
|
+
FragmentStopNumber?: string | undefined;
|
|
744
|
+
/**
|
|
745
|
+
* <p>When the conversation of the last leg of the recording started in UTC time.</p>
|
|
746
|
+
* @public
|
|
747
|
+
*/
|
|
748
|
+
StartTimestamp?: Date | undefined;
|
|
749
|
+
/**
|
|
750
|
+
* <p>When the conversation of the last leg of recording stopped in UTC time.</p>
|
|
751
|
+
* @public
|
|
752
|
+
*/
|
|
753
|
+
StopTimestamp?: Date | undefined;
|
|
754
|
+
/**
|
|
755
|
+
* <p>The status of the recording/transcript.</p>
|
|
756
|
+
* @public
|
|
757
|
+
*/
|
|
758
|
+
Status?: RecordingStatus | undefined;
|
|
759
|
+
/**
|
|
760
|
+
* <p>If the recording/transcript was deleted, this is the reason entered for the deletion.</p>
|
|
761
|
+
* @public
|
|
762
|
+
*/
|
|
763
|
+
DeletionReason?: string | undefined;
|
|
764
|
+
}
|
|
539
765
|
/**
|
|
540
766
|
* <p>An object to specify the expiration of a routing step.</p>
|
|
541
767
|
* @public
|
|
@@ -3703,8 +3929,8 @@ export declare const Unit: {
|
|
|
3703
3929
|
*/
|
|
3704
3930
|
export type Unit = (typeof Unit)[keyof typeof Unit];
|
|
3705
3931
|
/**
|
|
3706
|
-
* <p>Contains information about a real-time metric. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
3707
|
-
* Guide</i>.</p>
|
|
3932
|
+
* <p>Contains information about a real-time metric. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics
|
|
3933
|
+
* definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
3708
3934
|
* @public
|
|
3709
3935
|
*/
|
|
3710
3936
|
export interface CurrentMetric {
|
|
@@ -3857,70 +4083,71 @@ export interface GetCurrentMetricDataRequest {
|
|
|
3857
4083
|
Groupings?: Grouping[] | undefined;
|
|
3858
4084
|
/**
|
|
3859
4085
|
* <p>The metrics to retrieve. Specify the name and unit for each metric. The following metrics
|
|
3860
|
-
* are available. For a description of all the metrics, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
3861
|
-
*
|
|
4086
|
+
* are available. For a description of all the metrics, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definitions</a> in the
|
|
4087
|
+
* <i>Amazon Connect Administrator Guide</i>.</p>
|
|
3862
4088
|
* <dl>
|
|
3863
4089
|
* <dt>AGENTS_AFTER_CONTACT_WORK</dt>
|
|
3864
4090
|
* <dd>
|
|
3865
4091
|
* <p>Unit: COUNT</p>
|
|
3866
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4092
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aftercallwork-real-time">ACW</a>
|
|
3867
4093
|
* </p>
|
|
3868
4094
|
* </dd>
|
|
3869
4095
|
* <dt>AGENTS_AVAILABLE</dt>
|
|
3870
4096
|
* <dd>
|
|
3871
4097
|
* <p>Unit: COUNT</p>
|
|
3872
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4098
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#available-real-time">Available</a>
|
|
3873
4099
|
* </p>
|
|
3874
4100
|
* </dd>
|
|
3875
4101
|
* <dt>AGENTS_ERROR</dt>
|
|
3876
4102
|
* <dd>
|
|
3877
4103
|
* <p>Unit: COUNT</p>
|
|
3878
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4104
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-real-time">Error</a>
|
|
3879
4105
|
* </p>
|
|
3880
4106
|
* </dd>
|
|
3881
4107
|
* <dt>AGENTS_NON_PRODUCTIVE</dt>
|
|
3882
4108
|
* <dd>
|
|
3883
4109
|
* <p>Unit: COUNT</p>
|
|
3884
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4110
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-productive-time-real-time">NPT
|
|
4111
|
+
* (Non-Productive Time)</a>
|
|
3885
4112
|
* </p>
|
|
3886
4113
|
* </dd>
|
|
3887
4114
|
* <dt>AGENTS_ON_CALL</dt>
|
|
3888
4115
|
* <dd>
|
|
3889
4116
|
* <p>Unit: COUNT</p>
|
|
3890
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
3891
|
-
*
|
|
4117
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time">On
|
|
4118
|
+
* contact</a>
|
|
3892
4119
|
* </p>
|
|
3893
4120
|
* </dd>
|
|
3894
4121
|
* <dt>AGENTS_ON_CONTACT</dt>
|
|
3895
4122
|
* <dd>
|
|
3896
4123
|
* <p>Unit: COUNT</p>
|
|
3897
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
3898
|
-
*
|
|
4124
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#on-call-real-time">On
|
|
4125
|
+
* contact</a>
|
|
3899
4126
|
* </p>
|
|
3900
4127
|
* </dd>
|
|
3901
4128
|
* <dt>AGENTS_ONLINE</dt>
|
|
3902
4129
|
* <dd>
|
|
3903
4130
|
* <p>Unit: COUNT</p>
|
|
3904
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4131
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-real-time">Online</a>
|
|
3905
4132
|
* </p>
|
|
3906
4133
|
* </dd>
|
|
3907
4134
|
* <dt>AGENTS_STAFFED</dt>
|
|
3908
4135
|
* <dd>
|
|
3909
4136
|
* <p>Unit: COUNT</p>
|
|
3910
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4137
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#staffed-real-time">Staffed</a>
|
|
3911
4138
|
* </p>
|
|
3912
4139
|
* </dd>
|
|
3913
4140
|
* <dt>CONTACTS_IN_QUEUE</dt>
|
|
3914
4141
|
* <dd>
|
|
3915
4142
|
* <p>Unit: COUNT</p>
|
|
3916
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
3917
|
-
*
|
|
4143
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#in-queue-real-time">In
|
|
4144
|
+
* queue</a>
|
|
3918
4145
|
* </p>
|
|
3919
4146
|
* </dd>
|
|
3920
4147
|
* <dt>CONTACTS_SCHEDULED</dt>
|
|
3921
4148
|
* <dd>
|
|
3922
4149
|
* <p>Unit: COUNT</p>
|
|
3923
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4150
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-real-time">Scheduled</a>
|
|
3924
4151
|
* </p>
|
|
3925
4152
|
* </dd>
|
|
3926
4153
|
* <dt>OLDEST_CONTACT_AGE</dt>
|
|
@@ -3938,19 +4165,19 @@ export interface GetCurrentMetricDataRequest {
|
|
|
3938
4165
|
* <code><Expression 1></code> for 10 seconds has expired and <code><Expression 2></code>
|
|
3939
4166
|
* becomes active, then <code>OLDEST_CONTACT_AGE</code> for this queue will be counted starting
|
|
3940
4167
|
* from 10, not 0.</p>
|
|
3941
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4168
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#oldest-real-time">Oldest</a>
|
|
3942
4169
|
* </p>
|
|
3943
4170
|
* </dd>
|
|
3944
4171
|
* <dt>SLOTS_ACTIVE</dt>
|
|
3945
4172
|
* <dd>
|
|
3946
4173
|
* <p>Unit: COUNT</p>
|
|
3947
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4174
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#active-real-time">Active</a>
|
|
3948
4175
|
* </p>
|
|
3949
4176
|
* </dd>
|
|
3950
4177
|
* <dt>SLOTS_AVAILABLE</dt>
|
|
3951
4178
|
* <dd>
|
|
3952
4179
|
* <p>Unit: COUNT</p>
|
|
3953
|
-
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4180
|
+
* <p>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#availability-real-time">Availability</a>
|
|
3954
4181
|
* </p>
|
|
3955
4182
|
* </dd>
|
|
3956
4183
|
* </dl>
|
|
@@ -4591,8 +4818,8 @@ export interface Threshold {
|
|
|
4591
4818
|
ThresholdValue?: number | undefined;
|
|
4592
4819
|
}
|
|
4593
4820
|
/**
|
|
4594
|
-
* <p>Contains information about a historical metric. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4595
|
-
* Guide</i>.</p>
|
|
4821
|
+
* <p>Contains information about a historical metric. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics
|
|
4822
|
+
* definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
4596
4823
|
* @public
|
|
4597
4824
|
*/
|
|
4598
4825
|
export interface HistoricalMetric {
|
|
@@ -4668,8 +4895,8 @@ export interface GetMetricDataRequest {
|
|
|
4668
4895
|
Groupings?: Grouping[] | undefined;
|
|
4669
4896
|
/**
|
|
4670
4897
|
* <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The
|
|
4671
|
-
* following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
4672
|
-
* Guide</i>.</p>
|
|
4898
|
+
* following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics
|
|
4899
|
+
* definition</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
4673
4900
|
* <note>
|
|
4674
4901
|
* <p>This API does not support a contacts
|
|
4675
4902
|
* incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list). </p>
|
|
@@ -5010,8 +5237,8 @@ export interface MetricFilterV2 {
|
|
|
5010
5237
|
* <p>For valid values of metric-level filters <code>INITIATION_METHOD</code>,
|
|
5011
5238
|
* <code>DISCONNECT_REASON</code>, and <code>ANSWERING_MACHINE_DETECTION_STATUS</code>, 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 Guide</i>. </p>
|
|
5012
5239
|
* <p>For valid values of the metric-level filter <code>FLOWS_OUTCOME_TYPE</code>, see the
|
|
5013
|
-
* description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5014
|
-
* Guide</i>.</p>
|
|
5240
|
+
* description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome">Flow outcome</a>
|
|
5241
|
+
* metric in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
5015
5242
|
* <p>For valid values of the metric-level filter <code>BOT_CONVERSATION_OUTCOME_TYPE</code>, see
|
|
5016
5243
|
* the description for the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric">Bot
|
|
5017
5244
|
* conversations completed</a> in the <i>Amazon Connect Administrator
|
|
@@ -5282,15 +5509,16 @@ export interface GetMetricDataV2Request {
|
|
|
5282
5509
|
Groupings?: string[] | undefined;
|
|
5283
5510
|
/**
|
|
5284
5511
|
* <p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The
|
|
5285
|
-
* following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5286
|
-
* Guide</i>.</p>
|
|
5512
|
+
* following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics
|
|
5513
|
+
* definition</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
5287
5514
|
* <dl>
|
|
5288
5515
|
* <dt>ABANDONMENT_RATE</dt>
|
|
5289
5516
|
* <dd>
|
|
5290
5517
|
* <p>Unit: Percent</p>
|
|
5291
5518
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5292
5519
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5293
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5520
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#abandonment-rate">Abandonment
|
|
5521
|
+
* rate</a>
|
|
5294
5522
|
* </p>
|
|
5295
5523
|
* </dd>
|
|
5296
5524
|
* <dt>AGENT_ADHERENT_TIME</dt>
|
|
@@ -5298,28 +5526,30 @@ export interface GetMetricDataV2Request {
|
|
|
5298
5526
|
* <p>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</p>
|
|
5299
5527
|
* <p>Unit: Seconds</p>
|
|
5300
5528
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p>
|
|
5301
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5529
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#adherent-time">Adherent time</a>
|
|
5302
5530
|
* </p>
|
|
5303
5531
|
* </dd>
|
|
5304
5532
|
* <dt>AGENT_ANSWER_RATE</dt>
|
|
5305
5533
|
* <dd>
|
|
5306
5534
|
* <p>Unit: Percent</p>
|
|
5307
5535
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5308
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5536
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-answer-rate">Agent answer
|
|
5537
|
+
* rate</a>
|
|
5309
5538
|
* </p>
|
|
5310
5539
|
* </dd>
|
|
5311
5540
|
* <dt>AGENT_NON_ADHERENT_TIME</dt>
|
|
5312
5541
|
* <dd>
|
|
5313
5542
|
* <p>Unit: Seconds</p>
|
|
5314
5543
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5315
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5544
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-adherent-time">Non-adherent
|
|
5545
|
+
* time</a>
|
|
5316
5546
|
* </p>
|
|
5317
5547
|
* </dd>
|
|
5318
5548
|
* <dt>AGENT_NON_RESPONSE</dt>
|
|
5319
5549
|
* <dd>
|
|
5320
5550
|
* <p>Unit: Count</p>
|
|
5321
5551
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p>
|
|
5322
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5552
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">Agent
|
|
5323
5553
|
* non-response</a>
|
|
5324
5554
|
* </p>
|
|
5325
5555
|
* </dd>
|
|
@@ -5328,14 +5558,14 @@ export interface GetMetricDataV2Request {
|
|
|
5328
5558
|
* <p>Unit: Count</p>
|
|
5329
5559
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5330
5560
|
* <p>Data for this metric is available starting from October 1, 2023 0:00:00 GMT.</p>
|
|
5331
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5561
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response-without-customer-abandons">Agent non-response without customer abandons</a>
|
|
5332
5562
|
* </p>
|
|
5333
5563
|
* </dd>
|
|
5334
5564
|
* <dt>AGENT_OCCUPANCY</dt>
|
|
5335
5565
|
* <dd>
|
|
5336
5566
|
* <p>Unit: Percentage</p>
|
|
5337
5567
|
* <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy </p>
|
|
5338
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5568
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a>
|
|
5339
5569
|
* </p>
|
|
5340
5570
|
* </dd>
|
|
5341
5571
|
* <dt>AGENT_SCHEDULE_ADHERENCE</dt>
|
|
@@ -5343,7 +5573,7 @@ export interface GetMetricDataV2Request {
|
|
|
5343
5573
|
* <p>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</p>
|
|
5344
5574
|
* <p>Unit: Percent</p>
|
|
5345
5575
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5346
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5576
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#adherence">Adherence</a>
|
|
5347
5577
|
* </p>
|
|
5348
5578
|
* </dd>
|
|
5349
5579
|
* <dt>AGENT_SCHEDULED_TIME</dt>
|
|
@@ -5351,7 +5581,8 @@ export interface GetMetricDataV2Request {
|
|
|
5351
5581
|
* <p>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</p>
|
|
5352
5582
|
* <p>Unit: Seconds</p>
|
|
5353
5583
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5354
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5584
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#scheduled-time">Scheduled
|
|
5585
|
+
* time</a>
|
|
5355
5586
|
* </p>
|
|
5356
5587
|
* </dd>
|
|
5357
5588
|
* <dt>AVG_ABANDON_TIME</dt>
|
|
@@ -5359,14 +5590,16 @@ export interface GetMetricDataV2Request {
|
|
|
5359
5590
|
* <p>Unit: Seconds</p>
|
|
5360
5591
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5361
5592
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5362
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5593
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average
|
|
5594
|
+
* queue abandon time</a>
|
|
5363
5595
|
* </p>
|
|
5364
5596
|
* </dd>
|
|
5365
5597
|
* <dt>AVG_ACTIVE_TIME</dt>
|
|
5366
5598
|
* <dd>
|
|
5367
5599
|
* <p>Unit: Seconds</p>
|
|
5368
5600
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
5369
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5601
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-active-time">Average active
|
|
5602
|
+
* time</a>
|
|
5370
5603
|
* </p>
|
|
5371
5604
|
* </dd>
|
|
5372
5605
|
* <dt>AVG_AFTER_CONTACT_WORK_TIME</dt>
|
|
@@ -5376,7 +5609,8 @@ export interface GetMetricDataV2Request {
|
|
|
5376
5609
|
* </p>
|
|
5377
5610
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5378
5611
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5379
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5612
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">Average
|
|
5613
|
+
* after contact work time</a>
|
|
5380
5614
|
* </p>
|
|
5381
5615
|
* <note>
|
|
5382
5616
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5390,7 +5624,7 @@ export interface GetMetricDataV2Request {
|
|
|
5390
5624
|
* <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code>
|
|
5391
5625
|
* </p>
|
|
5392
5626
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
5393
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5627
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-api-connecting-time">Average agent API connecting time</a>
|
|
5394
5628
|
* </p>
|
|
5395
5629
|
* <note>
|
|
5396
5630
|
* <p>The <code>Negate</code> key in metric-level filters is not applicable for this
|
|
@@ -5401,7 +5635,8 @@ export interface GetMetricDataV2Request {
|
|
|
5401
5635
|
* <dd>
|
|
5402
5636
|
* <p>Unit: Seconds</p>
|
|
5403
5637
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
5404
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5638
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-pause-time">Average
|
|
5639
|
+
* agent pause time</a>
|
|
5405
5640
|
* </p>
|
|
5406
5641
|
* </dd>
|
|
5407
5642
|
* <dt>AVG_BOT_CONVERSATION_TIME</dt>
|
|
@@ -5411,8 +5646,8 @@ export interface GetMetricDataV2Request {
|
|
|
5411
5646
|
* version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
|
|
5412
5647
|
* Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
|
|
5413
5648
|
* resource ID</p>
|
|
5414
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time
|
|
5415
|
-
*
|
|
5649
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time">Average bot
|
|
5650
|
+
* conversation time</a>
|
|
5416
5651
|
* </p>
|
|
5417
5652
|
* </dd>
|
|
5418
5653
|
* <dt>AVG_BOT_CONVERSATION_TURNS</dt>
|
|
@@ -5422,7 +5657,8 @@ export interface GetMetricDataV2Request {
|
|
|
5422
5657
|
* version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
|
|
5423
5658
|
* Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
|
|
5424
5659
|
* resource ID</p>
|
|
5425
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-turns
|
|
5660
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-turns">Average bot
|
|
5661
|
+
* conversation turns</a>
|
|
5426
5662
|
* </p>
|
|
5427
5663
|
* </dd>
|
|
5428
5664
|
* <dt>AVG_CASE_RELATED_CONTACTS</dt>
|
|
@@ -5430,7 +5666,8 @@ export interface GetMetricDataV2Request {
|
|
|
5430
5666
|
* <p>Unit: Count</p>
|
|
5431
5667
|
* <p>Required filter key: CASE_TEMPLATE_ARN</p>
|
|
5432
5668
|
* <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p>
|
|
5433
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5669
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-contacts-per-case">Average
|
|
5670
|
+
* contacts per case</a>
|
|
5434
5671
|
* </p>
|
|
5435
5672
|
* </dd>
|
|
5436
5673
|
* <dt>AVG_CASE_RESOLUTION_TIME</dt>
|
|
@@ -5438,7 +5675,8 @@ export interface GetMetricDataV2Request {
|
|
|
5438
5675
|
* <p>Unit: Seconds</p>
|
|
5439
5676
|
* <p>Required filter key: CASE_TEMPLATE_ARN</p>
|
|
5440
5677
|
* <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p>
|
|
5441
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5678
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-case-resolution-time">Average
|
|
5679
|
+
* case resolution time</a>
|
|
5442
5680
|
* </p>
|
|
5443
5681
|
* </dd>
|
|
5444
5682
|
* <dt>AVG_CONTACT_DURATION</dt>
|
|
@@ -5446,7 +5684,8 @@ export interface GetMetricDataV2Request {
|
|
|
5446
5684
|
* <p>Unit: Seconds</p>
|
|
5447
5685
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5448
5686
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5449
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5687
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-contact-duration">Average
|
|
5688
|
+
* contact duration</a>
|
|
5450
5689
|
* </p>
|
|
5451
5690
|
* <note>
|
|
5452
5691
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5457,7 +5696,7 @@ export interface GetMetricDataV2Request {
|
|
|
5457
5696
|
* <p>Unit: Seconds</p>
|
|
5458
5697
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5459
5698
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5460
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5699
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-conversation-duration">Average conversation duration</a>
|
|
5461
5700
|
* </p>
|
|
5462
5701
|
* </dd>
|
|
5463
5702
|
* <dt>AVG_DIALS_PER_MINUTE</dt>
|
|
@@ -5466,7 +5705,8 @@ export interface GetMetricDataV2Request {
|
|
|
5466
5705
|
* and automated voice delivery modes.</p>
|
|
5467
5706
|
* <p>Unit: Count</p>
|
|
5468
5707
|
* <p>Valid groupings and filters: Agent, Campaign, Queue, Routing Profile</p>
|
|
5469
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5708
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-dials-per-minute">Average
|
|
5709
|
+
* dials per minute</a>
|
|
5470
5710
|
* </p>
|
|
5471
5711
|
* </dd>
|
|
5472
5712
|
* <dt>AVG_EVALUATION_SCORE</dt>
|
|
@@ -5474,7 +5714,8 @@ export interface GetMetricDataV2Request {
|
|
|
5474
5714
|
* <p>Unit: Percent</p>
|
|
5475
5715
|
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Section ID,
|
|
5476
5716
|
* Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile</p>
|
|
5477
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5717
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-evaluation-score">Average
|
|
5718
|
+
* evaluation score</a>
|
|
5478
5719
|
* </p>
|
|
5479
5720
|
* </dd>
|
|
5480
5721
|
* <dt>AVG_FLOW_TIME</dt>
|
|
@@ -5483,7 +5724,8 @@ export interface GetMetricDataV2Request {
|
|
|
5483
5724
|
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
|
|
5484
5725
|
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
|
|
5485
5726
|
* resource ID, Initiation method, Resource published timestamp</p>
|
|
5486
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5727
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-flow-time">Average flow
|
|
5728
|
+
* time</a>
|
|
5487
5729
|
* </p>
|
|
5488
5730
|
* </dd>
|
|
5489
5731
|
* <dt>AVG_GREETING_TIME_AGENT</dt>
|
|
@@ -5493,7 +5735,8 @@ export interface GetMetricDataV2Request {
|
|
|
5493
5735
|
* <p>Unit: Seconds</p>
|
|
5494
5736
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5495
5737
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5496
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5738
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-greeting-time">Average
|
|
5739
|
+
* agent greeting time</a>
|
|
5497
5740
|
* </p>
|
|
5498
5741
|
* </dd>
|
|
5499
5742
|
* <dt>AVG_HANDLE_TIME</dt>
|
|
@@ -5501,7 +5744,8 @@ export interface GetMetricDataV2Request {
|
|
|
5501
5744
|
* <p>Unit: Seconds</p>
|
|
5502
5745
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5503
5746
|
* contact/segmentAttributes/connect:Subtype, RoutingStepExpression</p>
|
|
5504
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5747
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle
|
|
5748
|
+
* time</a>
|
|
5505
5749
|
* </p>
|
|
5506
5750
|
* <note>
|
|
5507
5751
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5512,7 +5756,8 @@ export interface GetMetricDataV2Request {
|
|
|
5512
5756
|
* <p>Unit: Seconds</p>
|
|
5513
5757
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5514
5758
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5515
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5759
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average
|
|
5760
|
+
* customer hold time</a>
|
|
5516
5761
|
* </p>
|
|
5517
5762
|
* <note>
|
|
5518
5763
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5523,7 +5768,7 @@ export interface GetMetricDataV2Request {
|
|
|
5523
5768
|
* <p>Unit: Seconds</p>
|
|
5524
5769
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5525
5770
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5526
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5771
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time-all-contacts">Average customer hold time all contacts</a>
|
|
5527
5772
|
* </p>
|
|
5528
5773
|
* </dd>
|
|
5529
5774
|
* <dt>AVG_HOLDS</dt>
|
|
@@ -5531,7 +5776,7 @@ export interface GetMetricDataV2Request {
|
|
|
5531
5776
|
* <p>Unit: Count</p>
|
|
5532
5777
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5533
5778
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5534
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5779
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-holds">Average holds</a>
|
|
5535
5780
|
* </p>
|
|
5536
5781
|
* <note>
|
|
5537
5782
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5542,7 +5787,7 @@ export interface GetMetricDataV2Request {
|
|
|
5542
5787
|
* <p>Unit: Seconds</p>
|
|
5543
5788
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5544
5789
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5545
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5790
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time">Average agent interaction and customer hold time</a>
|
|
5546
5791
|
* </p>
|
|
5547
5792
|
* </dd>
|
|
5548
5793
|
* <dt>AVG_INTERACTION_TIME</dt>
|
|
@@ -5552,7 +5797,7 @@ export interface GetMetricDataV2Request {
|
|
|
5552
5797
|
* </p>
|
|
5553
5798
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature,
|
|
5554
5799
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5555
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5800
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-time">Average agent interaction time</a>
|
|
5556
5801
|
* </p>
|
|
5557
5802
|
* <note>
|
|
5558
5803
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5565,7 +5810,8 @@ export interface GetMetricDataV2Request {
|
|
|
5565
5810
|
* <p>Unit: Count</p>
|
|
5566
5811
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5567
5812
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5568
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5813
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interruptions">Average
|
|
5814
|
+
* agent interruptions</a>
|
|
5569
5815
|
* </p>
|
|
5570
5816
|
* </dd>
|
|
5571
5817
|
* <dt>AVG_INTERRUPTION_TIME_AGENT</dt>
|
|
@@ -5575,7 +5821,7 @@ export interface GetMetricDataV2Request {
|
|
|
5575
5821
|
* <p>Unit: Seconds</p>
|
|
5576
5822
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5577
5823
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5578
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5824
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interruption-time">Average agent interruption time</a>
|
|
5579
5825
|
* </p>
|
|
5580
5826
|
* </dd>
|
|
5581
5827
|
* <dt>AVG_NON_TALK_TIME</dt>
|
|
@@ -5585,7 +5831,8 @@ export interface GetMetricDataV2Request {
|
|
|
5585
5831
|
* <p>Unit: Seconds</p>
|
|
5586
5832
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5587
5833
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5588
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5834
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-non-talk-time">Average
|
|
5835
|
+
* non-talk time</a>
|
|
5589
5836
|
* </p>
|
|
5590
5837
|
* </dd>
|
|
5591
5838
|
* <dt>AVG_QUEUE_ANSWER_TIME</dt>
|
|
@@ -5593,7 +5840,8 @@ export interface GetMetricDataV2Request {
|
|
|
5593
5840
|
* <p>Unit: Seconds</p>
|
|
5594
5841
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature,
|
|
5595
5842
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5596
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5843
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-answer-time">Average
|
|
5844
|
+
* queue answer time</a>
|
|
5597
5845
|
* </p>
|
|
5598
5846
|
* <note>
|
|
5599
5847
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5604,7 +5852,8 @@ export interface GetMetricDataV2Request {
|
|
|
5604
5852
|
* <p>Unit: Seconds</p>
|
|
5605
5853
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
|
|
5606
5854
|
* Q in Connect</p>
|
|
5607
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5855
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-resolution-time">Average
|
|
5856
|
+
* resolution time</a>
|
|
5608
5857
|
* </p>
|
|
5609
5858
|
* </dd>
|
|
5610
5859
|
* <dt>AVG_TALK_TIME</dt>
|
|
@@ -5614,7 +5863,8 @@ export interface GetMetricDataV2Request {
|
|
|
5614
5863
|
* <p>Unit: Seconds</p>
|
|
5615
5864
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5616
5865
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5617
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5866
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-talk-time">Average talk
|
|
5867
|
+
* time</a>
|
|
5618
5868
|
* </p>
|
|
5619
5869
|
* </dd>
|
|
5620
5870
|
* <dt>AVG_TALK_TIME_AGENT</dt>
|
|
@@ -5624,7 +5874,8 @@ export interface GetMetricDataV2Request {
|
|
|
5624
5874
|
* <p>Unit: Seconds</p>
|
|
5625
5875
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5626
5876
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5627
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5877
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-talk-time">Average
|
|
5878
|
+
* agent talk time</a>
|
|
5628
5879
|
* </p>
|
|
5629
5880
|
* </dd>
|
|
5630
5881
|
* <dt>AVG_TALK_TIME_CUSTOMER</dt>
|
|
@@ -5634,7 +5885,8 @@ export interface GetMetricDataV2Request {
|
|
|
5634
5885
|
* <p>Unit: Seconds</p>
|
|
5635
5886
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5636
5887
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5637
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5888
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-talk-time">Average
|
|
5889
|
+
* customer talk time</a>
|
|
5638
5890
|
* </p>
|
|
5639
5891
|
* </dd>
|
|
5640
5892
|
* <dt>AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION</dt>
|
|
@@ -5643,7 +5895,7 @@ export interface GetMetricDataV2Request {
|
|
|
5643
5895
|
* and automated voice delivery modes.</p>
|
|
5644
5896
|
* <p>Unit: Seconds</p>
|
|
5645
5897
|
* <p>Valid groupings and filters: Campaign</p>
|
|
5646
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5898
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-wait-time-after-customer-connection">Average wait time after customer connection</a>
|
|
5647
5899
|
* </p>
|
|
5648
5900
|
* </dd>
|
|
5649
5901
|
* <dt>AVG_WEIGHTED_EVALUATION_SCORE</dt>
|
|
@@ -5651,7 +5903,7 @@ export interface GetMetricDataV2Request {
|
|
|
5651
5903
|
* <p>Unit: Percent</p>
|
|
5652
5904
|
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form Id, Evaluation Section ID,
|
|
5653
5905
|
* Evaluation Question ID, Evaluation Source, Form Version, Queue, Routing Profile</p>
|
|
5654
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5906
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-weighted-evaluation-score">Average weighted evaluation score</a>
|
|
5655
5907
|
* </p>
|
|
5656
5908
|
* </dd>
|
|
5657
5909
|
* <dt>BOT_CONVERSATIONS_COMPLETED</dt>
|
|
@@ -5661,8 +5913,8 @@ export interface GetMetricDataV2Request {
|
|
|
5661
5913
|
* version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
|
|
5662
5914
|
* Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
|
|
5663
5915
|
* resource ID</p>
|
|
5664
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed
|
|
5665
|
-
* conversations</a>
|
|
5916
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed">Bot
|
|
5917
|
+
* conversations completed</a>
|
|
5666
5918
|
* </p>
|
|
5667
5919
|
* </dd>
|
|
5668
5920
|
* <dt>BOT_INTENTS_COMPLETED</dt>
|
|
@@ -5672,7 +5924,7 @@ export interface GetMetricDataV2Request {
|
|
|
5672
5924
|
* version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,
|
|
5673
5925
|
* Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource
|
|
5674
5926
|
* type, Parent flows resource ID</p>
|
|
5675
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed
|
|
5927
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed">Bot intents
|
|
5676
5928
|
* completed</a>
|
|
5677
5929
|
* </p>
|
|
5678
5930
|
* </dd>
|
|
@@ -5685,7 +5937,7 @@ export interface GetMetricDataV2Request {
|
|
|
5685
5937
|
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5686
5938
|
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for
|
|
5687
5939
|
* <i>Greater than</i>).</p>
|
|
5688
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5940
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x">Campaign contacts abandoned after X</a>
|
|
5689
5941
|
* </p>
|
|
5690
5942
|
* </dd>
|
|
5691
5943
|
* <dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE</dt>
|
|
@@ -5697,7 +5949,7 @@ export interface GetMetricDataV2Request {
|
|
|
5697
5949
|
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5698
5950
|
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>GT</code> (for
|
|
5699
5951
|
* <i>Greater than</i>).</p>
|
|
5700
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5952
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-contacts-abandoned-after-x-rate">Campaign contacts abandoned after X rate</a>
|
|
5701
5953
|
* </p>
|
|
5702
5954
|
* </dd>
|
|
5703
5955
|
* <dt>CAMPAIGN_INTERACTIONS</dt>
|
|
@@ -5706,7 +5958,8 @@ export interface GetMetricDataV2Request {
|
|
|
5706
5958
|
* <p>Unit: Count</p>
|
|
5707
5959
|
* <p>Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE</p>
|
|
5708
5960
|
* <p>Valid groupings and filters: Campaign</p>
|
|
5709
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5961
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-interactions">Campaign
|
|
5962
|
+
* interactions</a>
|
|
5710
5963
|
* </p>
|
|
5711
5964
|
* </dd>
|
|
5712
5965
|
* <dt>CAMPAIGN_SEND_ATTEMPTS</dt>
|
|
@@ -5714,7 +5967,8 @@ export interface GetMetricDataV2Request {
|
|
|
5714
5967
|
* <p>This metric is available only for outbound campaigns.</p>
|
|
5715
5968
|
* <p>Unit: Count</p>
|
|
5716
5969
|
* <p>Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype </p>
|
|
5717
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5970
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#campaign-send-attempts">Campaign send
|
|
5971
|
+
* attempts</a>
|
|
5718
5972
|
* </p>
|
|
5719
5973
|
* </dd>
|
|
5720
5974
|
* <dt>CASES_CREATED</dt>
|
|
@@ -5722,7 +5976,7 @@ export interface GetMetricDataV2Request {
|
|
|
5722
5976
|
* <p>Unit: Count</p>
|
|
5723
5977
|
* <p>Required filter key: CASE_TEMPLATE_ARN</p>
|
|
5724
5978
|
* <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p>
|
|
5725
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5979
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-created">Cases created</a>
|
|
5726
5980
|
* </p>
|
|
5727
5981
|
* </dd>
|
|
5728
5982
|
* <dt>CONTACTS_CREATED</dt>
|
|
@@ -5732,7 +5986,8 @@ export interface GetMetricDataV2Request {
|
|
|
5732
5986
|
* </p>
|
|
5733
5987
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Feature,
|
|
5734
5988
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5735
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
5989
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-created">Contacts
|
|
5990
|
+
* created</a>
|
|
5736
5991
|
* </p>
|
|
5737
5992
|
* <note>
|
|
5738
5993
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5746,7 +6001,8 @@ export interface GetMetricDataV2Request {
|
|
|
5746
6001
|
* </p>
|
|
5747
6002
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5748
6003
|
* contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p>
|
|
5749
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6004
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts
|
|
6005
|
+
* handled</a>
|
|
5750
6006
|
* </p>
|
|
5751
6007
|
* <note>
|
|
5752
6008
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5759,7 +6015,7 @@ export interface GetMetricDataV2Request {
|
|
|
5759
6015
|
* </p>
|
|
5760
6016
|
* <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
|
5761
6017
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5762
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6018
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-by-connected-to-agent-timestamp">Contacts handled (connected to agent timestamp)</a>
|
|
5763
6019
|
* </p>
|
|
5764
6020
|
* </dd>
|
|
5765
6021
|
* <dt>CONTACTS_HOLD_ABANDONS</dt>
|
|
@@ -5767,42 +6023,44 @@ export interface GetMetricDataV2Request {
|
|
|
5767
6023
|
* <p>Unit: Count</p>
|
|
5768
6024
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5769
6025
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5770
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6026
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts
|
|
6027
|
+
* hold disconnect</a>
|
|
5771
6028
|
* </p>
|
|
5772
6029
|
* </dd>
|
|
5773
6030
|
* <dt>CONTACTS_ON_HOLD_AGENT_DISCONNECT</dt>
|
|
5774
6031
|
* <dd>
|
|
5775
6032
|
* <p>Unit: Count</p>
|
|
5776
6033
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
5777
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6034
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-agent-disconnect">Contacts hold agent disconnect</a>
|
|
5778
6035
|
* </p>
|
|
5779
6036
|
* </dd>
|
|
5780
6037
|
* <dt>CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT</dt>
|
|
5781
6038
|
* <dd>
|
|
5782
6039
|
* <p>Unit: Count</p>
|
|
5783
6040
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
5784
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6041
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-customer-disconnect">Contacts hold customer disconnect</a>
|
|
5785
6042
|
* </p>
|
|
5786
6043
|
* </dd>
|
|
5787
6044
|
* <dt>CONTACTS_PUT_ON_HOLD</dt>
|
|
5788
6045
|
* <dd>
|
|
5789
6046
|
* <p>Unit: Count</p>
|
|
5790
6047
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
5791
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6048
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-put-on-hold">Contacts put on
|
|
6049
|
+
* hold</a>
|
|
5792
6050
|
* </p>
|
|
5793
6051
|
* </dd>
|
|
5794
6052
|
* <dt>CONTACTS_TRANSFERRED_OUT_EXTERNAL</dt>
|
|
5795
6053
|
* <dd>
|
|
5796
6054
|
* <p>Unit: Count</p>
|
|
5797
6055
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
5798
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6056
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-external">Contacts transferred out external</a>
|
|
5799
6057
|
* </p>
|
|
5800
6058
|
* </dd>
|
|
5801
6059
|
* <dt>CONTACTS_TRANSFERRED_OUT_INTERNAL</dt>
|
|
5802
6060
|
* <dd>
|
|
5803
6061
|
* <p>Unit: Percent</p>
|
|
5804
6062
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
5805
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6063
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-internal">Contacts transferred out internal</a>
|
|
5806
6064
|
* </p>
|
|
5807
6065
|
* </dd>
|
|
5808
6066
|
* <dt>CONTACTS_QUEUED</dt>
|
|
@@ -5810,7 +6068,8 @@ export interface GetMetricDataV2Request {
|
|
|
5810
6068
|
* <p>Unit: Count</p>
|
|
5811
6069
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5812
6070
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5813
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6071
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts
|
|
6072
|
+
* queued</a>
|
|
5814
6073
|
* </p>
|
|
5815
6074
|
* </dd>
|
|
5816
6075
|
* <dt>CONTACTS_QUEUED_BY_ENQUEUE</dt>
|
|
@@ -5818,7 +6077,8 @@ export interface GetMetricDataV2Request {
|
|
|
5818
6077
|
* <p>Unit: Count</p>
|
|
5819
6078
|
* <p>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy,
|
|
5820
6079
|
* contact/segmentAttributes/connect:Subtype</p>
|
|
5821
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6080
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued-by-enqueue">Contacts
|
|
6081
|
+
* queued (enqueue timestamp)</a>
|
|
5822
6082
|
* </p>
|
|
5823
6083
|
* </dd>
|
|
5824
6084
|
* <dt>CONTACTS_REMOVED_FROM_QUEUE_IN_X</dt>
|
|
@@ -5828,7 +6088,8 @@ export interface GetMetricDataV2Request {
|
|
|
5828
6088
|
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5829
6089
|
* (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for "Less
|
|
5830
6090
|
* than") or <code>LTE</code> (for "Less than equal").</p>
|
|
5831
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6091
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-removed-from-queue">Contacts
|
|
6092
|
+
* removed from queue in X seconds</a>
|
|
5832
6093
|
* </p>
|
|
5833
6094
|
* </dd>
|
|
5834
6095
|
* <dt>CONTACTS_RESOLVED_IN_X</dt>
|
|
@@ -5839,7 +6100,8 @@ export interface GetMetricDataV2Request {
|
|
|
5839
6100
|
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5840
6101
|
* (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for "Less
|
|
5841
6102
|
* than") or <code>LTE</code> (for "Less than equal").</p>
|
|
5842
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6103
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-resolved">Contacts resolved
|
|
6104
|
+
* in X</a>
|
|
5843
6105
|
* </p>
|
|
5844
6106
|
* </dd>
|
|
5845
6107
|
* <dt>CONTACTS_TRANSFERRED_OUT</dt>
|
|
@@ -5847,7 +6109,8 @@ export interface GetMetricDataV2Request {
|
|
|
5847
6109
|
* <p>Unit: Count</p>
|
|
5848
6110
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature,
|
|
5849
6111
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5850
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6112
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts
|
|
6113
|
+
* transferred out</a>
|
|
5851
6114
|
* </p>
|
|
5852
6115
|
* <note>
|
|
5853
6116
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
@@ -5858,7 +6121,7 @@ export interface GetMetricDataV2Request {
|
|
|
5858
6121
|
* <p>Unit: Count</p>
|
|
5859
6122
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5860
6123
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5861
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6124
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-by-agent">Contacts transferred out by agent</a>
|
|
5862
6125
|
* </p>
|
|
5863
6126
|
* </dd>
|
|
5864
6127
|
* <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
|
|
@@ -5866,7 +6129,7 @@ export interface GetMetricDataV2Request {
|
|
|
5866
6129
|
* <p>Unit: Count</p>
|
|
5867
6130
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5868
6131
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5869
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6132
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out queue</a>
|
|
5870
6133
|
* </p>
|
|
5871
6134
|
* </dd>
|
|
5872
6135
|
* <dt>CURRENT_CASES</dt>
|
|
@@ -5874,7 +6137,7 @@ export interface GetMetricDataV2Request {
|
|
|
5874
6137
|
* <p>Unit: Count</p>
|
|
5875
6138
|
* <p>Required filter key: CASE_TEMPLATE_ARN</p>
|
|
5876
6139
|
* <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p>
|
|
5877
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6140
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#current-cases">Current cases</a>
|
|
5878
6141
|
* </p>
|
|
5879
6142
|
* </dd>
|
|
5880
6143
|
* <dt>DELIVERY_ATTEMPTS</dt>
|
|
@@ -5887,7 +6150,8 @@ export interface GetMetricDataV2Request {
|
|
|
5887
6150
|
* <p>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery
|
|
5888
6151
|
* EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue,
|
|
5889
6152
|
* Routing Profile</p>
|
|
5890
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6153
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempts">Delivery
|
|
6154
|
+
* attempts</a>
|
|
5891
6155
|
* </p>
|
|
5892
6156
|
* <note>
|
|
5893
6157
|
* <p>Campaign Delivery EventType filter and grouping are only available for SMS and Email
|
|
@@ -5907,7 +6171,7 @@ export interface GetMetricDataV2Request {
|
|
|
5907
6171
|
* </p>
|
|
5908
6172
|
* <p>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel,
|
|
5909
6173
|
* contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile</p>
|
|
5910
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6174
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#delivery-attempt-disposition-rate">Delivery attempt disposition rate</a>
|
|
5911
6175
|
* </p>
|
|
5912
6176
|
* <note>
|
|
5913
6177
|
* <p>Campaign Delivery Event Type filter and grouping are only available for SMS and Email
|
|
@@ -5921,7 +6185,8 @@ export interface GetMetricDataV2Request {
|
|
|
5921
6185
|
* <p>Unit: Count</p>
|
|
5922
6186
|
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form
|
|
5923
6187
|
* Version, Queue, Routing Profile</p>
|
|
5924
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6188
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#evaluations-performed">Evaluations
|
|
6189
|
+
* performed</a>
|
|
5925
6190
|
* </p>
|
|
5926
6191
|
* </dd>
|
|
5927
6192
|
* <dt>FLOWS_OUTCOME</dt>
|
|
@@ -5930,7 +6195,8 @@ export interface GetMetricDataV2Request {
|
|
|
5930
6195
|
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
|
|
5931
6196
|
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
|
|
5932
6197
|
* resource ID, Initiation method, Resource published timestamp</p>
|
|
5933
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6198
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome">Flows
|
|
6199
|
+
* outcome</a>
|
|
5934
6200
|
* </p>
|
|
5935
6201
|
* </dd>
|
|
5936
6202
|
* <dt>FLOWS_STARTED</dt>
|
|
@@ -5938,7 +6204,8 @@ export interface GetMetricDataV2Request {
|
|
|
5938
6204
|
* <p>Unit: Count</p>
|
|
5939
6205
|
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
|
|
5940
6206
|
* resource ID, Flows resource ID, Initiation method, Resource published timestamp</p>
|
|
5941
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6207
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-started">Flows
|
|
6208
|
+
* started</a>
|
|
5942
6209
|
* </p>
|
|
5943
6210
|
* </dd>
|
|
5944
6211
|
* <dt>HUMAN_ANSWERED_CALLS</dt>
|
|
@@ -5948,7 +6215,8 @@ export interface GetMetricDataV2Request {
|
|
|
5948
6215
|
* enabled. </p>
|
|
5949
6216
|
* <p>Unit: Count</p>
|
|
5950
6217
|
* <p>Valid groupings and filters: Agent, Campaign</p>
|
|
5951
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6218
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#human-answered">Human
|
|
6219
|
+
* answered</a>
|
|
5952
6220
|
* </p>
|
|
5953
6221
|
* </dd>
|
|
5954
6222
|
* <dt>MAX_FLOW_TIME</dt>
|
|
@@ -5957,7 +6225,8 @@ export interface GetMetricDataV2Request {
|
|
|
5957
6225
|
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
|
|
5958
6226
|
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
|
|
5959
6227
|
* resource ID, Initiation method, Resource published timestamp</p>
|
|
5960
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6228
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-flow-time">Maximum flow
|
|
6229
|
+
* time</a>
|
|
5961
6230
|
* </p>
|
|
5962
6231
|
* </dd>
|
|
5963
6232
|
* <dt>MAX_QUEUED_TIME</dt>
|
|
@@ -5965,7 +6234,8 @@ export interface GetMetricDataV2Request {
|
|
|
5965
6234
|
* <p>Unit: Seconds</p>
|
|
5966
6235
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
5967
6236
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
5968
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6237
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#maximum-queued-time">Maximum queued
|
|
6238
|
+
* time</a>
|
|
5969
6239
|
* </p>
|
|
5970
6240
|
* </dd>
|
|
5971
6241
|
* <dt>MIN_FLOW_TIME</dt>
|
|
@@ -5974,7 +6244,8 @@ export interface GetMetricDataV2Request {
|
|
|
5974
6244
|
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
|
|
5975
6245
|
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
|
|
5976
6246
|
* resource ID, Initiation method, Resource published timestamp</p>
|
|
5977
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6247
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow
|
|
6248
|
+
* time</a>
|
|
5978
6249
|
* </p>
|
|
5979
6250
|
* </dd>
|
|
5980
6251
|
* <dt>PERCENT_AUTOMATIC_FAILS</dt>
|
|
@@ -5982,7 +6253,8 @@ export interface GetMetricDataV2Request {
|
|
|
5982
6253
|
* <p>Unit: Percent</p>
|
|
5983
6254
|
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, Evaluation Form ID, Evaluation Source, Form
|
|
5984
6255
|
* Version, Queue, Routing Profile</p>
|
|
5985
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6256
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#automatic-fails-percent">Automatic
|
|
6257
|
+
* fails percent</a>
|
|
5986
6258
|
* </p>
|
|
5987
6259
|
* </dd>
|
|
5988
6260
|
* <dt>PERCENT_BOT_CONVERSATIONS_OUTCOME</dt>
|
|
@@ -5992,7 +6264,8 @@ export interface GetMetricDataV2Request {
|
|
|
5992
6264
|
* version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID,
|
|
5993
6265
|
* Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows
|
|
5994
6266
|
* resource ID</p>
|
|
5995
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome
|
|
6267
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome">Percent
|
|
6268
|
+
* bot conversations outcome</a>
|
|
5996
6269
|
* </p>
|
|
5997
6270
|
* </dd>
|
|
5998
6271
|
* <dt>PERCENT_BOT_INTENTS_OUTCOME</dt>
|
|
@@ -6002,8 +6275,8 @@ export interface GetMetricDataV2Request {
|
|
|
6002
6275
|
* version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type,
|
|
6003
6276
|
* Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource
|
|
6004
6277
|
* type, Parent flows resource ID</p>
|
|
6005
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome
|
|
6006
|
-
*
|
|
6278
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome">Percent bot
|
|
6279
|
+
* intents outcome</a>
|
|
6007
6280
|
* </p>
|
|
6008
6281
|
* </dd>
|
|
6009
6282
|
* <dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt>
|
|
@@ -6011,7 +6284,7 @@ export interface GetMetricDataV2Request {
|
|
|
6011
6284
|
* <p>Unit: Percent</p>
|
|
6012
6285
|
* <p>Required filter key: CASE_TEMPLATE_ARN</p>
|
|
6013
6286
|
* <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p>
|
|
6014
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6287
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved-on-first-contact">Cases resolved on first contact</a>
|
|
6015
6288
|
* </p>
|
|
6016
6289
|
* </dd>
|
|
6017
6290
|
* <dt>PERCENT_CONTACTS_STEP_EXPIRED</dt>
|
|
@@ -6036,7 +6309,8 @@ export interface GetMetricDataV2Request {
|
|
|
6036
6309
|
* <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
|
|
6037
6310
|
* resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
|
|
6038
6311
|
* resource ID, Initiation method, Resource published timestamp</p>
|
|
6039
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6312
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#flows-outcome-percentage">Flows
|
|
6313
|
+
* outcome percentage</a>.</p>
|
|
6040
6314
|
* <note>
|
|
6041
6315
|
* <p>The <code>FLOWS_OUTCOME_TYPE</code> is not a valid grouping.</p>
|
|
6042
6316
|
* </note>
|
|
@@ -6048,8 +6322,8 @@ export interface GetMetricDataV2Request {
|
|
|
6048
6322
|
* <p>Unit: Percentage</p>
|
|
6049
6323
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
6050
6324
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
6051
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6052
|
-
*
|
|
6325
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#non-talk-time-percent">Non-talk time
|
|
6326
|
+
* percent</a>
|
|
6053
6327
|
* </p>
|
|
6054
6328
|
* </dd>
|
|
6055
6329
|
* <dt>PERCENT_TALK_TIME</dt>
|
|
@@ -6059,7 +6333,7 @@ export interface GetMetricDataV2Request {
|
|
|
6059
6333
|
* <p>Unit: Percentage</p>
|
|
6060
6334
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
6061
6335
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
6062
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6336
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#talk-time-percent">Talk time
|
|
6063
6337
|
* percent</a>
|
|
6064
6338
|
* </p>
|
|
6065
6339
|
* </dd>
|
|
@@ -6070,8 +6344,8 @@ export interface GetMetricDataV2Request {
|
|
|
6070
6344
|
* <p>Unit: Percentage</p>
|
|
6071
6345
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
6072
6346
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
6073
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6074
|
-
*
|
|
6347
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-talk-time-percent">Agent talk
|
|
6348
|
+
* time percent</a>
|
|
6075
6349
|
* </p>
|
|
6076
6350
|
* </dd>
|
|
6077
6351
|
* <dt>PERCENT_TALK_TIME_CUSTOMER</dt>
|
|
@@ -6081,7 +6355,8 @@ export interface GetMetricDataV2Request {
|
|
|
6081
6355
|
* <p>Unit: Percentage</p>
|
|
6082
6356
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
6083
6357
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
6084
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6358
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-talk-time-percent">Customer
|
|
6359
|
+
* talk time percent</a>
|
|
6085
6360
|
* </p>
|
|
6086
6361
|
* </dd>
|
|
6087
6362
|
* <dt>REOPENED_CASE_ACTIONS</dt>
|
|
@@ -6089,7 +6364,8 @@ export interface GetMetricDataV2Request {
|
|
|
6089
6364
|
* <p>Unit: Count</p>
|
|
6090
6365
|
* <p>Required filter key: CASE_TEMPLATE_ARN</p>
|
|
6091
6366
|
* <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p>
|
|
6092
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6367
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-reopened">Cases
|
|
6368
|
+
* reopened</a>
|
|
6093
6369
|
* </p>
|
|
6094
6370
|
* </dd>
|
|
6095
6371
|
* <dt>RESOLVED_CASE_ACTIONS</dt>
|
|
@@ -6097,7 +6373,8 @@ export interface GetMetricDataV2Request {
|
|
|
6097
6373
|
* <p>Unit: Count</p>
|
|
6098
6374
|
* <p>Required filter key: CASE_TEMPLATE_ARN</p>
|
|
6099
6375
|
* <p>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</p>
|
|
6100
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6376
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#cases-resolved">Cases
|
|
6377
|
+
* resolved</a>
|
|
6101
6378
|
* </p>
|
|
6102
6379
|
* </dd>
|
|
6103
6380
|
* <dt>SERVICE_LEVEL</dt>
|
|
@@ -6108,7 +6385,8 @@ export interface GetMetricDataV2Request {
|
|
|
6108
6385
|
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
6109
6386
|
* (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for "Less
|
|
6110
6387
|
* than") or <code>LTE</code> (for "Less than equal").</p>
|
|
6111
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6388
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level">Service level
|
|
6389
|
+
* X</a>
|
|
6112
6390
|
* </p>
|
|
6113
6391
|
* </dd>
|
|
6114
6392
|
* <dt>STEP_CONTACTS_QUEUED</dt>
|
|
@@ -6122,7 +6400,7 @@ export interface GetMetricDataV2Request {
|
|
|
6122
6400
|
* <dd>
|
|
6123
6401
|
* <p>Unit: Seconds</p>
|
|
6124
6402
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
6125
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6403
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After
|
|
6126
6404
|
* contact work time</a>
|
|
6127
6405
|
* </p>
|
|
6128
6406
|
* </dd>
|
|
@@ -6134,7 +6412,8 @@ export interface GetMetricDataV2Request {
|
|
|
6134
6412
|
* <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code>
|
|
6135
6413
|
* </p>
|
|
6136
6414
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
6137
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6415
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-api-connecting-time">Agent API
|
|
6416
|
+
* connecting time</a>
|
|
6138
6417
|
* </p>
|
|
6139
6418
|
* <note>
|
|
6140
6419
|
* <p>The <code>Negate</code> key in metric-level filters is not applicable for this
|
|
@@ -6155,7 +6434,8 @@ export interface GetMetricDataV2Request {
|
|
|
6155
6434
|
* </ul>
|
|
6156
6435
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
6157
6436
|
* contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p>
|
|
6158
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6437
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contact
|
|
6438
|
+
* abandoned</a>
|
|
6159
6439
|
* </p>
|
|
6160
6440
|
* </dd>
|
|
6161
6441
|
* <dt>SUM_CONTACTS_ABANDONED_IN_X</dt>
|
|
@@ -6166,7 +6446,7 @@ export interface GetMetricDataV2Request {
|
|
|
6166
6446
|
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
6167
6447
|
* (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for "Less
|
|
6168
6448
|
* than") or <code>LTE</code> (for "Less than equal").</p>
|
|
6169
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6449
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned-in-x-seconds">Contacts abandoned in X seconds</a>
|
|
6170
6450
|
* </p>
|
|
6171
6451
|
* </dd>
|
|
6172
6452
|
* <dt>SUM_CONTACTS_ANSWERED_IN_X</dt>
|
|
@@ -6177,21 +6457,23 @@ export interface GetMetricDataV2Request {
|
|
|
6177
6457
|
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
6178
6458
|
* (inclusive), in seconds. For <code>Comparison</code>, you can use <code>LT</code> (for "Less
|
|
6179
6459
|
* than") or <code>LTE</code> (for "Less than equal").</p>
|
|
6180
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6460
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-answered-in-x-seconds">Contacts answered in X seconds</a>
|
|
6181
6461
|
* </p>
|
|
6182
6462
|
* </dd>
|
|
6183
6463
|
* <dt>SUM_CONTACT_FLOW_TIME</dt>
|
|
6184
6464
|
* <dd>
|
|
6185
6465
|
* <p>Unit: Seconds</p>
|
|
6186
6466
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
6187
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6467
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-flow-time">Contact flow
|
|
6468
|
+
* time</a>
|
|
6188
6469
|
* </p>
|
|
6189
6470
|
* </dd>
|
|
6190
6471
|
* <dt>SUM_CONTACT_TIME_AGENT</dt>
|
|
6191
6472
|
* <dd>
|
|
6192
6473
|
* <p>Unit: Seconds</p>
|
|
6193
6474
|
* <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p>
|
|
6194
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6475
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-on-contact-time">Agent on
|
|
6476
|
+
* contact time</a>
|
|
6195
6477
|
* </p>
|
|
6196
6478
|
* </dd>
|
|
6197
6479
|
* <dt>SUM_CONTACTS_DISCONNECTED </dt>
|
|
@@ -6201,63 +6483,70 @@ export interface GetMetricDataV2Request {
|
|
|
6201
6483
|
* <p>Unit: Count</p>
|
|
6202
6484
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
|
|
6203
6485
|
* contact/segmentAttributes/connect:Subtype, Q in Connect</p>
|
|
6204
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6486
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-disconnected">Contact
|
|
6487
|
+
* disconnected</a>
|
|
6205
6488
|
* </p>
|
|
6206
6489
|
* </dd>
|
|
6207
6490
|
* <dt>SUM_ERROR_STATUS_TIME_AGENT</dt>
|
|
6208
6491
|
* <dd>
|
|
6209
6492
|
* <p>Unit: Seconds</p>
|
|
6210
6493
|
* <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p>
|
|
6211
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6494
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#error-status-time">Error status
|
|
6495
|
+
* time</a>
|
|
6212
6496
|
* </p>
|
|
6213
6497
|
* </dd>
|
|
6214
6498
|
* <dt>SUM_HANDLE_TIME</dt>
|
|
6215
6499
|
* <dd>
|
|
6216
6500
|
* <p>Unit: Seconds</p>
|
|
6217
6501
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
6218
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6502
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contact-handle-time">Contact handle
|
|
6503
|
+
* time</a>
|
|
6219
6504
|
* </p>
|
|
6220
6505
|
* </dd>
|
|
6221
6506
|
* <dt>SUM_HOLD_TIME</dt>
|
|
6222
6507
|
* <dd>
|
|
6223
6508
|
* <p>Unit: Count</p>
|
|
6224
6509
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
6225
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6510
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#customer-hold-time">Customer hold
|
|
6511
|
+
* time</a>
|
|
6226
6512
|
* </p>
|
|
6227
6513
|
* </dd>
|
|
6228
6514
|
* <dt>SUM_IDLE_TIME_AGENT</dt>
|
|
6229
6515
|
* <dd>
|
|
6230
6516
|
* <p>Unit: Seconds</p>
|
|
6231
6517
|
* <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p>
|
|
6232
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6518
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-idle-time">Agent idle
|
|
6519
|
+
* time</a>
|
|
6233
6520
|
* </p>
|
|
6234
6521
|
* </dd>
|
|
6235
6522
|
* <dt>SUM_INTERACTION_AND_HOLD_TIME</dt>
|
|
6236
6523
|
* <dd>
|
|
6237
6524
|
* <p>Unit: Seconds</p>
|
|
6238
6525
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</p>
|
|
6239
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6526
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-and-hold-time">Agent interaction and hold time</a>
|
|
6240
6527
|
* </p>
|
|
6241
6528
|
* </dd>
|
|
6242
6529
|
* <dt>SUM_INTERACTION_TIME</dt>
|
|
6243
6530
|
* <dd>
|
|
6244
6531
|
* <p>Unit: Seconds</p>
|
|
6245
6532
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
|
|
6246
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6533
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-interaction-time">Agent
|
|
6534
|
+
* interaction time</a>
|
|
6247
6535
|
* </p>
|
|
6248
6536
|
* </dd>
|
|
6249
6537
|
* <dt>SUM_NON_PRODUCTIVE_TIME_AGENT</dt>
|
|
6250
6538
|
* <dd>
|
|
6251
6539
|
* <p>Unit: Seconds</p>
|
|
6252
6540
|
* <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p>
|
|
6253
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6541
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-productive-time">Agent
|
|
6542
|
+
* non-productive time</a>
|
|
6254
6543
|
* </p>
|
|
6255
6544
|
* </dd>
|
|
6256
6545
|
* <dt>SUM_ONLINE_TIME_AGENT</dt>
|
|
6257
6546
|
* <dd>
|
|
6258
6547
|
* <p>Unit: Seconds</p>
|
|
6259
6548
|
* <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</p>
|
|
6260
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6549
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#online-time">Online time</a>
|
|
6261
6550
|
* </p>
|
|
6262
6551
|
* </dd>
|
|
6263
6552
|
* <dt>SUM_RETRY_CALLBACK_ATTEMPTS</dt>
|
|
@@ -6265,7 +6554,8 @@ export interface GetMetricDataV2Request {
|
|
|
6265
6554
|
* <p>Unit: Count</p>
|
|
6266
6555
|
* <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
|
|
6267
6556
|
* Q in Connect</p>
|
|
6268
|
-
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/
|
|
6557
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-attempts">Callback
|
|
6558
|
+
* attempts</a>
|
|
6269
6559
|
* </p>
|
|
6270
6560
|
* </dd>
|
|
6271
6561
|
* </dl>
|
|
@@ -8549,230 +8839,6 @@ export interface ListPhoneNumbersV2Request {
|
|
|
8549
8839
|
*/
|
|
8550
8840
|
PhoneNumberPrefix?: string | undefined;
|
|
8551
8841
|
}
|
|
8552
|
-
/**
|
|
8553
|
-
* <p>Information about phone numbers that have been claimed to your Amazon Connect instance
|
|
8554
|
-
* or traffic distribution group.</p>
|
|
8555
|
-
* @public
|
|
8556
|
-
*/
|
|
8557
|
-
export interface ListPhoneNumbersSummary {
|
|
8558
|
-
/**
|
|
8559
|
-
* <p>A unique identifier for the phone number.</p>
|
|
8560
|
-
* @public
|
|
8561
|
-
*/
|
|
8562
|
-
PhoneNumberId?: string | undefined;
|
|
8563
|
-
/**
|
|
8564
|
-
* <p>The Amazon Resource Name (ARN) of the phone number.</p>
|
|
8565
|
-
* @public
|
|
8566
|
-
*/
|
|
8567
|
-
PhoneNumberArn?: string | undefined;
|
|
8568
|
-
/**
|
|
8569
|
-
* <p>The phone number. Phone numbers are formatted <code>[+] [country code] [subscriber number including area code]</code>.</p>
|
|
8570
|
-
* @public
|
|
8571
|
-
*/
|
|
8572
|
-
PhoneNumber?: string | undefined;
|
|
8573
|
-
/**
|
|
8574
|
-
* <p>The ISO country code.</p>
|
|
8575
|
-
* @public
|
|
8576
|
-
*/
|
|
8577
|
-
PhoneNumberCountryCode?: PhoneNumberCountryCode | undefined;
|
|
8578
|
-
/**
|
|
8579
|
-
* <p>The type of phone number.</p>
|
|
8580
|
-
* @public
|
|
8581
|
-
*/
|
|
8582
|
-
PhoneNumberType?: PhoneNumberType | undefined;
|
|
8583
|
-
/**
|
|
8584
|
-
* <p>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through.</p>
|
|
8585
|
-
* @public
|
|
8586
|
-
*/
|
|
8587
|
-
TargetArn?: string | undefined;
|
|
8588
|
-
/**
|
|
8589
|
-
* <p>The identifier of the Amazon Connect instance that phone numbers are claimed to. You
|
|
8590
|
-
* can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the
|
|
8591
|
-
* instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
|
|
8592
|
-
* @public
|
|
8593
|
-
*/
|
|
8594
|
-
InstanceId?: string | undefined;
|
|
8595
|
-
/**
|
|
8596
|
-
* <p>The description of the phone number.</p>
|
|
8597
|
-
* @public
|
|
8598
|
-
*/
|
|
8599
|
-
PhoneNumberDescription?: string | undefined;
|
|
8600
|
-
/**
|
|
8601
|
-
* <p>The claimed phone number ARN that was previously imported from the external service, such as
|
|
8602
|
-
* Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it
|
|
8603
|
-
* looks like the ARN of the phone number that was imported from Amazon Web Services End User
|
|
8604
|
-
* Messaging.</p>
|
|
8605
|
-
* @public
|
|
8606
|
-
*/
|
|
8607
|
-
SourcePhoneNumberArn?: string | undefined;
|
|
8608
|
-
}
|
|
8609
|
-
/**
|
|
8610
|
-
* @public
|
|
8611
|
-
*/
|
|
8612
|
-
export interface ListPhoneNumbersV2Response {
|
|
8613
|
-
/**
|
|
8614
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8615
|
-
* @public
|
|
8616
|
-
*/
|
|
8617
|
-
NextToken?: string | undefined;
|
|
8618
|
-
/**
|
|
8619
|
-
* <p>Information about phone numbers that have been claimed to your Amazon Connect instances
|
|
8620
|
-
* or traffic distribution groups.</p>
|
|
8621
|
-
* @public
|
|
8622
|
-
*/
|
|
8623
|
-
ListPhoneNumbersSummaryList?: ListPhoneNumbersSummary[] | undefined;
|
|
8624
|
-
}
|
|
8625
|
-
/**
|
|
8626
|
-
* @public
|
|
8627
|
-
*/
|
|
8628
|
-
export interface ListPredefinedAttributesRequest {
|
|
8629
|
-
/**
|
|
8630
|
-
* <p>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
8631
|
-
* Name (ARN) of the instance.</p>
|
|
8632
|
-
* @public
|
|
8633
|
-
*/
|
|
8634
|
-
InstanceId: string | undefined;
|
|
8635
|
-
/**
|
|
8636
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
8637
|
-
* the next request to retrieve the next set of results.</p>
|
|
8638
|
-
* @public
|
|
8639
|
-
*/
|
|
8640
|
-
NextToken?: string | undefined;
|
|
8641
|
-
/**
|
|
8642
|
-
* <p>The maximum number of results to return per page. </p>
|
|
8643
|
-
* @public
|
|
8644
|
-
*/
|
|
8645
|
-
MaxResults?: number | undefined;
|
|
8646
|
-
}
|
|
8647
|
-
/**
|
|
8648
|
-
* <p>Summary of a predefined attribute.</p>
|
|
8649
|
-
* @public
|
|
8650
|
-
*/
|
|
8651
|
-
export interface PredefinedAttributeSummary {
|
|
8652
|
-
/**
|
|
8653
|
-
* <p>The name of the predefined attribute.</p>
|
|
8654
|
-
* @public
|
|
8655
|
-
*/
|
|
8656
|
-
Name?: string | undefined;
|
|
8657
|
-
/**
|
|
8658
|
-
* <p>Last modified time.</p>
|
|
8659
|
-
* @public
|
|
8660
|
-
*/
|
|
8661
|
-
LastModifiedTime?: Date | undefined;
|
|
8662
|
-
/**
|
|
8663
|
-
* <p>Last modified region.</p>
|
|
8664
|
-
* @public
|
|
8665
|
-
*/
|
|
8666
|
-
LastModifiedRegion?: string | undefined;
|
|
8667
|
-
}
|
|
8668
|
-
/**
|
|
8669
|
-
* @public
|
|
8670
|
-
*/
|
|
8671
|
-
export interface ListPredefinedAttributesResponse {
|
|
8672
|
-
/**
|
|
8673
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8674
|
-
* @public
|
|
8675
|
-
*/
|
|
8676
|
-
NextToken?: string | undefined;
|
|
8677
|
-
/**
|
|
8678
|
-
* <p>Summary of the predefined attributes.</p>
|
|
8679
|
-
* @public
|
|
8680
|
-
*/
|
|
8681
|
-
PredefinedAttributeSummaryList?: PredefinedAttributeSummary[] | undefined;
|
|
8682
|
-
}
|
|
8683
|
-
/**
|
|
8684
|
-
* @public
|
|
8685
|
-
*/
|
|
8686
|
-
export interface ListPromptsRequest {
|
|
8687
|
-
/**
|
|
8688
|
-
* <p>The identifier of the Amazon Connect instance.</p>
|
|
8689
|
-
* @public
|
|
8690
|
-
*/
|
|
8691
|
-
InstanceId: string | undefined;
|
|
8692
|
-
/**
|
|
8693
|
-
* <p>The token for the next set of results. Use the value returned in the previous response in
|
|
8694
|
-
* the next request to retrieve the next set of results.</p>
|
|
8695
|
-
* @public
|
|
8696
|
-
*/
|
|
8697
|
-
NextToken?: string | undefined;
|
|
8698
|
-
/**
|
|
8699
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8700
|
-
* @public
|
|
8701
|
-
*/
|
|
8702
|
-
MaxResults?: number | undefined;
|
|
8703
|
-
}
|
|
8704
|
-
/**
|
|
8705
|
-
* <p>Contains information about the prompt.</p>
|
|
8706
|
-
* @public
|
|
8707
|
-
*/
|
|
8708
|
-
export interface PromptSummary {
|
|
8709
|
-
/**
|
|
8710
|
-
* <p>The identifier of the prompt.</p>
|
|
8711
|
-
* @public
|
|
8712
|
-
*/
|
|
8713
|
-
Id?: string | undefined;
|
|
8714
|
-
/**
|
|
8715
|
-
* <p>The Amazon Resource Name (ARN) of the prompt.</p>
|
|
8716
|
-
* @public
|
|
8717
|
-
*/
|
|
8718
|
-
Arn?: string | undefined;
|
|
8719
|
-
/**
|
|
8720
|
-
* <p>The name of the prompt.</p>
|
|
8721
|
-
* @public
|
|
8722
|
-
*/
|
|
8723
|
-
Name?: string | undefined;
|
|
8724
|
-
/**
|
|
8725
|
-
* <p>The timestamp when this resource was last modified.</p>
|
|
8726
|
-
* @public
|
|
8727
|
-
*/
|
|
8728
|
-
LastModifiedTime?: Date | undefined;
|
|
8729
|
-
/**
|
|
8730
|
-
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
8731
|
-
* @public
|
|
8732
|
-
*/
|
|
8733
|
-
LastModifiedRegion?: string | undefined;
|
|
8734
|
-
}
|
|
8735
|
-
/**
|
|
8736
|
-
* @public
|
|
8737
|
-
*/
|
|
8738
|
-
export interface ListPromptsResponse {
|
|
8739
|
-
/**
|
|
8740
|
-
* <p>Information about the prompts.</p>
|
|
8741
|
-
* @public
|
|
8742
|
-
*/
|
|
8743
|
-
PromptSummaryList?: PromptSummary[] | undefined;
|
|
8744
|
-
/**
|
|
8745
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8746
|
-
* @public
|
|
8747
|
-
*/
|
|
8748
|
-
NextToken?: string | undefined;
|
|
8749
|
-
}
|
|
8750
|
-
/**
|
|
8751
|
-
* @public
|
|
8752
|
-
*/
|
|
8753
|
-
export interface ListQueueQuickConnectsRequest {
|
|
8754
|
-
/**
|
|
8755
|
-
* <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>
|
|
8756
|
-
* @public
|
|
8757
|
-
*/
|
|
8758
|
-
InstanceId: string | undefined;
|
|
8759
|
-
/**
|
|
8760
|
-
* <p>The identifier for the queue.</p>
|
|
8761
|
-
* @public
|
|
8762
|
-
*/
|
|
8763
|
-
QueueId: string | undefined;
|
|
8764
|
-
/**
|
|
8765
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8766
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8767
|
-
* @public
|
|
8768
|
-
*/
|
|
8769
|
-
NextToken?: string | undefined;
|
|
8770
|
-
/**
|
|
8771
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8772
|
-
* @public
|
|
8773
|
-
*/
|
|
8774
|
-
MaxResults?: number | undefined;
|
|
8775
|
-
}
|
|
8776
8842
|
/**
|
|
8777
8843
|
* @internal
|
|
8778
8844
|
*/
|