@aws-sdk/client-connect 3.862.0 → 3.864.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist-cjs/index.js +116 -32
- package/dist-es/Connect.js +2 -0
- package/dist-es/commands/GetContactMetricsCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +4 -0
- package/dist-es/models/models_1.js +11 -0
- package/dist-es/models/models_2.js +0 -29
- package/dist-es/models/models_3.js +25 -0
- package/dist-es/protocols/Aws_restJson1.js +52 -0
- package/dist-types/Connect.d.ts +7 -0
- package/dist-types/ConnectClient.d.ts +3 -2
- package/dist-types/commands/AssociateQueueQuickConnectsCommand.d.ts +1 -2
- package/dist-types/commands/CreateAgentStatusCommand.d.ts +1 -2
- package/dist-types/commands/CreateHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/CreateHoursOfOperationOverrideCommand.d.ts +1 -1
- package/dist-types/commands/CreateUserCommand.d.ts +3 -3
- package/dist-types/commands/CreateViewCommand.d.ts +4 -1
- package/dist-types/commands/CreateViewVersionCommand.d.ts +4 -1
- package/dist-types/commands/DeleteHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/DeleteHoursOfOperationOverrideCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/commands/DeletePredefinedAttributeCommand.d.ts +5 -2
- package/dist-types/commands/DeleteQueueCommand.d.ts +4 -1
- package/dist-types/commands/DeleteRoutingProfileCommand.d.ts +4 -1
- package/dist-types/commands/DeleteSecurityProfileCommand.d.ts +4 -1
- package/dist-types/commands/DeleteTrafficDistributionGroupCommand.d.ts +4 -1
- package/dist-types/commands/DeleteUserHierarchyGroupCommand.d.ts +4 -1
- package/dist-types/commands/DeleteViewCommand.d.ts +4 -1
- package/dist-types/commands/DeleteViewVersionCommand.d.ts +4 -1
- package/dist-types/commands/DeleteVocabularyCommand.d.ts +4 -1
- package/dist-types/commands/DescribeAgentStatusCommand.d.ts +1 -2
- package/dist-types/commands/DescribeHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/DescribeQueueCommand.d.ts +1 -2
- package/dist-types/commands/DisassociateQueueQuickConnectsCommand.d.ts +1 -2
- package/dist-types/commands/GetContactMetricsCommand.d.ts +117 -0
- package/dist-types/commands/GetCurrentMetricDataCommand.d.ts +37 -0
- package/dist-types/commands/GetMetricDataV2Command.d.ts +37 -0
- package/dist-types/commands/ListAgentStatusesCommand.d.ts +1 -2
- package/dist-types/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListLambdaFunctionsCommand.d.ts +1 -1
- package/dist-types/commands/ListLexBotsCommand.d.ts +1 -1
- package/dist-types/commands/ListPhoneNumbersCommand.d.ts +1 -2
- package/dist-types/commands/ListQueueQuickConnectsCommand.d.ts +1 -2
- package/dist-types/commands/ReleasePhoneNumberCommand.d.ts +4 -1
- package/dist-types/commands/SearchAgentStatusesCommand.d.ts +8 -0
- package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +13 -0
- package/dist-types/commands/UpdateAgentStatusCommand.d.ts +1 -2
- package/dist-types/commands/UpdateHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +4 -1
- package/dist-types/commands/UpdatePhoneNumberMetadataCommand.d.ts +4 -1
- package/dist-types/commands/UpdateQueueHoursOfOperationCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueMaxContactsCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueNameCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueOutboundCallerConfigCommand.d.ts +1 -2
- package/dist-types/commands/UpdateQueueStatusCommand.d.ts +1 -2
- package/dist-types/commands/UpdateUserHierarchyStructureCommand.d.ts +4 -1
- package/dist-types/commands/UpdateViewContentCommand.d.ts +4 -1
- package/dist-types/commands/UpdateViewMetadataCommand.d.ts +4 -1
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +39 -38
- package/dist-types/models/models_1.d.ts +631 -310
- package/dist-types/models/models_2.d.ts +206 -171
- package/dist-types/models/models_3.d.ts +149 -7
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/Connect.d.ts +17 -0
- package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/DeleteIntegrationAssociationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/DeletePredefinedAttributeCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetContactMetricsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListIntegrationAssociationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListLambdaFunctionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListLexBotsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListPhoneNumbersCommand.d.ts +4 -2
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +11 -8
- package/dist-types/ts3.4/models/models_1.d.ts +48 -50
- package/dist-types/ts3.4/models/models_2.d.ts +52 -77
- package/dist-types/ts3.4/models/models_3.d.ts +70 -2
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +5 -5
|
@@ -1,6 +1,37 @@
|
|
|
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,
|
|
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, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PredefinedAttributeValues, QueueReference, QuickConnectConfig, ReferenceStatus, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, StorageType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export interface DeleteIntegrationAssociationRequest {
|
|
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>The identifier for the integration association.</p>
|
|
15
|
+
* @public
|
|
16
|
+
*/
|
|
17
|
+
IntegrationAssociationId: string | undefined;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @public
|
|
21
|
+
*/
|
|
22
|
+
export interface DeletePredefinedAttributeRequest {
|
|
23
|
+
/**
|
|
24
|
+
* <p> The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource
|
|
25
|
+
* Name (ARN) of the instance.</p>
|
|
26
|
+
* @public
|
|
27
|
+
*/
|
|
28
|
+
InstanceId: string | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* <p> The name of the predefined attribute.</p>
|
|
31
|
+
* @public
|
|
32
|
+
*/
|
|
33
|
+
Name: string | undefined;
|
|
34
|
+
}
|
|
4
35
|
/**
|
|
5
36
|
* @public
|
|
6
37
|
*/
|
|
@@ -487,12 +518,14 @@ export interface ParticipantMetrics {
|
|
|
487
518
|
*/
|
|
488
519
|
ParticipantId?: string | undefined;
|
|
489
520
|
/**
|
|
490
|
-
* <p>Information about the conversation participant. Following are the participant types: [Agent,
|
|
521
|
+
* <p>Information about the conversation participant. Following are the participant types: [Agent,
|
|
522
|
+
* Customer, Supervisor].</p>
|
|
491
523
|
* @public
|
|
492
524
|
*/
|
|
493
525
|
ParticipantType?: ParticipantType | undefined;
|
|
494
526
|
/**
|
|
495
|
-
* <p>A boolean flag indicating whether the chat conversation was abandoned by a
|
|
527
|
+
* <p>A boolean flag indicating whether the chat conversation was abandoned by a
|
|
528
|
+
* Participant.</p>
|
|
496
529
|
* @public
|
|
497
530
|
*/
|
|
498
531
|
ConversationAbandon?: boolean | undefined;
|
|
@@ -533,7 +566,8 @@ export interface ParticipantMetrics {
|
|
|
533
566
|
*/
|
|
534
567
|
export interface ChatContactMetrics {
|
|
535
568
|
/**
|
|
536
|
-
* <p>A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this
|
|
569
|
+
* <p>A boolean flag indicating whether multiparty chat or supervisor barge were enabled on this
|
|
570
|
+
* contact.</p>
|
|
537
571
|
* @public
|
|
538
572
|
*/
|
|
539
573
|
MultiParty?: boolean | undefined;
|
|
@@ -558,7 +592,8 @@ export interface ChatContactMetrics {
|
|
|
558
592
|
*/
|
|
559
593
|
ConversationCloseTimeInMillis?: number | undefined;
|
|
560
594
|
/**
|
|
561
|
-
* <p>The number of conversation turns in a chat contact, which represents the back-and-forth
|
|
595
|
+
* <p>The number of conversation turns in a chat contact, which represents the back-and-forth
|
|
596
|
+
* exchanges between customer and other participants.</p>
|
|
562
597
|
* @public
|
|
563
598
|
*/
|
|
564
599
|
ConversationTurnCount?: number | undefined;
|
|
@@ -4010,6 +4045,115 @@ export interface GetContactAttributesResponse {
|
|
|
4010
4045
|
*/
|
|
4011
4046
|
Attributes?: Record<string, string> | undefined;
|
|
4012
4047
|
}
|
|
4048
|
+
/**
|
|
4049
|
+
* @public
|
|
4050
|
+
* @enum
|
|
4051
|
+
*/
|
|
4052
|
+
export declare const ContactMetricName: {
|
|
4053
|
+
readonly POSITION_IN_QUEUE: "POSITION_IN_QUEUE";
|
|
4054
|
+
};
|
|
4055
|
+
/**
|
|
4056
|
+
* @public
|
|
4057
|
+
*/
|
|
4058
|
+
export type ContactMetricName = (typeof ContactMetricName)[keyof typeof ContactMetricName];
|
|
4059
|
+
/**
|
|
4060
|
+
* <p>The object that contains information about metric being requested.</p>
|
|
4061
|
+
* @public
|
|
4062
|
+
*/
|
|
4063
|
+
export interface ContactMetricInfo {
|
|
4064
|
+
/**
|
|
4065
|
+
* <p>The name of the metric being retrieved in type String.</p>
|
|
4066
|
+
* @public
|
|
4067
|
+
*/
|
|
4068
|
+
Name: ContactMetricName | undefined;
|
|
4069
|
+
}
|
|
4070
|
+
/**
|
|
4071
|
+
* @public
|
|
4072
|
+
*/
|
|
4073
|
+
export interface GetContactMetricsRequest {
|
|
4074
|
+
/**
|
|
4075
|
+
* <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>
|
|
4076
|
+
* @public
|
|
4077
|
+
*/
|
|
4078
|
+
InstanceId: string | undefined;
|
|
4079
|
+
/**
|
|
4080
|
+
* <p>The identifier of the contact in this instance of Amazon Connect. </p>
|
|
4081
|
+
* @public
|
|
4082
|
+
*/
|
|
4083
|
+
ContactId: string | undefined;
|
|
4084
|
+
/**
|
|
4085
|
+
* <p>A list of contact-level metrics to retrieve.</p>
|
|
4086
|
+
* @public
|
|
4087
|
+
*/
|
|
4088
|
+
Metrics: ContactMetricInfo[] | undefined;
|
|
4089
|
+
}
|
|
4090
|
+
/**
|
|
4091
|
+
* <p>Object which contains the number.</p>
|
|
4092
|
+
* @public
|
|
4093
|
+
*/
|
|
4094
|
+
export type ContactMetricValue = ContactMetricValue.NumberMember | ContactMetricValue.$UnknownMember;
|
|
4095
|
+
/**
|
|
4096
|
+
* @public
|
|
4097
|
+
*/
|
|
4098
|
+
export declare namespace ContactMetricValue {
|
|
4099
|
+
/**
|
|
4100
|
+
* <p>The number of type Double. This number is the contact's position in queue.</p>
|
|
4101
|
+
* @public
|
|
4102
|
+
*/
|
|
4103
|
+
interface NumberMember {
|
|
4104
|
+
Number: number;
|
|
4105
|
+
$unknown?: never;
|
|
4106
|
+
}
|
|
4107
|
+
/**
|
|
4108
|
+
* @public
|
|
4109
|
+
*/
|
|
4110
|
+
interface $UnknownMember {
|
|
4111
|
+
Number?: never;
|
|
4112
|
+
$unknown: [string, any];
|
|
4113
|
+
}
|
|
4114
|
+
interface Visitor<T> {
|
|
4115
|
+
Number: (value: number) => T;
|
|
4116
|
+
_: (name: string, value: any) => T;
|
|
4117
|
+
}
|
|
4118
|
+
const visit: <T>(value: ContactMetricValue, visitor: Visitor<T>) => T;
|
|
4119
|
+
}
|
|
4120
|
+
/**
|
|
4121
|
+
* <p>Object containing information about metric requested for the contact.</p>
|
|
4122
|
+
* @public
|
|
4123
|
+
*/
|
|
4124
|
+
export interface ContactMetricResult {
|
|
4125
|
+
/**
|
|
4126
|
+
* <p>The name of the metric being retrieved in type String.</p>
|
|
4127
|
+
* @public
|
|
4128
|
+
*/
|
|
4129
|
+
Name: ContactMetricName | undefined;
|
|
4130
|
+
/**
|
|
4131
|
+
* <p>Object result associated with the metric received.</p>
|
|
4132
|
+
* @public
|
|
4133
|
+
*/
|
|
4134
|
+
Value: ContactMetricValue | undefined;
|
|
4135
|
+
}
|
|
4136
|
+
/**
|
|
4137
|
+
* @public
|
|
4138
|
+
*/
|
|
4139
|
+
export interface GetContactMetricsResponse {
|
|
4140
|
+
/**
|
|
4141
|
+
* <p>A list of metric results containing the calculated values for each requested metric. Each
|
|
4142
|
+
* result includes the metric name and its corresponding calculated value.</p>
|
|
4143
|
+
* @public
|
|
4144
|
+
*/
|
|
4145
|
+
MetricResults?: ContactMetricResult[] | undefined;
|
|
4146
|
+
/**
|
|
4147
|
+
* <p>The unique identifier of the contact for which metrics were retrieved.</p>
|
|
4148
|
+
* @public
|
|
4149
|
+
*/
|
|
4150
|
+
Id?: string | undefined;
|
|
4151
|
+
/**
|
|
4152
|
+
* <p>The ARN of the contact for which metrics were retrieved.</p>
|
|
4153
|
+
* @public
|
|
4154
|
+
*/
|
|
4155
|
+
Arn?: string | undefined;
|
|
4156
|
+
}
|
|
4013
4157
|
/**
|
|
4014
4158
|
* @public
|
|
4015
4159
|
* @enum
|
|
@@ -4677,12 +4821,12 @@ export interface GetEffectiveHoursOfOperationsRequest {
|
|
|
4677
4821
|
*/
|
|
4678
4822
|
HoursOfOperationId: string | undefined;
|
|
4679
4823
|
/**
|
|
4680
|
-
* <p>The
|
|
4824
|
+
* <p>The date from when the hours of operation are listed.</p>
|
|
4681
4825
|
* @public
|
|
4682
4826
|
*/
|
|
4683
4827
|
FromDate: string | undefined;
|
|
4684
4828
|
/**
|
|
4685
|
-
* <p>The
|
|
4829
|
+
* <p>The date until when the hours of operation are listed.</p>
|
|
4686
4830
|
* @public
|
|
4687
4831
|
*/
|
|
4688
4832
|
ToDate: string | undefined;
|
|
@@ -4724,7 +4868,7 @@ export interface EffectiveHoursOfOperations {
|
|
|
4724
4868
|
*/
|
|
4725
4869
|
export interface GetEffectiveHoursOfOperationsResponse {
|
|
4726
4870
|
/**
|
|
4727
|
-
* <p>Information about the effective hours of operations
|
|
4871
|
+
* <p>Information about the effective hours of operations.</p>
|
|
4728
4872
|
* @public
|
|
4729
4873
|
*/
|
|
4730
4874
|
EffectiveHoursOfOperationList?: EffectiveHoursOfOperations[] | undefined;
|
|
@@ -4936,209 +5080,199 @@ export interface Threshold {
|
|
|
4936
5080
|
ThresholdValue?: number | undefined;
|
|
4937
5081
|
}
|
|
4938
5082
|
/**
|
|
4939
|
-
* <p>Contains information about a historical metric.
|
|
4940
|
-
* definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
5083
|
+
* <p>Contains information about a historical metric. </p>
|
|
4941
5084
|
* @public
|
|
4942
5085
|
*/
|
|
4943
5086
|
export interface HistoricalMetric {
|
|
4944
5087
|
/**
|
|
4945
|
-
* <p>The name of the metric
|
|
4946
|
-
*
|
|
4947
|
-
|
|
4948
|
-
Name?: HistoricalMetricName | undefined;
|
|
4949
|
-
/**
|
|
4950
|
-
* <p>The threshold for the metric, used with service level metrics.</p>
|
|
4951
|
-
* @public
|
|
4952
|
-
*/
|
|
4953
|
-
Threshold?: Threshold | undefined;
|
|
4954
|
-
/**
|
|
4955
|
-
* <p>The statistic for the metric.</p>
|
|
4956
|
-
* @public
|
|
4957
|
-
*/
|
|
4958
|
-
Statistic?: Statistic | undefined;
|
|
4959
|
-
/**
|
|
4960
|
-
* <p>The unit for the metric.</p>
|
|
4961
|
-
* @public
|
|
4962
|
-
*/
|
|
4963
|
-
Unit?: Unit | undefined;
|
|
4964
|
-
}
|
|
4965
|
-
/**
|
|
4966
|
-
* @public
|
|
4967
|
-
*/
|
|
4968
|
-
export interface GetMetricDataRequest {
|
|
4969
|
-
/**
|
|
4970
|
-
* <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>
|
|
4971
|
-
* @public
|
|
4972
|
-
*/
|
|
4973
|
-
InstanceId: string | undefined;
|
|
4974
|
-
/**
|
|
4975
|
-
* <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
|
|
4976
|
-
* retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes,
|
|
4977
|
-
* such as 10:05, 10:10, 10:15.</p>
|
|
4978
|
-
* <p>The start time cannot be earlier than 24 hours before the time of the request. Historical
|
|
4979
|
-
* metrics are available only for 24 hours.</p>
|
|
4980
|
-
* @public
|
|
4981
|
-
*/
|
|
4982
|
-
StartTime: Date | undefined;
|
|
4983
|
-
/**
|
|
4984
|
-
* <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the
|
|
4985
|
-
* retrieval of historical metrics data. The time must be specified using an interval of 5 minutes,
|
|
4986
|
-
* such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
|
|
4987
|
-
* <p>The time range between the start and end time must be less than 24 hours.</p>
|
|
4988
|
-
* @public
|
|
4989
|
-
*/
|
|
4990
|
-
EndTime: Date | undefined;
|
|
4991
|
-
/**
|
|
4992
|
-
* <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is
|
|
4993
|
-
* retrieved only for the resources associated with the queues or channels included in the filter.
|
|
4994
|
-
* You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
|
|
4995
|
-
* <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
|
|
4996
|
-
* GetMetricDataV2 for more up-to-date features.</p>
|
|
4997
|
-
* <note>
|
|
4998
|
-
* <p>To filter by <code>Queues</code>, enter the queue
|
|
4999
|
-
* ID/ARN, not the name of the queue.</p>
|
|
5000
|
-
* </note>
|
|
5001
|
-
* @public
|
|
5002
|
-
*/
|
|
5003
|
-
Filters: Filters | undefined;
|
|
5004
|
-
/**
|
|
5005
|
-
* <p>The grouping applied to the metrics returned. For example, when results are grouped by
|
|
5006
|
-
* queue, the metrics returned are grouped by queue. The values returned apply to the metrics for
|
|
5007
|
-
* each queue rather than aggregated for all queues.</p>
|
|
5008
|
-
* <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
|
|
5009
|
-
* <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
|
|
5010
|
-
* GetMetricDataV2 for more up-to-date features.</p>
|
|
5011
|
-
* @public
|
|
5012
|
-
*/
|
|
5013
|
-
Groupings?: Grouping[] | undefined;
|
|
5014
|
-
/**
|
|
5015
|
-
* <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The
|
|
5016
|
-
* 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
|
|
5017
|
-
* definition</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
5018
|
-
* <note>
|
|
5019
|
-
* <p>This API does not support a contacts
|
|
5020
|
-
* incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list). </p>
|
|
5021
|
-
* </note>
|
|
5088
|
+
* <p>The name of the metric. Following is a list of each supported metric mapped to the UI name,
|
|
5089
|
+
* linked to a detailed description in the <i>Amazon Connect Administrator
|
|
5090
|
+
* Guide</i>. </p>
|
|
5022
5091
|
* <dl>
|
|
5023
5092
|
* <dt>ABANDON_TIME</dt>
|
|
5024
5093
|
* <dd>
|
|
5025
5094
|
* <p>Unit: SECONDS</p>
|
|
5026
5095
|
* <p>Statistic: AVG</p>
|
|
5096
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average
|
|
5097
|
+
* queue abandon time</a>
|
|
5098
|
+
* </p>
|
|
5027
5099
|
* </dd>
|
|
5028
5100
|
* <dt>AFTER_CONTACT_WORK_TIME</dt>
|
|
5029
5101
|
* <dd>
|
|
5030
5102
|
* <p>Unit: SECONDS</p>
|
|
5031
5103
|
* <p>Statistic: AVG</p>
|
|
5104
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After
|
|
5105
|
+
* contact work time</a>
|
|
5106
|
+
* </p>
|
|
5032
5107
|
* </dd>
|
|
5033
5108
|
* <dt>API_CONTACTS_HANDLED</dt>
|
|
5034
5109
|
* <dd>
|
|
5035
5110
|
* <p>Unit: COUNT</p>
|
|
5036
5111
|
* <p>Statistic: SUM</p>
|
|
5112
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts
|
|
5113
|
+
* handled</a>
|
|
5114
|
+
* </p>
|
|
5115
|
+
* </dd>
|
|
5116
|
+
* <dt>AVG_HOLD_TIME</dt>
|
|
5117
|
+
* <dd>
|
|
5118
|
+
* <p>Unit: SECONDS</p>
|
|
5119
|
+
* <p>Statistic: AVG</p>
|
|
5120
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average
|
|
5121
|
+
* customer hold time</a>
|
|
5122
|
+
* </p>
|
|
5037
5123
|
* </dd>
|
|
5038
5124
|
* <dt>CALLBACK_CONTACTS_HANDLED</dt>
|
|
5039
5125
|
* <dd>
|
|
5040
5126
|
* <p>Unit: COUNT</p>
|
|
5041
5127
|
* <p>Statistic: SUM</p>
|
|
5128
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled">Callback
|
|
5129
|
+
* contacts handled</a>
|
|
5130
|
+
* </p>
|
|
5042
5131
|
* </dd>
|
|
5043
5132
|
* <dt>CONTACTS_ABANDONED</dt>
|
|
5044
5133
|
* <dd>
|
|
5045
5134
|
* <p>Unit: COUNT</p>
|
|
5046
5135
|
* <p>Statistic: SUM</p>
|
|
5136
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contacts
|
|
5137
|
+
* abandoned</a>
|
|
5138
|
+
* </p>
|
|
5047
5139
|
* </dd>
|
|
5048
5140
|
* <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt>
|
|
5049
5141
|
* <dd>
|
|
5050
5142
|
* <p>Unit: COUNT</p>
|
|
5051
5143
|
* <p>Statistic: SUM</p>
|
|
5144
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first">Contacts agent hung up first</a>
|
|
5145
|
+
* </p>
|
|
5052
5146
|
* </dd>
|
|
5053
5147
|
* <dt>CONTACTS_CONSULTED</dt>
|
|
5054
5148
|
* <dd>
|
|
5055
5149
|
* <p>Unit: COUNT</p>
|
|
5056
5150
|
* <p>Statistic: SUM</p>
|
|
5151
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted">Contacts
|
|
5152
|
+
* consulted</a>
|
|
5153
|
+
* </p>
|
|
5057
5154
|
* </dd>
|
|
5058
5155
|
* <dt>CONTACTS_HANDLED</dt>
|
|
5059
5156
|
* <dd>
|
|
5060
5157
|
* <p>Unit: COUNT</p>
|
|
5061
5158
|
* <p>Statistic: SUM</p>
|
|
5159
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled">Contacts
|
|
5160
|
+
* handled</a>
|
|
5161
|
+
* </p>
|
|
5062
5162
|
* </dd>
|
|
5063
5163
|
* <dt>CONTACTS_HANDLED_INCOMING</dt>
|
|
5064
5164
|
* <dd>
|
|
5065
5165
|
* <p>Unit: COUNT</p>
|
|
5066
5166
|
* <p>Statistic: SUM</p>
|
|
5167
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming">Contacts
|
|
5168
|
+
* handled incoming</a>
|
|
5169
|
+
* </p>
|
|
5067
5170
|
* </dd>
|
|
5068
5171
|
* <dt>CONTACTS_HANDLED_OUTBOUND</dt>
|
|
5069
5172
|
* <dd>
|
|
5070
5173
|
* <p>Unit: COUNT</p>
|
|
5071
5174
|
* <p>Statistic: SUM</p>
|
|
5175
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound">Contacts
|
|
5176
|
+
* handled outbound</a>
|
|
5177
|
+
* </p>
|
|
5072
5178
|
* </dd>
|
|
5073
5179
|
* <dt>CONTACTS_HOLD_ABANDONS</dt>
|
|
5074
5180
|
* <dd>
|
|
5075
5181
|
* <p>Unit: COUNT</p>
|
|
5076
5182
|
* <p>Statistic: SUM</p>
|
|
5183
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts
|
|
5184
|
+
* hold disconnect</a>
|
|
5185
|
+
* </p>
|
|
5077
5186
|
* </dd>
|
|
5078
5187
|
* <dt>CONTACTS_MISSED</dt>
|
|
5079
5188
|
* <dd>
|
|
5080
5189
|
* <p>Unit: COUNT</p>
|
|
5081
5190
|
* <p>Statistic: SUM</p>
|
|
5191
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">AGENT_NON_RESPONSE</a>
|
|
5192
|
+
* </p>
|
|
5082
5193
|
* </dd>
|
|
5083
5194
|
* <dt>CONTACTS_QUEUED</dt>
|
|
5084
5195
|
* <dd>
|
|
5085
5196
|
* <p>Unit: COUNT</p>
|
|
5086
5197
|
* <p>Statistic: SUM</p>
|
|
5198
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts
|
|
5199
|
+
* queued</a>
|
|
5200
|
+
* </p>
|
|
5087
5201
|
* </dd>
|
|
5088
5202
|
* <dt>CONTACTS_TRANSFERRED_IN</dt>
|
|
5089
5203
|
* <dd>
|
|
5090
5204
|
* <p>Unit: COUNT</p>
|
|
5091
5205
|
* <p>Statistic: SUM</p>
|
|
5206
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in">Contacts
|
|
5207
|
+
* transferred in</a>
|
|
5208
|
+
* </p>
|
|
5092
5209
|
* </dd>
|
|
5093
5210
|
* <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt>
|
|
5094
5211
|
* <dd>
|
|
5095
5212
|
* <p>Unit: COUNT</p>
|
|
5096
5213
|
* <p>Statistic: SUM</p>
|
|
5214
|
+
* <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>
|
|
5215
|
+
* </p>
|
|
5097
5216
|
* </dd>
|
|
5098
5217
|
* <dt>CONTACTS_TRANSFERRED_OUT</dt>
|
|
5099
5218
|
* <dd>
|
|
5100
5219
|
* <p>Unit: COUNT</p>
|
|
5101
5220
|
* <p>Statistic: SUM</p>
|
|
5221
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts
|
|
5222
|
+
* transferred out</a>
|
|
5223
|
+
* </p>
|
|
5102
5224
|
* </dd>
|
|
5103
5225
|
* <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
|
|
5104
5226
|
* <dd>
|
|
5105
5227
|
* <p>Unit: COUNT</p>
|
|
5106
5228
|
* <p>Statistic: SUM</p>
|
|
5229
|
+
* <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>
|
|
5230
|
+
* </p>
|
|
5107
5231
|
* </dd>
|
|
5108
5232
|
* <dt>HANDLE_TIME</dt>
|
|
5109
5233
|
* <dd>
|
|
5110
5234
|
* <p>Unit: SECONDS</p>
|
|
5111
5235
|
* <p>Statistic: AVG</p>
|
|
5112
|
-
*
|
|
5113
|
-
*
|
|
5114
|
-
*
|
|
5115
|
-
* <p>Unit: SECONDS</p>
|
|
5116
|
-
* <p>Statistic: AVG</p>
|
|
5236
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle
|
|
5237
|
+
* time</a>
|
|
5238
|
+
* </p>
|
|
5117
5239
|
* </dd>
|
|
5118
5240
|
* <dt>INTERACTION_AND_HOLD_TIME</dt>
|
|
5119
5241
|
* <dd>
|
|
5120
5242
|
* <p>Unit: SECONDS</p>
|
|
5121
5243
|
* <p>Statistic: AVG</p>
|
|
5244
|
+
* <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>
|
|
5245
|
+
* </p>
|
|
5122
5246
|
* </dd>
|
|
5123
5247
|
* <dt>INTERACTION_TIME</dt>
|
|
5124
5248
|
* <dd>
|
|
5125
5249
|
* <p>Unit: SECONDS</p>
|
|
5126
5250
|
* <p>Statistic: AVG</p>
|
|
5251
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time">Average agent interaction time</a>
|
|
5252
|
+
* </p>
|
|
5127
5253
|
* </dd>
|
|
5128
5254
|
* <dt>OCCUPANCY</dt>
|
|
5129
5255
|
* <dd>
|
|
5130
5256
|
* <p>Unit: PERCENT</p>
|
|
5131
5257
|
* <p>Statistic: AVG</p>
|
|
5258
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a>
|
|
5259
|
+
* </p>
|
|
5132
5260
|
* </dd>
|
|
5133
5261
|
* <dt>QUEUE_ANSWER_TIME</dt>
|
|
5134
5262
|
* <dd>
|
|
5135
5263
|
* <p>Unit: SECONDS</p>
|
|
5136
5264
|
* <p>Statistic: AVG</p>
|
|
5265
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time">Average
|
|
5266
|
+
* queue answer time</a>
|
|
5267
|
+
* </p>
|
|
5137
5268
|
* </dd>
|
|
5138
5269
|
* <dt>QUEUED_TIME</dt>
|
|
5139
5270
|
* <dd>
|
|
5140
5271
|
* <p>Unit: SECONDS</p>
|
|
5141
5272
|
* <p>Statistic: MAX</p>
|
|
5273
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow
|
|
5274
|
+
* time</a>
|
|
5275
|
+
* </p>
|
|
5142
5276
|
* </dd>
|
|
5143
5277
|
* <dt>SERVICE_LEVEL</dt>
|
|
5144
5278
|
* <dd>
|
|
@@ -5148,22 +5282,300 @@ export interface GetMetricDataRequest {
|
|
|
5148
5282
|
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5149
5283
|
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
5150
5284
|
* "Less than"). </p>
|
|
5285
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level">Service level
|
|
5286
|
+
* X</a>
|
|
5287
|
+
* </p>
|
|
5151
5288
|
* </dd>
|
|
5152
5289
|
* </dl>
|
|
5153
5290
|
* @public
|
|
5154
5291
|
*/
|
|
5155
|
-
|
|
5292
|
+
Name?: HistoricalMetricName | undefined;
|
|
5156
5293
|
/**
|
|
5157
|
-
* <p>The
|
|
5158
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
5294
|
+
* <p>The threshold for the metric, used with service level metrics.</p>
|
|
5159
5295
|
* @public
|
|
5160
5296
|
*/
|
|
5161
|
-
|
|
5297
|
+
Threshold?: Threshold | undefined;
|
|
5162
5298
|
/**
|
|
5163
|
-
* <p>The
|
|
5299
|
+
* <p>The statistic for the metric.</p>
|
|
5164
5300
|
* @public
|
|
5165
5301
|
*/
|
|
5166
|
-
|
|
5302
|
+
Statistic?: Statistic | undefined;
|
|
5303
|
+
/**
|
|
5304
|
+
* <p>The unit for the metric.</p>
|
|
5305
|
+
* @public
|
|
5306
|
+
*/
|
|
5307
|
+
Unit?: Unit | undefined;
|
|
5308
|
+
}
|
|
5309
|
+
/**
|
|
5310
|
+
* @public
|
|
5311
|
+
*/
|
|
5312
|
+
export interface GetMetricDataRequest {
|
|
5313
|
+
/**
|
|
5314
|
+
* <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>
|
|
5315
|
+
* @public
|
|
5316
|
+
*/
|
|
5317
|
+
InstanceId: string | undefined;
|
|
5318
|
+
/**
|
|
5319
|
+
* <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
|
|
5320
|
+
* retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes,
|
|
5321
|
+
* such as 10:05, 10:10, 10:15.</p>
|
|
5322
|
+
* <p>The start time cannot be earlier than 24 hours before the time of the request. Historical
|
|
5323
|
+
* metrics are available only for 24 hours.</p>
|
|
5324
|
+
* @public
|
|
5325
|
+
*/
|
|
5326
|
+
StartTime: Date | undefined;
|
|
5327
|
+
/**
|
|
5328
|
+
* <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the
|
|
5329
|
+
* retrieval of historical metrics data. The time must be specified using an interval of 5 minutes,
|
|
5330
|
+
* such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.</p>
|
|
5331
|
+
* <p>The time range between the start and end time must be less than 24 hours.</p>
|
|
5332
|
+
* @public
|
|
5333
|
+
*/
|
|
5334
|
+
EndTime: Date | undefined;
|
|
5335
|
+
/**
|
|
5336
|
+
* <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is
|
|
5337
|
+
* retrieved only for the resources associated with the queues or channels included in the filter.
|
|
5338
|
+
* You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
|
|
5339
|
+
* <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
|
|
5340
|
+
* GetMetricDataV2 for more up-to-date features.</p>
|
|
5341
|
+
* <note>
|
|
5342
|
+
* <p>To filter by <code>Queues</code>, enter the queue
|
|
5343
|
+
* ID/ARN, not the name of the queue.</p>
|
|
5344
|
+
* </note>
|
|
5345
|
+
* @public
|
|
5346
|
+
*/
|
|
5347
|
+
Filters: Filters | undefined;
|
|
5348
|
+
/**
|
|
5349
|
+
* <p>The grouping applied to the metrics returned. For example, when results are grouped by
|
|
5350
|
+
* queue, the metrics returned are grouped by queue. The values returned apply to the metrics for
|
|
5351
|
+
* each queue rather than aggregated for all queues.</p>
|
|
5352
|
+
* <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
|
|
5353
|
+
* <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to
|
|
5354
|
+
* GetMetricDataV2 for more up-to-date features.</p>
|
|
5355
|
+
* @public
|
|
5356
|
+
*/
|
|
5357
|
+
Groupings?: Grouping[] | undefined;
|
|
5358
|
+
/**
|
|
5359
|
+
* <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The
|
|
5360
|
+
* 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
|
|
5361
|
+
* definition</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
5362
|
+
* <note>
|
|
5363
|
+
* <p>This API does not support a contacts
|
|
5364
|
+
* incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list). </p>
|
|
5365
|
+
* </note>
|
|
5366
|
+
* <dl>
|
|
5367
|
+
* <dt>ABANDON_TIME</dt>
|
|
5368
|
+
* <dd>
|
|
5369
|
+
* <p>Unit: SECONDS</p>
|
|
5370
|
+
* <p>Statistic: AVG</p>
|
|
5371
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average
|
|
5372
|
+
* queue abandon time</a>
|
|
5373
|
+
* </p>
|
|
5374
|
+
* </dd>
|
|
5375
|
+
* <dt>AFTER_CONTACT_WORK_TIME</dt>
|
|
5376
|
+
* <dd>
|
|
5377
|
+
* <p>Unit: SECONDS</p>
|
|
5378
|
+
* <p>Statistic: AVG</p>
|
|
5379
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After
|
|
5380
|
+
* contact work time</a>
|
|
5381
|
+
* </p>
|
|
5382
|
+
* </dd>
|
|
5383
|
+
* <dt>API_CONTACTS_HANDLED</dt>
|
|
5384
|
+
* <dd>
|
|
5385
|
+
* <p>Unit: COUNT</p>
|
|
5386
|
+
* <p>Statistic: SUM</p>
|
|
5387
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts
|
|
5388
|
+
* handled</a>
|
|
5389
|
+
* </p>
|
|
5390
|
+
* </dd>
|
|
5391
|
+
* <dt>AVG_HOLD_TIME</dt>
|
|
5392
|
+
* <dd>
|
|
5393
|
+
* <p>Unit: SECONDS</p>
|
|
5394
|
+
* <p>Statistic: AVG</p>
|
|
5395
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average
|
|
5396
|
+
* customer hold time</a>
|
|
5397
|
+
* </p>
|
|
5398
|
+
* </dd>
|
|
5399
|
+
* <dt>CALLBACK_CONTACTS_HANDLED</dt>
|
|
5400
|
+
* <dd>
|
|
5401
|
+
* <p>Unit: COUNT</p>
|
|
5402
|
+
* <p>Statistic: SUM</p>
|
|
5403
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled">Callback
|
|
5404
|
+
* contacts handled</a>
|
|
5405
|
+
* </p>
|
|
5406
|
+
* </dd>
|
|
5407
|
+
* <dt>CONTACTS_ABANDONED</dt>
|
|
5408
|
+
* <dd>
|
|
5409
|
+
* <p>Unit: COUNT</p>
|
|
5410
|
+
* <p>Statistic: SUM</p>
|
|
5411
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contacts
|
|
5412
|
+
* abandoned</a>
|
|
5413
|
+
* </p>
|
|
5414
|
+
* </dd>
|
|
5415
|
+
* <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt>
|
|
5416
|
+
* <dd>
|
|
5417
|
+
* <p>Unit: COUNT</p>
|
|
5418
|
+
* <p>Statistic: SUM</p>
|
|
5419
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-agent-hung-up-first">Contacts agent hung up first</a>
|
|
5420
|
+
* </p>
|
|
5421
|
+
* </dd>
|
|
5422
|
+
* <dt>CONTACTS_CONSULTED</dt>
|
|
5423
|
+
* <dd>
|
|
5424
|
+
* <p>Unit: COUNT</p>
|
|
5425
|
+
* <p>Statistic: SUM</p>
|
|
5426
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted">Contacts
|
|
5427
|
+
* consulted</a>
|
|
5428
|
+
* </p>
|
|
5429
|
+
* </dd>
|
|
5430
|
+
* <dt>CONTACTS_HANDLED</dt>
|
|
5431
|
+
* <dd>
|
|
5432
|
+
* <p>Unit: COUNT</p>
|
|
5433
|
+
* <p>Statistic: SUM</p>
|
|
5434
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled">Contacts
|
|
5435
|
+
* handled</a>
|
|
5436
|
+
* </p>
|
|
5437
|
+
* </dd>
|
|
5438
|
+
* <dt>CONTACTS_HANDLED_INCOMING</dt>
|
|
5439
|
+
* <dd>
|
|
5440
|
+
* <p>Unit: COUNT</p>
|
|
5441
|
+
* <p>Statistic: SUM</p>
|
|
5442
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming">Contacts
|
|
5443
|
+
* handled incoming</a>
|
|
5444
|
+
* </p>
|
|
5445
|
+
* </dd>
|
|
5446
|
+
* <dt>CONTACTS_HANDLED_OUTBOUND</dt>
|
|
5447
|
+
* <dd>
|
|
5448
|
+
* <p>Unit: COUNT</p>
|
|
5449
|
+
* <p>Statistic: SUM</p>
|
|
5450
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound">Contacts
|
|
5451
|
+
* handled outbound</a>
|
|
5452
|
+
* </p>
|
|
5453
|
+
* </dd>
|
|
5454
|
+
* <dt>CONTACTS_HOLD_ABANDONS</dt>
|
|
5455
|
+
* <dd>
|
|
5456
|
+
* <p>Unit: COUNT</p>
|
|
5457
|
+
* <p>Statistic: SUM</p>
|
|
5458
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts
|
|
5459
|
+
* hold disconnect</a>
|
|
5460
|
+
* </p>
|
|
5461
|
+
* </dd>
|
|
5462
|
+
* <dt>CONTACTS_MISSED</dt>
|
|
5463
|
+
* <dd>
|
|
5464
|
+
* <p>Unit: COUNT</p>
|
|
5465
|
+
* <p>Statistic: SUM</p>
|
|
5466
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">AGENT_NON_RESPONSE</a>
|
|
5467
|
+
* </p>
|
|
5468
|
+
* </dd>
|
|
5469
|
+
* <dt>CONTACTS_QUEUED</dt>
|
|
5470
|
+
* <dd>
|
|
5471
|
+
* <p>Unit: COUNT</p>
|
|
5472
|
+
* <p>Statistic: SUM</p>
|
|
5473
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts
|
|
5474
|
+
* queued</a>
|
|
5475
|
+
* </p>
|
|
5476
|
+
* </dd>
|
|
5477
|
+
* <dt>CONTACTS_TRANSFERRED_IN</dt>
|
|
5478
|
+
* <dd>
|
|
5479
|
+
* <p>Unit: COUNT</p>
|
|
5480
|
+
* <p>Statistic: SUM</p>
|
|
5481
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in">Contacts
|
|
5482
|
+
* transferred in</a>
|
|
5483
|
+
* </p>
|
|
5484
|
+
* </dd>
|
|
5485
|
+
* <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt>
|
|
5486
|
+
* <dd>
|
|
5487
|
+
* <p>Unit: COUNT</p>
|
|
5488
|
+
* <p>Statistic: SUM</p>
|
|
5489
|
+
* <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>
|
|
5490
|
+
* </p>
|
|
5491
|
+
* </dd>
|
|
5492
|
+
* <dt>CONTACTS_TRANSFERRED_OUT</dt>
|
|
5493
|
+
* <dd>
|
|
5494
|
+
* <p>Unit: COUNT</p>
|
|
5495
|
+
* <p>Statistic: SUM</p>
|
|
5496
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts
|
|
5497
|
+
* transferred out</a>
|
|
5498
|
+
* </p>
|
|
5499
|
+
* </dd>
|
|
5500
|
+
* <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
|
|
5501
|
+
* <dd>
|
|
5502
|
+
* <p>Unit: COUNT</p>
|
|
5503
|
+
* <p>Statistic: SUM</p>
|
|
5504
|
+
* <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>
|
|
5505
|
+
* </p>
|
|
5506
|
+
* </dd>
|
|
5507
|
+
* <dt>HANDLE_TIME</dt>
|
|
5508
|
+
* <dd>
|
|
5509
|
+
* <p>Unit: SECONDS</p>
|
|
5510
|
+
* <p>Statistic: AVG</p>
|
|
5511
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle
|
|
5512
|
+
* time</a>
|
|
5513
|
+
* </p>
|
|
5514
|
+
* </dd>
|
|
5515
|
+
* <dt>INTERACTION_AND_HOLD_TIME</dt>
|
|
5516
|
+
* <dd>
|
|
5517
|
+
* <p>Unit: SECONDS</p>
|
|
5518
|
+
* <p>Statistic: AVG</p>
|
|
5519
|
+
* <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>
|
|
5520
|
+
* </p>
|
|
5521
|
+
* </dd>
|
|
5522
|
+
* <dt>INTERACTION_TIME</dt>
|
|
5523
|
+
* <dd>
|
|
5524
|
+
* <p>Unit: SECONDS</p>
|
|
5525
|
+
* <p>Statistic: AVG</p>
|
|
5526
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time">Average agent interaction time</a>
|
|
5527
|
+
* </p>
|
|
5528
|
+
* </dd>
|
|
5529
|
+
* <dt>OCCUPANCY</dt>
|
|
5530
|
+
* <dd>
|
|
5531
|
+
* <p>Unit: PERCENT</p>
|
|
5532
|
+
* <p>Statistic: AVG</p>
|
|
5533
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a>
|
|
5534
|
+
* </p>
|
|
5535
|
+
* </dd>
|
|
5536
|
+
* <dt>QUEUE_ANSWER_TIME</dt>
|
|
5537
|
+
* <dd>
|
|
5538
|
+
* <p>Unit: SECONDS</p>
|
|
5539
|
+
* <p>Statistic: AVG</p>
|
|
5540
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time">Average
|
|
5541
|
+
* queue answer time</a>
|
|
5542
|
+
* </p>
|
|
5543
|
+
* </dd>
|
|
5544
|
+
* <dt>QUEUED_TIME</dt>
|
|
5545
|
+
* <dd>
|
|
5546
|
+
* <p>Unit: SECONDS</p>
|
|
5547
|
+
* <p>Statistic: MAX</p>
|
|
5548
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow
|
|
5549
|
+
* time</a>
|
|
5550
|
+
* </p>
|
|
5551
|
+
* </dd>
|
|
5552
|
+
* <dt>SERVICE_LEVEL</dt>
|
|
5553
|
+
* <dd>
|
|
5554
|
+
* <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
|
|
5555
|
+
* <p>Unit: PERCENT</p>
|
|
5556
|
+
* <p>Statistic: AVG</p>
|
|
5557
|
+
* <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
|
|
5558
|
+
* (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
|
|
5559
|
+
* "Less than"). </p>
|
|
5560
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average
|
|
5561
|
+
* queue abandon time</a>
|
|
5562
|
+
* </p>
|
|
5563
|
+
* </dd>
|
|
5564
|
+
* </dl>
|
|
5565
|
+
* @public
|
|
5566
|
+
*/
|
|
5567
|
+
HistoricalMetrics: HistoricalMetric[] | undefined;
|
|
5568
|
+
/**
|
|
5569
|
+
* <p>The token for the next set of results. Use the value returned in the previous
|
|
5570
|
+
* response in the next request to retrieve the next set of results.</p>
|
|
5571
|
+
* @public
|
|
5572
|
+
*/
|
|
5573
|
+
NextToken?: string | undefined;
|
|
5574
|
+
/**
|
|
5575
|
+
* <p>The maximum number of results to return per page.</p>
|
|
5576
|
+
* @public
|
|
5577
|
+
*/
|
|
5578
|
+
MaxResults?: number | undefined;
|
|
5167
5579
|
}
|
|
5168
5580
|
/**
|
|
5169
5581
|
* <p>Contains the data for a historical metric.</p>
|
|
@@ -5810,6 +6222,24 @@ export interface GetMetricDataV2Request {
|
|
|
5810
6222
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
5811
6223
|
* </note>
|
|
5812
6224
|
* </dd>
|
|
6225
|
+
* <dt>AVG_CONTACT_FIRST_RESPONSE_TIME_AGENT</dt>
|
|
6226
|
+
* <dd>
|
|
6227
|
+
* <p>Unit: Seconds</p>
|
|
6228
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6229
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6230
|
+
* Q in Connect</p>
|
|
6231
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-average-contact-first-response-wait-time">Agent average contact first response wait time</a>
|
|
6232
|
+
* </p>
|
|
6233
|
+
* </dd>
|
|
6234
|
+
* <dt>AVG_CONVERSATION_CLOSE_TIME</dt>
|
|
6235
|
+
* <dd>
|
|
6236
|
+
* <p>Unit: Seconds</p>
|
|
6237
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6238
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6239
|
+
* Q in Connect</p>
|
|
6240
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-conversation-close-time">Average conversation close time</a>
|
|
6241
|
+
* </p>
|
|
6242
|
+
* </dd>
|
|
5813
6243
|
* <dt>AVG_CONVERSATION_DURATION</dt>
|
|
5814
6244
|
* <dd>
|
|
5815
6245
|
* <p>Unit: Seconds</p>
|
|
@@ -5837,6 +6267,15 @@ export interface GetMetricDataV2Request {
|
|
|
5837
6267
|
* evaluation score</a>
|
|
5838
6268
|
* </p>
|
|
5839
6269
|
* </dd>
|
|
6270
|
+
* <dt>AVG_FIRST_RESPONSE_TIME_AGENT</dt>
|
|
6271
|
+
* <dd>
|
|
6272
|
+
* <p>Unit: Seconds</p>
|
|
6273
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6274
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6275
|
+
* Q in Connect</p>
|
|
6276
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-first-response-time">Average agent first response time</a>
|
|
6277
|
+
* </p>
|
|
6278
|
+
* </dd>
|
|
5840
6279
|
* <dt>AVG_FLOW_TIME</dt>
|
|
5841
6280
|
* <dd>
|
|
5842
6281
|
* <p>Unit: Seconds</p>
|
|
@@ -5943,6 +6382,65 @@ export interface GetMetricDataV2Request {
|
|
|
5943
6382
|
* <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>
|
|
5944
6383
|
* </p>
|
|
5945
6384
|
* </dd>
|
|
6385
|
+
* <dt>AVG_MESSAGE_LENGTH_AGENT</dt>
|
|
6386
|
+
* <dd>
|
|
6387
|
+
* <p>Unit: Count</p>
|
|
6388
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6389
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6390
|
+
* Q in Connect</p>
|
|
6391
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-message-length">Average
|
|
6392
|
+
* agent message length</a>
|
|
6393
|
+
* </p>
|
|
6394
|
+
* </dd>
|
|
6395
|
+
* <dt>AVG_MESSAGE_LENGTH_CUSTOMER</dt>
|
|
6396
|
+
* <dd>
|
|
6397
|
+
* <p>Unit: Count</p>
|
|
6398
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6399
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6400
|
+
* Q in Connect</p>
|
|
6401
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-message-length">Average customer message length</a>
|
|
6402
|
+
* </p>
|
|
6403
|
+
* </dd>
|
|
6404
|
+
* <dt>AVG_MESSAGES</dt>
|
|
6405
|
+
* <dd>
|
|
6406
|
+
* <p>Unit: Count</p>
|
|
6407
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6408
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6409
|
+
* Q in Connect</p>
|
|
6410
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-messages">Average
|
|
6411
|
+
* messages</a>
|
|
6412
|
+
* </p>
|
|
6413
|
+
* </dd>
|
|
6414
|
+
* <dt>AVG_MESSAGES_AGENT</dt>
|
|
6415
|
+
* <dd>
|
|
6416
|
+
* <p>Unit: Count</p>
|
|
6417
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6418
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6419
|
+
* Q in Connect</p>
|
|
6420
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-messages">Average agent
|
|
6421
|
+
* messages</a>
|
|
6422
|
+
* </p>
|
|
6423
|
+
* </dd>
|
|
6424
|
+
* <dt>AVG_MESSAGES_BOT</dt>
|
|
6425
|
+
* <dd>
|
|
6426
|
+
* <p>Unit: Count</p>
|
|
6427
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6428
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6429
|
+
* Q in Connect</p>
|
|
6430
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-bot-messages">Average bot
|
|
6431
|
+
* messages</a>
|
|
6432
|
+
* </p>
|
|
6433
|
+
* </dd>
|
|
6434
|
+
* <dt>AVG_MESSAGES_CUSTOMER</dt>
|
|
6435
|
+
* <dd>
|
|
6436
|
+
* <p>Unit: Count</p>
|
|
6437
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6438
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6439
|
+
* Q in Connect</p>
|
|
6440
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-messages">Average
|
|
6441
|
+
* customer messages</a>
|
|
6442
|
+
* </p>
|
|
6443
|
+
* </dd>
|
|
5946
6444
|
* <dt>AVG_NON_TALK_TIME</dt>
|
|
5947
6445
|
* <dd>
|
|
5948
6446
|
* <p>This metric is available only for contacts analyzed by Contact Lens conversational
|
|
@@ -5966,6 +6464,26 @@ export interface GetMetricDataV2Request {
|
|
|
5966
6464
|
* <p>Feature is a valid filter but not a valid grouping.</p>
|
|
5967
6465
|
* </note>
|
|
5968
6466
|
* </dd>
|
|
6467
|
+
* <dt>AVG_RESPONSE_TIME_AGENT</dt>
|
|
6468
|
+
* <dd>
|
|
6469
|
+
* <p>Unit: Seconds</p>
|
|
6470
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6471
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6472
|
+
* Q in Connect</p>
|
|
6473
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-response-time-agent">Average
|
|
6474
|
+
* agent response time</a>
|
|
6475
|
+
* </p>
|
|
6476
|
+
* </dd>
|
|
6477
|
+
* <dt>AVG_RESPONSE_TIME_CUSTOMER</dt>
|
|
6478
|
+
* <dd>
|
|
6479
|
+
* <p>Unit: Seconds</p>
|
|
6480
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6481
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6482
|
+
* Q in Connect</p>
|
|
6483
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-time-agent">Average
|
|
6484
|
+
* customer response time</a>
|
|
6485
|
+
* </p>
|
|
6486
|
+
* </dd>
|
|
5969
6487
|
* <dt>AVG_RESOLUTION_TIME</dt>
|
|
5970
6488
|
* <dd>
|
|
5971
6489
|
* <p>Unit: Seconds</p>
|
|
@@ -6280,6 +6798,15 @@ export interface GetMetricDataV2Request {
|
|
|
6280
6798
|
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#current-cases">Current cases</a>
|
|
6281
6799
|
* </p>
|
|
6282
6800
|
* </dd>
|
|
6801
|
+
* <dt>CONVERSATIONS_ABANDONED</dt>
|
|
6802
|
+
* <dd>
|
|
6803
|
+
* <p>Unit: Count</p>
|
|
6804
|
+
* <p>Valid groupings and filters: Agent, Agent Hierarchy, Channel, contact/segmentAttributes/connect:Subtype,
|
|
6805
|
+
* Disconnect Reason, Feature, RoutingStepExpression, Initiation method, Routing Profile, Queue,
|
|
6806
|
+
* Q in Connect</p>
|
|
6807
|
+
* <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#conversations-abandoned">Conversations abandoned</a>
|
|
6808
|
+
* </p>
|
|
6809
|
+
* </dd>
|
|
6283
6810
|
* <dt>DELIVERY_ATTEMPTS</dt>
|
|
6284
6811
|
* <dd>
|
|
6285
6812
|
* <p>This metric is available only for outbound campaigns.</p>
|
|
@@ -6917,8 +7444,8 @@ export interface GetTaskTemplateResponse {
|
|
|
6917
7444
|
*/
|
|
6918
7445
|
ContactFlowId?: string | undefined;
|
|
6919
7446
|
/**
|
|
6920
|
-
* <p>ContactFlowId for the flow that will be run if this template is used to create a
|
|
6921
|
-
* self-assigned task
|
|
7447
|
+
* <p>The ContactFlowId for the flow that will be run if this template is used to create a
|
|
7448
|
+
* self-assigned task.</p>
|
|
6922
7449
|
* @public
|
|
6923
7450
|
*/
|
|
6924
7451
|
SelfAssignFlowId?: string | undefined;
|
|
@@ -7283,9 +7810,7 @@ export interface ListAssociatedContactsRequest {
|
|
|
7283
7810
|
*/
|
|
7284
7811
|
ContactId: string | undefined;
|
|
7285
7812
|
/**
|
|
7286
|
-
* <p>The maximum number of results to return per page
|
|
7287
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 25.</p>
|
|
7288
|
-
* <p>Valid Range: Minimum value of 1. Maximum value of 100.</p>
|
|
7813
|
+
* <p>The maximum number of results to return per page. </p>
|
|
7289
7814
|
* @public
|
|
7290
7815
|
*/
|
|
7291
7816
|
MaxResults?: number | undefined;
|
|
@@ -8441,7 +8966,7 @@ export interface ListHoursOfOperationOverridesRequest {
|
|
|
8441
8966
|
*/
|
|
8442
8967
|
InstanceId: string | undefined;
|
|
8443
8968
|
/**
|
|
8444
|
-
* <p>The identifier for the hours of operation
|
|
8969
|
+
* <p>The identifier for the hours of operation.</p>
|
|
8445
8970
|
* @public
|
|
8446
8971
|
*/
|
|
8447
8972
|
HoursOfOperationId: string | undefined;
|
|
@@ -8452,8 +8977,7 @@ export interface ListHoursOfOperationOverridesRequest {
|
|
|
8452
8977
|
*/
|
|
8453
8978
|
NextToken?: string | undefined;
|
|
8454
8979
|
/**
|
|
8455
|
-
* <p>The maximum number of results to return per page
|
|
8456
|
-
* Range: Minimum value of 1. Maximum value of 1000.</p>
|
|
8980
|
+
* <p>The maximum number of results to return per page.</p>
|
|
8457
8981
|
* @public
|
|
8458
8982
|
*/
|
|
8459
8983
|
MaxResults?: number | undefined;
|
|
@@ -8474,7 +8998,7 @@ export interface ListHoursOfOperationOverridesResponse {
|
|
|
8474
8998
|
*/
|
|
8475
8999
|
HoursOfOperationOverrideList?: HoursOfOperationOverride[] | undefined;
|
|
8476
9000
|
/**
|
|
8477
|
-
* <p>The
|
|
9001
|
+
* <p>The Amazon Web Services Region where this resource was last modified.</p>
|
|
8478
9002
|
* @public
|
|
8479
9003
|
*/
|
|
8480
9004
|
LastModifiedRegion?: string | undefined;
|
|
@@ -8715,209 +9239,6 @@ export interface ListInstanceStorageConfigsResponse {
|
|
|
8715
9239
|
*/
|
|
8716
9240
|
NextToken?: string | undefined;
|
|
8717
9241
|
}
|
|
8718
|
-
/**
|
|
8719
|
-
* @public
|
|
8720
|
-
*/
|
|
8721
|
-
export interface ListIntegrationAssociationsRequest {
|
|
8722
|
-
/**
|
|
8723
|
-
* <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>
|
|
8724
|
-
* @public
|
|
8725
|
-
*/
|
|
8726
|
-
InstanceId: string | undefined;
|
|
8727
|
-
/**
|
|
8728
|
-
* <p>The integration type.</p>
|
|
8729
|
-
* @public
|
|
8730
|
-
*/
|
|
8731
|
-
IntegrationType?: IntegrationType | undefined;
|
|
8732
|
-
/**
|
|
8733
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8734
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8735
|
-
* @public
|
|
8736
|
-
*/
|
|
8737
|
-
NextToken?: string | undefined;
|
|
8738
|
-
/**
|
|
8739
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8740
|
-
* @public
|
|
8741
|
-
*/
|
|
8742
|
-
MaxResults?: number | undefined;
|
|
8743
|
-
/**
|
|
8744
|
-
* <p>The Amazon Resource Name (ARN) of the integration.</p>
|
|
8745
|
-
* @public
|
|
8746
|
-
*/
|
|
8747
|
-
IntegrationArn?: string | undefined;
|
|
8748
|
-
}
|
|
8749
|
-
/**
|
|
8750
|
-
* <p>Contains summary information about the associated AppIntegrations.</p>
|
|
8751
|
-
* @public
|
|
8752
|
-
*/
|
|
8753
|
-
export interface IntegrationAssociationSummary {
|
|
8754
|
-
/**
|
|
8755
|
-
* <p>The identifier for the AppIntegration association.</p>
|
|
8756
|
-
* @public
|
|
8757
|
-
*/
|
|
8758
|
-
IntegrationAssociationId?: string | undefined;
|
|
8759
|
-
/**
|
|
8760
|
-
* <p>The Amazon Resource Name (ARN) for the AppIntegration association.</p>
|
|
8761
|
-
* @public
|
|
8762
|
-
*/
|
|
8763
|
-
IntegrationAssociationArn?: string | undefined;
|
|
8764
|
-
/**
|
|
8765
|
-
* <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>
|
|
8766
|
-
* @public
|
|
8767
|
-
*/
|
|
8768
|
-
InstanceId?: string | undefined;
|
|
8769
|
-
/**
|
|
8770
|
-
* <p>The integration type.</p>
|
|
8771
|
-
* @public
|
|
8772
|
-
*/
|
|
8773
|
-
IntegrationType?: IntegrationType | undefined;
|
|
8774
|
-
/**
|
|
8775
|
-
* <p>The Amazon Resource Name (ARN) for the AppIntegration.</p>
|
|
8776
|
-
* @public
|
|
8777
|
-
*/
|
|
8778
|
-
IntegrationArn?: string | undefined;
|
|
8779
|
-
/**
|
|
8780
|
-
* <p>The URL for the external application.</p>
|
|
8781
|
-
* @public
|
|
8782
|
-
*/
|
|
8783
|
-
SourceApplicationUrl?: string | undefined;
|
|
8784
|
-
/**
|
|
8785
|
-
* <p>The user-provided, friendly name for the external application.</p>
|
|
8786
|
-
* @public
|
|
8787
|
-
*/
|
|
8788
|
-
SourceApplicationName?: string | undefined;
|
|
8789
|
-
/**
|
|
8790
|
-
* <p>The name of the source.</p>
|
|
8791
|
-
* @public
|
|
8792
|
-
*/
|
|
8793
|
-
SourceType?: SourceType | undefined;
|
|
8794
|
-
}
|
|
8795
|
-
/**
|
|
8796
|
-
* @public
|
|
8797
|
-
*/
|
|
8798
|
-
export interface ListIntegrationAssociationsResponse {
|
|
8799
|
-
/**
|
|
8800
|
-
* <p>The associations.</p>
|
|
8801
|
-
* @public
|
|
8802
|
-
*/
|
|
8803
|
-
IntegrationAssociationSummaryList?: IntegrationAssociationSummary[] | undefined;
|
|
8804
|
-
/**
|
|
8805
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8806
|
-
* @public
|
|
8807
|
-
*/
|
|
8808
|
-
NextToken?: string | undefined;
|
|
8809
|
-
}
|
|
8810
|
-
/**
|
|
8811
|
-
* @public
|
|
8812
|
-
*/
|
|
8813
|
-
export interface ListLambdaFunctionsRequest {
|
|
8814
|
-
/**
|
|
8815
|
-
* <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>
|
|
8816
|
-
* @public
|
|
8817
|
-
*/
|
|
8818
|
-
InstanceId: string | undefined;
|
|
8819
|
-
/**
|
|
8820
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8821
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8822
|
-
* @public
|
|
8823
|
-
*/
|
|
8824
|
-
NextToken?: string | undefined;
|
|
8825
|
-
/**
|
|
8826
|
-
* <p>The maximum number of results to return per page.</p>
|
|
8827
|
-
* @public
|
|
8828
|
-
*/
|
|
8829
|
-
MaxResults?: number | undefined;
|
|
8830
|
-
}
|
|
8831
|
-
/**
|
|
8832
|
-
* @public
|
|
8833
|
-
*/
|
|
8834
|
-
export interface ListLambdaFunctionsResponse {
|
|
8835
|
-
/**
|
|
8836
|
-
* <p>The Lambdafunction ARNs associated with the specified instance.</p>
|
|
8837
|
-
* @public
|
|
8838
|
-
*/
|
|
8839
|
-
LambdaFunctions?: string[] | undefined;
|
|
8840
|
-
/**
|
|
8841
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8842
|
-
* @public
|
|
8843
|
-
*/
|
|
8844
|
-
NextToken?: string | undefined;
|
|
8845
|
-
}
|
|
8846
|
-
/**
|
|
8847
|
-
* @public
|
|
8848
|
-
*/
|
|
8849
|
-
export interface ListLexBotsRequest {
|
|
8850
|
-
/**
|
|
8851
|
-
* <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>
|
|
8852
|
-
* @public
|
|
8853
|
-
*/
|
|
8854
|
-
InstanceId: string | undefined;
|
|
8855
|
-
/**
|
|
8856
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8857
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8858
|
-
* @public
|
|
8859
|
-
*/
|
|
8860
|
-
NextToken?: string | undefined;
|
|
8861
|
-
/**
|
|
8862
|
-
* <p>The maximum number of results to return per page. If no value is specified, the default is 10.
|
|
8863
|
-
* </p>
|
|
8864
|
-
* @public
|
|
8865
|
-
*/
|
|
8866
|
-
MaxResults?: number | undefined;
|
|
8867
|
-
}
|
|
8868
|
-
/**
|
|
8869
|
-
* @public
|
|
8870
|
-
*/
|
|
8871
|
-
export interface ListLexBotsResponse {
|
|
8872
|
-
/**
|
|
8873
|
-
* <p>The names and Amazon Web Services Regions of the Amazon Lex bots associated with the
|
|
8874
|
-
* specified instance.</p>
|
|
8875
|
-
* @public
|
|
8876
|
-
*/
|
|
8877
|
-
LexBots?: LexBot[] | undefined;
|
|
8878
|
-
/**
|
|
8879
|
-
* <p>If there are additional results, this is the token for the next set of results.</p>
|
|
8880
|
-
* @public
|
|
8881
|
-
*/
|
|
8882
|
-
NextToken?: string | undefined;
|
|
8883
|
-
}
|
|
8884
|
-
/**
|
|
8885
|
-
* @public
|
|
8886
|
-
*/
|
|
8887
|
-
export interface ListPhoneNumbersRequest {
|
|
8888
|
-
/**
|
|
8889
|
-
* <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>
|
|
8890
|
-
* @public
|
|
8891
|
-
*/
|
|
8892
|
-
InstanceId: string | undefined;
|
|
8893
|
-
/**
|
|
8894
|
-
* <p>The type of phone number.</p>
|
|
8895
|
-
* <note>
|
|
8896
|
-
* <p>We recommend using <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> to
|
|
8897
|
-
* return phone number types. While ListPhoneNumbers returns number types <code>UIFN</code>,
|
|
8898
|
-
* <code>SHARED</code>, <code>THIRD_PARTY_TF</code>, and <code>THIRD_PARTY_DID</code>, it
|
|
8899
|
-
* incorrectly lists them as <code>TOLL_FREE</code> or <code>DID</code>. </p>
|
|
8900
|
-
* </note>
|
|
8901
|
-
* @public
|
|
8902
|
-
*/
|
|
8903
|
-
PhoneNumberTypes?: PhoneNumberType[] | undefined;
|
|
8904
|
-
/**
|
|
8905
|
-
* <p>The ISO country code.</p>
|
|
8906
|
-
* @public
|
|
8907
|
-
*/
|
|
8908
|
-
PhoneNumberCountryCodes?: PhoneNumberCountryCode[] | undefined;
|
|
8909
|
-
/**
|
|
8910
|
-
* <p>The token for the next set of results. Use the value returned in the previous
|
|
8911
|
-
* response in the next request to retrieve the next set of results.</p>
|
|
8912
|
-
* @public
|
|
8913
|
-
*/
|
|
8914
|
-
NextToken?: string | undefined;
|
|
8915
|
-
/**
|
|
8916
|
-
* <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
|
|
8917
|
-
* @public
|
|
8918
|
-
*/
|
|
8919
|
-
MaxResults?: number | undefined;
|
|
8920
|
-
}
|
|
8921
9242
|
/**
|
|
8922
9243
|
* @internal
|
|
8923
9244
|
*/
|