@aws-sdk/client-connect 3.1080.0 → 3.1081.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.
Files changed (52) hide show
  1. package/README.md +14 -0
  2. package/dist-cjs/index.js +119 -54
  3. package/dist-es/Connect.js +4 -0
  4. package/dist-es/commands/CreateAuthCodeCommand.js +4 -0
  5. package/dist-es/commands/DeleteSessionCommand.js +4 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/enums.js +3 -0
  8. package/dist-es/schemas/schemas_0.js +97 -53
  9. package/dist-types/Connect.d.ts +14 -0
  10. package/dist-types/ConnectClient.d.ts +4 -2
  11. package/dist-types/commands/CreateAuthCodeCommand.d.ts +103 -0
  12. package/dist-types/commands/CreateUserHierarchyGroupCommand.d.ts +2 -1
  13. package/dist-types/commands/CreateViewCommand.d.ts +1 -2
  14. package/dist-types/commands/DeleteSessionCommand.d.ts +88 -0
  15. package/dist-types/commands/GetFederationTokenCommand.d.ts +5 -2
  16. package/dist-types/commands/GetMetricDataCommand.d.ts +1 -2
  17. package/dist-types/commands/SearchDataTablesCommand.d.ts +1 -2
  18. package/dist-types/commands/SearchQuickConnectsCommand.d.ts +2 -1
  19. package/dist-types/commands/SearchRoutingProfilesCommand.d.ts +2 -1
  20. package/dist-types/commands/SearchSecurityProfilesCommand.d.ts +2 -1
  21. package/dist-types/commands/SearchTestCasesCommand.d.ts +2 -1
  22. package/dist-types/commands/SearchUserHierarchyGroupsCommand.d.ts +2 -1
  23. package/dist-types/commands/index.d.ts +2 -0
  24. package/dist-types/models/enums.d.ts +11 -0
  25. package/dist-types/models/models_0.d.ts +80 -78
  26. package/dist-types/models/models_1.d.ts +106 -542
  27. package/dist-types/models/models_2.d.ts +535 -103
  28. package/dist-types/models/models_3.d.ts +105 -173
  29. package/dist-types/models/models_4.d.ts +171 -2
  30. package/dist-types/schemas/schemas_0.d.ts +7 -0
  31. package/dist-types/ts3.4/Connect.d.ts +34 -0
  32. package/dist-types/ts3.4/ConnectClient.d.ts +12 -0
  33. package/dist-types/ts3.4/commands/CreateAuthCodeCommand.d.ts +43 -0
  34. package/dist-types/ts3.4/commands/CreateUserHierarchyGroupCommand.d.ts +2 -4
  35. package/dist-types/ts3.4/commands/CreateViewCommand.d.ts +1 -2
  36. package/dist-types/ts3.4/commands/DeleteSessionCommand.d.ts +43 -0
  37. package/dist-types/ts3.4/commands/GetMetricDataCommand.d.ts +4 -2
  38. package/dist-types/ts3.4/commands/SearchDataTablesCommand.d.ts +4 -2
  39. package/dist-types/ts3.4/commands/SearchQuickConnectsCommand.d.ts +2 -4
  40. package/dist-types/ts3.4/commands/SearchRoutingProfilesCommand.d.ts +2 -4
  41. package/dist-types/ts3.4/commands/SearchSecurityProfilesCommand.d.ts +2 -4
  42. package/dist-types/ts3.4/commands/SearchTestCasesCommand.d.ts +2 -4
  43. package/dist-types/ts3.4/commands/SearchUserHierarchyGroupsCommand.d.ts +2 -4
  44. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  45. package/dist-types/ts3.4/models/enums.d.ts +5 -0
  46. package/dist-types/ts3.4/models/models_0.d.ts +19 -18
  47. package/dist-types/ts3.4/models/models_1.d.ts +24 -33
  48. package/dist-types/ts3.4/models/models_2.d.ts +35 -23
  49. package/dist-types/ts3.4/models/models_3.d.ts +23 -38
  50. package/dist-types/ts3.4/models/models_4.d.ts +47 -4
  51. package/dist-types/ts3.4/schemas/schemas_0.d.ts +7 -0
  52. package/package.json +3 -3
@@ -1,5 +1,82 @@
1
- import type { AgentAvailabilityTimer, AttachmentScope, AutoEvaluationStatus, Channel, Comparison, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactMetricName, ContactParticipantRole, ContactState, CurrentMetricName, DataTableAttributeValueType, DataTableLockLevel, DataTableStatus, DirectoryType, EndpointType, EntityType, EvaluationFormValidationFindingSeverity, EvaluationFormValidationStatus, EvaluationQuestionAnswerAnalysisType, EvaluationStatus, EvaluationSuggestedAnswerStatus, EvaluationTranscriptType, EvaluationType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, Grouping, HistoricalMetricName, InstanceAttributeType, InstanceReplicationStatus, InstanceStatus, InstanceStorageResourceType, LocaleCode, MediaStreamType, MediaType, NextContactType, NotificationPriority, OperationalStatus, OverrideType, ParticipantType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, PhoneNumberWorkflowStatus, QuestionRuleCategoryAutomationCondition, QueueStatus, QuickConnectType, RecordingStatus, RulePublishStatus, SortOrder, Statistic, Status, StorageType, TestCaseStatus, TrafficDistributionGroupStatus, Unit, ViewStatus, ViewType, Visibility, VocabularyLanguageCode, VocabularyState, WorkspaceFontFamily } from "./enums";
1
+ import type { AgentAvailabilityTimer, AttachmentScope, AutoEvaluationStatus, Channel, ContactFlowModuleState, ContactFlowModuleStatus, ContactFlowState, ContactFlowStatus, ContactFlowType, ContactMetricName, ContactParticipantRole, ContactState, CurrentMetricName, DataTableAttributeValueType, DataTableLockLevel, DataTableStatus, DirectoryType, EndpointType, EntityType, EvaluationFormValidationFindingSeverity, EvaluationFormValidationStatus, EvaluationQuestionAnswerAnalysisType, EvaluationStatus, EvaluationSuggestedAnswerStatus, EvaluationTranscriptType, EvaluationType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, Grouping, InstanceAttributeType, InstanceReplicationStatus, InstanceStatus, InstanceStorageResourceType, LocaleCode, MediaStreamType, MediaType, NextContactType, NotificationPriority, OperationalStatus, OverrideType, ParticipantType, PerformanceCategoryName, PhoneNumberCountryCode, PhoneNumberType, PhoneNumberWorkflowStatus, QuestionRuleCategoryAutomationCondition, QueueStatus, QuickConnectType, RecordingStatus, RulePublishStatus, SortOrder, Status, StorageType, TestCaseStatus, TrafficDistributionGroupStatus, Unit, ViewStatus, ViewType, Visibility, VocabularyLanguageCode, VocabularyState, WorkspaceFontFamily } from "./enums";
2
2
  import type { AfterContactWorkConfigPerChannel, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusIdentifier, AgentStatusReference, AiAgentInfo, AliasConfiguration, AllowedExtension, AudioQualityMetricsInfo, AutoAcceptConfig, CreatedByInfo, DataTableLockVersion, DeviceInfo, ExternalInvocationConfiguration, FailedBatchAssociationSummary, GranularAccessControlConfiguration, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, LexBot, LexV2Bot, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PersistentConnectionConfig, PhoneNumberConfig, PredefinedAttributeValues, PrimaryValue, QueueReference, QuickConnectConfig, RecurrenceConfig, RoutingProfileQueueReference, RuleAction, RuleTriggerEventSource, SecurityProfileItem, SuccessfulBatchAssociationSummary, TestCaseEntryPoint, UserIdentityInfo, UserPhoneConfig, Validation, VoiceEnhancementConfig } from "./models_0";
3
+ /**
4
+ * @public
5
+ */
6
+ export interface CreateUserHierarchyGroupResponse {
7
+ /**
8
+ * <p>The identifier of the hierarchy group.</p>
9
+ * @public
10
+ */
11
+ HierarchyGroupId?: string | undefined;
12
+ /**
13
+ * <p>The Amazon Resource Name (ARN) of the hierarchy group. </p>
14
+ * @public
15
+ */
16
+ HierarchyGroupArn?: string | undefined;
17
+ }
18
+ /**
19
+ * <p>View content containing all content necessary to render a view except for runtime input data and the runtime
20
+ * input schema, which is auto-generated by this operation.</p>
21
+ * @public
22
+ */
23
+ export interface ViewInputContent {
24
+ /**
25
+ * <p>The view template representing the structure of the view.</p>
26
+ * @public
27
+ */
28
+ Template?: string | undefined;
29
+ /**
30
+ * <p>A list of possible actions from the view.</p>
31
+ * @public
32
+ */
33
+ Actions?: string[] | undefined;
34
+ }
35
+ /**
36
+ * @public
37
+ */
38
+ export interface CreateViewRequest {
39
+ /**
40
+ * <p>The identifier of the Connect Customer instance. You can find the instanceId in the ARN of the
41
+ * instance.</p>
42
+ * @public
43
+ */
44
+ InstanceId: string | undefined;
45
+ /**
46
+ * <p>A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent
47
+ * ClientToken is provided.</p>
48
+ * @public
49
+ */
50
+ ClientToken?: string | undefined;
51
+ /**
52
+ * <p>Indicates the view status as either <code>SAVED</code> or <code>PUBLISHED</code>. The <code>PUBLISHED</code>
53
+ * status will initiate validation on the content.</p>
54
+ * @public
55
+ */
56
+ Status: ViewStatus | undefined;
57
+ /**
58
+ * <p>View content containing all content necessary to render a view except for runtime input data.</p>
59
+ * <p>The total uncompressed content has a maximum file size of 400kB.</p>
60
+ * @public
61
+ */
62
+ Content: ViewInputContent | undefined;
63
+ /**
64
+ * <p>The description of the view.</p>
65
+ * @public
66
+ */
67
+ Description?: string | undefined;
68
+ /**
69
+ * <p>The name of the view.</p>
70
+ * @public
71
+ */
72
+ Name: string | undefined;
73
+ /**
74
+ * <p>The tags associated with the view resource (not specific to view version).These tags can be used to organize,
75
+ * track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.</p>
76
+ * @public
77
+ */
78
+ Tags?: Record<string, string> | undefined;
79
+ }
3
80
  /**
4
81
  * <p>View content containing all content necessary to render a view except for runtime input data.</p>
5
82
  * @public
@@ -1033,6 +1110,26 @@ export interface DeleteSecurityProfileRequest {
1033
1110
  */
1034
1111
  SecurityProfileId: string | undefined;
1035
1112
  }
1113
+ /**
1114
+ * @public
1115
+ */
1116
+ export interface DeleteSessionRequest {
1117
+ /**
1118
+ * <p>The identifier of the Connect Customer 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>
1119
+ * @public
1120
+ */
1121
+ InstanceId: string | undefined;
1122
+ /**
1123
+ * <p>The identifier of the session to delete.</p>
1124
+ * @public
1125
+ */
1126
+ SessionId: string | undefined;
1127
+ }
1128
+ /**
1129
+ * @public
1130
+ */
1131
+ export interface DeleteSessionResponse {
1132
+ }
1036
1133
  /**
1037
1134
  * @public
1038
1135
  */
@@ -7038,25 +7135,25 @@ export interface Credentials {
7038
7135
  */
7039
7136
  export interface GetFederationTokenResponse {
7040
7137
  /**
7041
- * <p>The credentials to use for federation.</p>
7138
+ * <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
7042
7139
  * @public
7043
7140
  */
7044
- Credentials?: Credentials | undefined;
7141
+ UserId?: string | undefined;
7045
7142
  /**
7046
- * <p>The URL to sign into the user's instance. </p>
7143
+ * <p>The Amazon Resource Name (ARN) of the user.</p>
7047
7144
  * @public
7048
7145
  */
7049
- SignInUrl?: string | undefined;
7146
+ UserArn?: string | undefined;
7050
7147
  /**
7051
- * <p>The Amazon Resource Name (ARN) of the user.</p>
7148
+ * <p>The credentials to use for federation.</p>
7052
7149
  * @public
7053
7150
  */
7054
- UserArn?: string | undefined;
7151
+ Credentials?: Credentials | undefined;
7055
7152
  /**
7056
- * <p>The identifier for the user. This can be the ID or the ARN of the user.</p>
7153
+ * <p>The URL to sign into the user's instance. </p>
7057
7154
  * @public
7058
7155
  */
7059
- UserId?: string | undefined;
7156
+ SignInUrl?: string | undefined;
7060
7157
  }
7061
7158
  /**
7062
7159
  * @public
@@ -7109,536 +7206,3 @@ export interface GetFlowAssociationResponse {
7109
7206
  */
7110
7207
  ResourceType?: FlowAssociationResourceType | undefined;
7111
7208
  }
7112
- /**
7113
- * <p>Contains information about the threshold for service level metrics.</p>
7114
- * @public
7115
- */
7116
- export interface Threshold {
7117
- /**
7118
- * <p>The type of comparison. Only "less than" (LT) comparisons are supported.</p>
7119
- * @public
7120
- */
7121
- Comparison?: Comparison | undefined;
7122
- /**
7123
- * <p>The threshold value to compare.</p>
7124
- * @public
7125
- */
7126
- ThresholdValue?: number | undefined;
7127
- }
7128
- /**
7129
- * <p>Contains information about a historical metric. </p>
7130
- * @public
7131
- */
7132
- export interface HistoricalMetric {
7133
- /**
7134
- * <p>The name of the metric. Following is a list of each supported metric mapped to the UI name, linked to a detailed
7135
- * description in the <i>Connect Customer Administrator Guide</i>. </p>
7136
- * <dl>
7137
- * <dt>ABANDON_TIME</dt>
7138
- * <dd>
7139
- * <p>Unit: SECONDS</p>
7140
- * <p>Statistic: AVG</p>
7141
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon
7142
- * time</a>
7143
- * </p>
7144
- * </dd>
7145
- * <dt>AFTER_CONTACT_WORK_TIME</dt>
7146
- * <dd>
7147
- * <p>Unit: SECONDS</p>
7148
- * <p>Statistic: AVG</p>
7149
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After contact work time</a>
7150
- * </p>
7151
- * </dd>
7152
- * <dt>API_CONTACTS_HANDLED</dt>
7153
- * <dd>
7154
- * <p>Unit: COUNT</p>
7155
- * <p>Statistic: SUM</p>
7156
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts handled</a>
7157
- * </p>
7158
- * </dd>
7159
- * <dt>AVG_HOLD_TIME</dt>
7160
- * <dd>
7161
- * <p>Unit: SECONDS</p>
7162
- * <p>Statistic: AVG</p>
7163
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average customer hold
7164
- * time</a>
7165
- * </p>
7166
- * </dd>
7167
- * <dt>CALLBACK_CONTACTS_HANDLED</dt>
7168
- * <dd>
7169
- * <p>Unit: COUNT</p>
7170
- * <p>Statistic: SUM</p>
7171
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled">Callback contacts
7172
- * handled</a>
7173
- * </p>
7174
- * </dd>
7175
- * <dt>CONTACTS_ABANDONED</dt>
7176
- * <dd>
7177
- * <p>Unit: COUNT</p>
7178
- * <p>Statistic: SUM</p>
7179
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contacts abandoned</a>
7180
- * </p>
7181
- * </dd>
7182
- * <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt>
7183
- * <dd>
7184
- * <p>Unit: COUNT</p>
7185
- * <p>Statistic: SUM</p>
7186
- * <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
7187
- * first</a>
7188
- * </p>
7189
- * </dd>
7190
- * <dt>CONTACTS_CONSULTED</dt>
7191
- * <dd>
7192
- * <p>Unit: COUNT</p>
7193
- * <p>Statistic: SUM</p>
7194
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted">Contacts consulted</a>
7195
- * </p>
7196
- * </dd>
7197
- * <dt>CONTACTS_HANDLED</dt>
7198
- * <dd>
7199
- * <p>Unit: COUNT</p>
7200
- * <p>Statistic: SUM</p>
7201
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled">Contacts handled</a>
7202
- * </p>
7203
- * </dd>
7204
- * <dt>CONTACTS_HANDLED_INCOMING</dt>
7205
- * <dd>
7206
- * <p>Unit: COUNT</p>
7207
- * <p>Statistic: SUM</p>
7208
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming">Contacts handled
7209
- * incoming</a>
7210
- * </p>
7211
- * </dd>
7212
- * <dt>CONTACTS_HANDLED_OUTBOUND</dt>
7213
- * <dd>
7214
- * <p>Unit: COUNT</p>
7215
- * <p>Statistic: SUM</p>
7216
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound">Contacts handled
7217
- * outbound</a>
7218
- * </p>
7219
- * </dd>
7220
- * <dt>CONTACTS_HOLD_ABANDONS</dt>
7221
- * <dd>
7222
- * <p>Unit: COUNT</p>
7223
- * <p>Statistic: SUM</p>
7224
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts hold
7225
- * disconnect</a>
7226
- * </p>
7227
- * </dd>
7228
- * <dt>CONTACTS_MISSED</dt>
7229
- * <dd>
7230
- * <p>Unit: COUNT</p>
7231
- * <p>Statistic: SUM</p>
7232
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">AGENT_NON_RESPONSE</a>
7233
- * </p>
7234
- * </dd>
7235
- * <dt>CONTACTS_QUEUED</dt>
7236
- * <dd>
7237
- * <p>Unit: COUNT</p>
7238
- * <p>Statistic: SUM</p>
7239
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts queued</a>
7240
- * </p>
7241
- * </dd>
7242
- * <dt>CONTACTS_TRANSFERRED_IN</dt>
7243
- * <dd>
7244
- * <p>Unit: COUNT</p>
7245
- * <p>Statistic: SUM</p>
7246
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in">Contacts transferred in</a>
7247
- * </p>
7248
- * </dd>
7249
- * <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt>
7250
- * <dd>
7251
- * <p>Unit: COUNT</p>
7252
- * <p>Statistic: SUM</p>
7253
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out
7254
- * queue</a>
7255
- * </p>
7256
- * </dd>
7257
- * <dt>CONTACTS_TRANSFERRED_OUT</dt>
7258
- * <dd>
7259
- * <p>Unit: COUNT</p>
7260
- * <p>Statistic: SUM</p>
7261
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts transferred
7262
- * out</a>
7263
- * </p>
7264
- * </dd>
7265
- * <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
7266
- * <dd>
7267
- * <p>Unit: COUNT</p>
7268
- * <p>Statistic: SUM</p>
7269
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out
7270
- * queue</a>
7271
- * </p>
7272
- * </dd>
7273
- * <dt>HANDLE_TIME</dt>
7274
- * <dd>
7275
- * <p>Unit: SECONDS</p>
7276
- * <p>Statistic: AVG</p>
7277
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle time</a>
7278
- * </p>
7279
- * </dd>
7280
- * <dt>INTERACTION_AND_HOLD_TIME</dt>
7281
- * <dd>
7282
- * <p>Unit: SECONDS</p>
7283
- * <p>Statistic: AVG</p>
7284
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time">Average
7285
- * agent interaction and customer hold time</a>
7286
- * </p>
7287
- * </dd>
7288
- * <dt>INTERACTION_TIME</dt>
7289
- * <dd>
7290
- * <p>Unit: SECONDS</p>
7291
- * <p>Statistic: AVG</p>
7292
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time">Average agent
7293
- * interaction time</a>
7294
- * </p>
7295
- * </dd>
7296
- * <dt>OCCUPANCY</dt>
7297
- * <dd>
7298
- * <p>Unit: PERCENT</p>
7299
- * <p>Statistic: AVG</p>
7300
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a>
7301
- * </p>
7302
- * </dd>
7303
- * <dt>QUEUE_ANSWER_TIME</dt>
7304
- * <dd>
7305
- * <p>Unit: SECONDS</p>
7306
- * <p>Statistic: AVG</p>
7307
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time">Average queue answer
7308
- * time</a>
7309
- * </p>
7310
- * </dd>
7311
- * <dt>QUEUED_TIME</dt>
7312
- * <dd>
7313
- * <p>Unit: SECONDS</p>
7314
- * <p>Statistic: MAX</p>
7315
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow time</a>
7316
- * </p>
7317
- * </dd>
7318
- * <dt>SERVICE_LEVEL</dt>
7319
- * <dd>
7320
- * <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
7321
- * <p>Unit: PERCENT</p>
7322
- * <p>Statistic: AVG</p>
7323
- * <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds.
7324
- * For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than"). </p>
7325
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#service-level">Service level X</a>
7326
- * </p>
7327
- * </dd>
7328
- * </dl>
7329
- * @public
7330
- */
7331
- Name?: HistoricalMetricName | undefined;
7332
- /**
7333
- * <p>The threshold for the metric, used with service level metrics.</p>
7334
- * @public
7335
- */
7336
- Threshold?: Threshold | undefined;
7337
- /**
7338
- * <p>The statistic for the metric.</p>
7339
- * @public
7340
- */
7341
- Statistic?: Statistic | undefined;
7342
- /**
7343
- * <p>The unit for the metric.</p>
7344
- * @public
7345
- */
7346
- Unit?: Unit | undefined;
7347
- }
7348
- /**
7349
- * @public
7350
- */
7351
- export interface GetMetricDataRequest {
7352
- /**
7353
- * <p>The identifier of the Connect Customer 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>
7354
- * @public
7355
- */
7356
- InstanceId: string | undefined;
7357
- /**
7358
- * <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of
7359
- * historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10,
7360
- * 10:15.</p>
7361
- * <p>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available
7362
- * only for 24 hours.</p>
7363
- * @public
7364
- */
7365
- StartTime: Date | undefined;
7366
- /**
7367
- * <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical
7368
- * metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be
7369
- * later than the start time timestamp.</p>
7370
- * <p>The time range between the start and end time must be less than 24 hours.</p>
7371
- * @public
7372
- */
7373
- EndTime: Date | undefined;
7374
- /**
7375
- * <p>The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the
7376
- * resources associated with the queues or channels included in the filter. You can include both queue IDs and queue
7377
- * ARNs in the same request. VOICE, CHAT, and TASK channels are supported.</p>
7378
- * <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for
7379
- * more up-to-date features.</p>
7380
- * <note>
7381
- * <p>To filter by <code>Queues</code>, enter the queue ID/ARN, not the name of
7382
- * the queue.</p>
7383
- * </note>
7384
- * @public
7385
- */
7386
- Filters: Filters | undefined;
7387
- /**
7388
- * <p>The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics
7389
- * returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all
7390
- * queues.</p>
7391
- * <p>If no grouping is specified, a summary of metrics for all queues is returned.</p>
7392
- * <p>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for
7393
- * more up-to-date features.</p>
7394
- * @public
7395
- */
7396
- Groupings?: Grouping[] | undefined;
7397
- /**
7398
- * <p>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics
7399
- * are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html">Metrics definition</a> in the <i>Connect Customer Administrator Guide</i>.</p>
7400
- * <note>
7401
- * <p>This API does not support a contacts incoming metric (there's
7402
- * no CONTACTS_INCOMING metric missing from the documented list). </p>
7403
- * </note>
7404
- * <dl>
7405
- * <dt>ABANDON_TIME</dt>
7406
- * <dd>
7407
- * <p>Unit: SECONDS</p>
7408
- * <p>Statistic: AVG</p>
7409
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon
7410
- * time</a>
7411
- * </p>
7412
- * </dd>
7413
- * <dt>AFTER_CONTACT_WORK_TIME</dt>
7414
- * <dd>
7415
- * <p>Unit: SECONDS</p>
7416
- * <p>Statistic: AVG</p>
7417
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#after-contact-work-time">After contact work time</a>
7418
- * </p>
7419
- * </dd>
7420
- * <dt>API_CONTACTS_HANDLED</dt>
7421
- * <dd>
7422
- * <p>Unit: COUNT</p>
7423
- * <p>Statistic: SUM</p>
7424
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#api-contacts-handled">API contacts handled</a>
7425
- * </p>
7426
- * </dd>
7427
- * <dt>AVG_HOLD_TIME</dt>
7428
- * <dd>
7429
- * <p>Unit: SECONDS</p>
7430
- * <p>Statistic: AVG</p>
7431
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-customer-hold-time">Average customer hold
7432
- * time</a>
7433
- * </p>
7434
- * </dd>
7435
- * <dt>CALLBACK_CONTACTS_HANDLED</dt>
7436
- * <dd>
7437
- * <p>Unit: COUNT</p>
7438
- * <p>Statistic: SUM</p>
7439
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#callback-contacts-handled">Callback contacts
7440
- * handled</a>
7441
- * </p>
7442
- * </dd>
7443
- * <dt>CONTACTS_ABANDONED</dt>
7444
- * <dd>
7445
- * <p>Unit: COUNT</p>
7446
- * <p>Statistic: SUM</p>
7447
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-abandoned">Contacts abandoned</a>
7448
- * </p>
7449
- * </dd>
7450
- * <dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt>
7451
- * <dd>
7452
- * <p>Unit: COUNT</p>
7453
- * <p>Statistic: SUM</p>
7454
- * <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
7455
- * first</a>
7456
- * </p>
7457
- * </dd>
7458
- * <dt>CONTACTS_CONSULTED</dt>
7459
- * <dd>
7460
- * <p>Unit: COUNT</p>
7461
- * <p>Statistic: SUM</p>
7462
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-consulted">Contacts consulted</a>
7463
- * </p>
7464
- * </dd>
7465
- * <dt>CONTACTS_HANDLED</dt>
7466
- * <dd>
7467
- * <p>Unit: COUNT</p>
7468
- * <p>Statistic: SUM</p>
7469
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled">Contacts handled</a>
7470
- * </p>
7471
- * </dd>
7472
- * <dt>CONTACTS_HANDLED_INCOMING</dt>
7473
- * <dd>
7474
- * <p>Unit: COUNT</p>
7475
- * <p>Statistic: SUM</p>
7476
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-incoming">Contacts handled
7477
- * incoming</a>
7478
- * </p>
7479
- * </dd>
7480
- * <dt>CONTACTS_HANDLED_OUTBOUND</dt>
7481
- * <dd>
7482
- * <p>Unit: COUNT</p>
7483
- * <p>Statistic: SUM</p>
7484
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-handled-outbound">Contacts handled
7485
- * outbound</a>
7486
- * </p>
7487
- * </dd>
7488
- * <dt>CONTACTS_HOLD_ABANDONS</dt>
7489
- * <dd>
7490
- * <p>Unit: COUNT</p>
7491
- * <p>Statistic: SUM</p>
7492
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-hold-disconnect">Contacts hold
7493
- * disconnect</a>
7494
- * </p>
7495
- * </dd>
7496
- * <dt>CONTACTS_MISSED</dt>
7497
- * <dd>
7498
- * <p>Unit: COUNT</p>
7499
- * <p>Statistic: SUM</p>
7500
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#agent-non-response">AGENT_NON_RESPONSE</a>
7501
- * </p>
7502
- * </dd>
7503
- * <dt>CONTACTS_QUEUED</dt>
7504
- * <dd>
7505
- * <p>Unit: COUNT</p>
7506
- * <p>Statistic: SUM</p>
7507
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-queued">Contacts queued</a>
7508
- * </p>
7509
- * </dd>
7510
- * <dt>CONTACTS_TRANSFERRED_IN</dt>
7511
- * <dd>
7512
- * <p>Unit: COUNT</p>
7513
- * <p>Statistic: SUM</p>
7514
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-in">Contacts transferred in</a>
7515
- * </p>
7516
- * </dd>
7517
- * <dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt>
7518
- * <dd>
7519
- * <p>Unit: COUNT</p>
7520
- * <p>Statistic: SUM</p>
7521
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out
7522
- * queue</a>
7523
- * </p>
7524
- * </dd>
7525
- * <dt>CONTACTS_TRANSFERRED_OUT</dt>
7526
- * <dd>
7527
- * <p>Unit: COUNT</p>
7528
- * <p>Statistic: SUM</p>
7529
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out">Contacts transferred
7530
- * out</a>
7531
- * </p>
7532
- * </dd>
7533
- * <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
7534
- * <dd>
7535
- * <p>Unit: COUNT</p>
7536
- * <p>Statistic: SUM</p>
7537
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#contacts-transferred-out-queue">Contacts transferred out
7538
- * queue</a>
7539
- * </p>
7540
- * </dd>
7541
- * <dt>HANDLE_TIME</dt>
7542
- * <dd>
7543
- * <p>Unit: SECONDS</p>
7544
- * <p>Statistic: AVG</p>
7545
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-handle-time">Average handle time</a>
7546
- * </p>
7547
- * </dd>
7548
- * <dt>INTERACTION_AND_HOLD_TIME</dt>
7549
- * <dd>
7550
- * <p>Unit: SECONDS</p>
7551
- * <p>Statistic: AVG</p>
7552
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-agent-interaction-and-customer-hold-time">Average
7553
- * agent interaction and customer hold time</a>
7554
- * </p>
7555
- * </dd>
7556
- * <dt>INTERACTION_TIME</dt>
7557
- * <dd>
7558
- * <p>Unit: SECONDS</p>
7559
- * <p>Statistic: AVG</p>
7560
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#aaverage-agent-interaction-time">Average agent
7561
- * interaction time</a>
7562
- * </p>
7563
- * </dd>
7564
- * <dt>OCCUPANCY</dt>
7565
- * <dd>
7566
- * <p>Unit: PERCENT</p>
7567
- * <p>Statistic: AVG</p>
7568
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#occupancy">Occupancy</a>
7569
- * </p>
7570
- * </dd>
7571
- * <dt>QUEUE_ANSWER_TIME</dt>
7572
- * <dd>
7573
- * <p>Unit: SECONDS</p>
7574
- * <p>Statistic: AVG</p>
7575
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html##average-queue-answer-time">Average queue answer
7576
- * time</a>
7577
- * </p>
7578
- * </dd>
7579
- * <dt>QUEUED_TIME</dt>
7580
- * <dd>
7581
- * <p>Unit: SECONDS</p>
7582
- * <p>Statistic: MAX</p>
7583
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#minimum-flow-time">Minimum flow time</a>
7584
- * </p>
7585
- * </dd>
7586
- * <dt>SERVICE_LEVEL</dt>
7587
- * <dd>
7588
- * <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
7589
- * <p>Unit: PERCENT</p>
7590
- * <p>Statistic: AVG</p>
7591
- * <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800 (inclusive), in seconds.
7592
- * For <code>Comparison</code>, you must enter <code>LT</code> (for "Less than"). </p>
7593
- * <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-definitions.html#average-queue-abandon-time">Average queue abandon
7594
- * time</a>
7595
- * </p>
7596
- * </dd>
7597
- * </dl>
7598
- * @public
7599
- */
7600
- HistoricalMetrics: HistoricalMetric[] | undefined;
7601
- /**
7602
- * <p>The token for the next set of results. Use the value returned in the previous
7603
- * response in the next request to retrieve the next set of results.</p>
7604
- * @public
7605
- */
7606
- NextToken?: string | undefined;
7607
- /**
7608
- * <p>The maximum number of results to return per page.</p>
7609
- * @public
7610
- */
7611
- MaxResults?: number | undefined;
7612
- }
7613
- /**
7614
- * <p>Contains the data for a historical metric.</p>
7615
- * @public
7616
- */
7617
- export interface HistoricalMetricData {
7618
- /**
7619
- * <p>Information about the metric.</p>
7620
- * @public
7621
- */
7622
- Metric?: HistoricalMetric | undefined;
7623
- /**
7624
- * <p>The value of the metric.</p>
7625
- * @public
7626
- */
7627
- Value?: number | undefined;
7628
- }
7629
- /**
7630
- * <p>Contains information about the historical metrics retrieved.</p>
7631
- * @public
7632
- */
7633
- export interface HistoricalMetricResult {
7634
- /**
7635
- * <p>The dimension for the metrics.</p>
7636
- * @public
7637
- */
7638
- Dimensions?: Dimensions | undefined;
7639
- /**
7640
- * <p>The set of metrics.</p>
7641
- * @public
7642
- */
7643
- Collections?: HistoricalMetricData[] | undefined;
7644
- }