@aws-sdk/client-connect 3.282.0 → 3.288.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 (131) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/Connect.js +15 -0
  3. package/dist-cjs/commands/GetMetricDataV2Command.js +46 -0
  4. package/dist-cjs/commands/ListContactFlowModulesCommand.js +3 -3
  5. package/dist-cjs/commands/ListContactFlowsCommand.js +3 -3
  6. package/dist-cjs/commands/ListContactReferencesCommand.js +1 -2
  7. package/dist-cjs/commands/index.js +1 -0
  8. package/dist-cjs/models/models_0.js +37 -38
  9. package/dist-cjs/models/models_1.js +38 -5
  10. package/dist-cjs/pagination/GetCurrentMetricDataPaginator.js +1 -8
  11. package/dist-cjs/pagination/GetCurrentUserDataPaginator.js +1 -8
  12. package/dist-cjs/pagination/GetMetricDataPaginator.js +1 -8
  13. package/dist-cjs/pagination/GetMetricDataV2Paginator.js +29 -0
  14. package/dist-cjs/pagination/ListAgentStatusesPaginator.js +1 -8
  15. package/dist-cjs/pagination/ListApprovedOriginsPaginator.js +1 -8
  16. package/dist-cjs/pagination/ListBotsPaginator.js +1 -8
  17. package/dist-cjs/pagination/ListContactFlowModulesPaginator.js +1 -8
  18. package/dist-cjs/pagination/ListContactFlowsPaginator.js +1 -8
  19. package/dist-cjs/pagination/ListContactReferencesPaginator.js +1 -8
  20. package/dist-cjs/pagination/ListDefaultVocabulariesPaginator.js +1 -8
  21. package/dist-cjs/pagination/ListHoursOfOperationsPaginator.js +1 -8
  22. package/dist-cjs/pagination/ListInstanceAttributesPaginator.js +1 -8
  23. package/dist-cjs/pagination/ListInstanceStorageConfigsPaginator.js +1 -8
  24. package/dist-cjs/pagination/ListInstancesPaginator.js +1 -8
  25. package/dist-cjs/pagination/ListIntegrationAssociationsPaginator.js +1 -8
  26. package/dist-cjs/pagination/ListLambdaFunctionsPaginator.js +1 -8
  27. package/dist-cjs/pagination/ListLexBotsPaginator.js +1 -8
  28. package/dist-cjs/pagination/ListPhoneNumbersPaginator.js +1 -8
  29. package/dist-cjs/pagination/ListPhoneNumbersV2Paginator.js +1 -8
  30. package/dist-cjs/pagination/ListPromptsPaginator.js +1 -8
  31. package/dist-cjs/pagination/ListQueueQuickConnectsPaginator.js +1 -8
  32. package/dist-cjs/pagination/ListQueuesPaginator.js +1 -8
  33. package/dist-cjs/pagination/ListQuickConnectsPaginator.js +1 -8
  34. package/dist-cjs/pagination/ListRoutingProfileQueuesPaginator.js +1 -8
  35. package/dist-cjs/pagination/ListRoutingProfilesPaginator.js +1 -8
  36. package/dist-cjs/pagination/ListRulesPaginator.js +1 -8
  37. package/dist-cjs/pagination/ListSecurityKeysPaginator.js +1 -8
  38. package/dist-cjs/pagination/ListSecurityProfilePermissionsPaginator.js +1 -8
  39. package/dist-cjs/pagination/ListSecurityProfilesPaginator.js +1 -8
  40. package/dist-cjs/pagination/ListTaskTemplatesPaginator.js +1 -8
  41. package/dist-cjs/pagination/ListTrafficDistributionGroupsPaginator.js +1 -8
  42. package/dist-cjs/pagination/ListUseCasesPaginator.js +1 -8
  43. package/dist-cjs/pagination/ListUserHierarchyGroupsPaginator.js +1 -8
  44. package/dist-cjs/pagination/ListUsersPaginator.js +1 -8
  45. package/dist-cjs/pagination/SearchAvailablePhoneNumbersPaginator.js +1 -8
  46. package/dist-cjs/pagination/SearchQueuesPaginator.js +1 -8
  47. package/dist-cjs/pagination/SearchRoutingProfilesPaginator.js +1 -8
  48. package/dist-cjs/pagination/SearchSecurityProfilesPaginator.js +1 -8
  49. package/dist-cjs/pagination/SearchUsersPaginator.js +1 -8
  50. package/dist-cjs/pagination/SearchVocabulariesPaginator.js +1 -8
  51. package/dist-cjs/pagination/index.js +1 -0
  52. package/dist-cjs/protocols/Aws_restJson1.js +264 -6
  53. package/dist-es/Connect.js +15 -0
  54. package/dist-es/commands/GetMetricDataV2Command.js +42 -0
  55. package/dist-es/commands/ListContactFlowModulesCommand.js +1 -1
  56. package/dist-es/commands/ListContactFlowsCommand.js +1 -1
  57. package/dist-es/commands/ListContactReferencesCommand.js +1 -2
  58. package/dist-es/commands/index.js +1 -0
  59. package/dist-es/models/models_0.js +23 -25
  60. package/dist-es/models/models_1.js +26 -0
  61. package/dist-es/pagination/GetCurrentMetricDataPaginator.js +1 -8
  62. package/dist-es/pagination/GetCurrentUserDataPaginator.js +1 -8
  63. package/dist-es/pagination/GetMetricDataPaginator.js +1 -8
  64. package/dist-es/pagination/GetMetricDataV2Paginator.js +25 -0
  65. package/dist-es/pagination/ListAgentStatusesPaginator.js +1 -8
  66. package/dist-es/pagination/ListApprovedOriginsPaginator.js +1 -8
  67. package/dist-es/pagination/ListBotsPaginator.js +1 -8
  68. package/dist-es/pagination/ListContactFlowModulesPaginator.js +1 -8
  69. package/dist-es/pagination/ListContactFlowsPaginator.js +1 -8
  70. package/dist-es/pagination/ListContactReferencesPaginator.js +1 -8
  71. package/dist-es/pagination/ListDefaultVocabulariesPaginator.js +1 -8
  72. package/dist-es/pagination/ListHoursOfOperationsPaginator.js +1 -8
  73. package/dist-es/pagination/ListInstanceAttributesPaginator.js +1 -8
  74. package/dist-es/pagination/ListInstanceStorageConfigsPaginator.js +1 -8
  75. package/dist-es/pagination/ListInstancesPaginator.js +1 -8
  76. package/dist-es/pagination/ListIntegrationAssociationsPaginator.js +1 -8
  77. package/dist-es/pagination/ListLambdaFunctionsPaginator.js +1 -8
  78. package/dist-es/pagination/ListLexBotsPaginator.js +1 -8
  79. package/dist-es/pagination/ListPhoneNumbersPaginator.js +1 -8
  80. package/dist-es/pagination/ListPhoneNumbersV2Paginator.js +1 -8
  81. package/dist-es/pagination/ListPromptsPaginator.js +1 -8
  82. package/dist-es/pagination/ListQueueQuickConnectsPaginator.js +1 -8
  83. package/dist-es/pagination/ListQueuesPaginator.js +1 -8
  84. package/dist-es/pagination/ListQuickConnectsPaginator.js +1 -8
  85. package/dist-es/pagination/ListRoutingProfileQueuesPaginator.js +1 -8
  86. package/dist-es/pagination/ListRoutingProfilesPaginator.js +1 -8
  87. package/dist-es/pagination/ListRulesPaginator.js +1 -8
  88. package/dist-es/pagination/ListSecurityKeysPaginator.js +1 -8
  89. package/dist-es/pagination/ListSecurityProfilePermissionsPaginator.js +1 -8
  90. package/dist-es/pagination/ListSecurityProfilesPaginator.js +1 -8
  91. package/dist-es/pagination/ListTaskTemplatesPaginator.js +1 -8
  92. package/dist-es/pagination/ListTrafficDistributionGroupsPaginator.js +1 -8
  93. package/dist-es/pagination/ListUseCasesPaginator.js +1 -8
  94. package/dist-es/pagination/ListUserHierarchyGroupsPaginator.js +1 -8
  95. package/dist-es/pagination/ListUsersPaginator.js +1 -8
  96. package/dist-es/pagination/SearchAvailablePhoneNumbersPaginator.js +1 -8
  97. package/dist-es/pagination/SearchQueuesPaginator.js +1 -8
  98. package/dist-es/pagination/SearchRoutingProfilesPaginator.js +1 -8
  99. package/dist-es/pagination/SearchSecurityProfilesPaginator.js +1 -8
  100. package/dist-es/pagination/SearchUsersPaginator.js +1 -8
  101. package/dist-es/pagination/SearchVocabulariesPaginator.js +1 -8
  102. package/dist-es/pagination/index.js +1 -0
  103. package/dist-es/protocols/Aws_restJson1.js +256 -0
  104. package/dist-types/Connect.d.ts +20 -2
  105. package/dist-types/ConnectClient.d.ts +3 -2
  106. package/dist-types/commands/DisassociateBotCommand.d.ts +2 -2
  107. package/dist-types/commands/GetMetricDataV2Command.d.ts +54 -0
  108. package/dist-types/commands/ListContactFlowModulesCommand.d.ts +1 -1
  109. package/dist-types/commands/ListContactFlowsCommand.d.ts +1 -1
  110. package/dist-types/commands/ListContactReferencesCommand.d.ts +1 -2
  111. package/dist-types/commands/index.d.ts +1 -0
  112. package/dist-types/models/models_0.d.ts +387 -153
  113. package/dist-types/models/models_1.d.ts +162 -1
  114. package/dist-types/pagination/GetMetricDataV2Paginator.d.ts +4 -0
  115. package/dist-types/pagination/Interfaces.d.ts +1 -2
  116. package/dist-types/pagination/index.d.ts +1 -0
  117. package/dist-types/protocols/Aws_restJson1.d.ts +3 -0
  118. package/dist-types/ts3.4/Connect.d.ts +17 -0
  119. package/dist-types/ts3.4/ConnectClient.d.ts +6 -0
  120. package/dist-types/ts3.4/commands/GetMetricDataV2Command.d.ts +37 -0
  121. package/dist-types/ts3.4/commands/ListContactFlowModulesCommand.d.ts +1 -1
  122. package/dist-types/ts3.4/commands/ListContactFlowsCommand.d.ts +1 -1
  123. package/dist-types/ts3.4/commands/ListContactReferencesCommand.d.ts +4 -2
  124. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  125. package/dist-types/ts3.4/models/models_0.d.ts +55 -64
  126. package/dist-types/ts3.4/models/models_1.d.ts +66 -1
  127. package/dist-types/ts3.4/pagination/GetMetricDataV2Paginator.d.ts +11 -0
  128. package/dist-types/ts3.4/pagination/Interfaces.d.ts +1 -2
  129. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  130. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  131. package/package.json +9 -9
@@ -4674,6 +4674,369 @@ export interface GetMetricDataResponse {
4674
4674
  */
4675
4675
  MetricResults?: HistoricalMetricResult[];
4676
4676
  }
4677
+ /**
4678
+ * <p>Contains the filter to apply when retrieving metrics with the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html">GetMetricDataV2</a> API.</p>
4679
+ */
4680
+ export interface FilterV2 {
4681
+ /**
4682
+ * <p>The key to use for filtering data. For example, <code>QUEUE</code>, <code>ROUTING_PROFILE,
4683
+ * AGENT</code>, <code>CHANNEL</code>, <code>AGENT_HIERARCHY_LEVEL_ONE</code>,
4684
+ * <code>AGENT_HIERARCHY_LEVEL_TWO</code>, <code>AGENT_HIERARCHY_LEVEL_THREE</code>,
4685
+ * <code>AGENT_HIERARCHY_LEVEL_FOUR</code>, <code>AGENT_HIERARCHY_LEVEL_FIVE</code>. There must be
4686
+ * at least 1 key and a maximum 5 keys. </p>
4687
+ */
4688
+ FilterKey?: string;
4689
+ /**
4690
+ * <p>The identifiers to use for filtering data. For example, if you have a filter key of
4691
+ * <code>QUEUE</code>, you would add queue IDs or ARNs in <code>FilterValues</code>. </p>
4692
+ */
4693
+ FilterValues?: string[];
4694
+ }
4695
+ /**
4696
+ * <p>Contains information about the filter used when retrieving metrics.
4697
+ * <code>MetricFiltersV2</code> can be used on the following metrics:
4698
+ * <code>AVG_AGENT_CONNECTING_TIME</code>, <code>CONTACTS_CREATED</code>,
4699
+ * <code>CONTACTS_HANDLED</code>, <code>SUM_CONTACTS_DISCONNECTED</code>.</p>
4700
+ */
4701
+ export interface MetricFilterV2 {
4702
+ /**
4703
+ * <p>The key to use for filtering data. </p>
4704
+ * <p>Valid metric filter keys: <code>INITIATION_METHOD</code>,
4705
+ * <code>DISCONNECT_REASON</code>
4706
+ * </p>
4707
+ */
4708
+ MetricFilterKey?: string;
4709
+ /**
4710
+ * <p>The values to use for filtering data. </p>
4711
+ * <p>Valid metric filter values for <code>INITIATION_METHOD</code>: <code>INBOUND</code> |
4712
+ * <code>OUTBOUND</code> | <code>TRANSFER</code> | <code>QUEUE_TRANSFER</code> |
4713
+ * <code>CALLBACK</code> | <code>API</code>
4714
+ * </p>
4715
+ * <p>Valid metric filter values for <code>DISCONNECT_REASON</code>:
4716
+ * <code>CUSTOMER_DISCONNECT</code> | <code>AGENT_DISCONNECT</code> |
4717
+ * <code>THIRD_PARTY_DISCONNECT</code> | <code>TELECOM_PROBLEM</code> | <code>BARGED</code> |
4718
+ * <code>CONTACT_FLOW_DISCONNECT</code> | <code>OTHER</code> | <code>EXPIRED</code> |
4719
+ * <code>API</code>
4720
+ * </p>
4721
+ */
4722
+ MetricFilterValues?: string[];
4723
+ }
4724
+ /**
4725
+ * <p>Contains information about the threshold for service level metrics.</p>
4726
+ */
4727
+ export interface ThresholdV2 {
4728
+ /**
4729
+ * <p>The type of comparison. Only "less than" (LT) comparisons are supported.</p>
4730
+ */
4731
+ Comparison?: string;
4732
+ /**
4733
+ * <p>The threshold value to compare.</p>
4734
+ */
4735
+ ThresholdValue?: number;
4736
+ }
4737
+ /**
4738
+ * <p>Contains information about the metric.</p>
4739
+ */
4740
+ export interface MetricV2 {
4741
+ /**
4742
+ * <p>The name of the metric.</p>
4743
+ */
4744
+ Name?: string;
4745
+ /**
4746
+ * <p>Contains information about the threshold for service level metrics.</p>
4747
+ */
4748
+ Threshold?: ThresholdV2[];
4749
+ /**
4750
+ * <p>Contains the filters to be used when returning data.</p>
4751
+ */
4752
+ MetricFilters?: MetricFilterV2[];
4753
+ }
4754
+ export interface GetMetricDataV2Request {
4755
+ /**
4756
+ * <p>The Amazon Resource Name (ARN) of the resource. This includes the <code>instanceId</code> an Amazon Connect
4757
+ * instance.</p>
4758
+ */
4759
+ ResourceArn: string | undefined;
4760
+ /**
4761
+ * <p>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
4762
+ * retrieval of historical metrics data. The time must be before the end time timestamp. The time
4763
+ * range between the start and end time must be less than 24 hours. The start time cannot be earlier
4764
+ * than 14 days before the time of the request. Historical metrics are available for 14 days.</p>
4765
+ */
4766
+ StartTime: Date | undefined;
4767
+ /**
4768
+ * <p>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the
4769
+ * retrieval of historical metrics data. The time must be later than the start time
4770
+ * timestamp.</p>
4771
+ * <p>The time range between the start and end time must be less than 24 hours.</p>
4772
+ */
4773
+ EndTime: Date | undefined;
4774
+ /**
4775
+ * <p>The filters to apply to returned metrics. You can filter on the following resources:</p>
4776
+ * <ul>
4777
+ * <li>
4778
+ * <p>Queues</p>
4779
+ * </li>
4780
+ * <li>
4781
+ * <p>Routing profiles</p>
4782
+ * </li>
4783
+ * <li>
4784
+ * <p>Agents</p>
4785
+ * </li>
4786
+ * <li>
4787
+ * <p>Channels</p>
4788
+ * </li>
4789
+ * <li>
4790
+ * <p>User hierarchy groups</p>
4791
+ * </li>
4792
+ * </ul>
4793
+ * <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
4794
+ * groups.</p>
4795
+ * <p>To filter by phone number, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html">Create a historical
4796
+ * metrics report</a> in the <i>Amazon Connect Administrator's
4797
+ * Guide</i>.</p>
4798
+ * <p>Note the following limits:</p>
4799
+ * <ul>
4800
+ * <li>
4801
+ * <p>
4802
+ * <b>Filter keys</b>: A maximum of 5 filter keys are supported in
4803
+ * a single request. Valid filter keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> |
4804
+ * <code>AGENT</code> | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
4805
+ * <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
4806
+ * <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code>
4807
+ * </p>
4808
+ * </li>
4809
+ * <li>
4810
+ * <p>
4811
+ * <b>Filter values</b>: A maximum of 100 filter values are
4812
+ * supported in a single request. For example, a <code>GetMetricDataV2</code> request can filter
4813
+ * by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values.
4814
+ * <code>VOICE</code>, <code>CHAT</code>, and <code>TASK</code> are valid
4815
+ * <code>filterValue</code> for the <code>CHANNEL</code> filter key.</p>
4816
+ * </li>
4817
+ * </ul>
4818
+ */
4819
+ Filters: FilterV2[] | undefined;
4820
+ /**
4821
+ * <p>The grouping applied to the metrics that are returned. For example, when results are grouped
4822
+ * by queue, the metrics returned are grouped by queue. The values that are returned apply to the
4823
+ * metrics for each queue. They are not aggregated for all queues.</p>
4824
+ * <p>If no grouping is specified, a summary of all metrics is returned.</p>
4825
+ * <p>Valid grouping keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> | <code>AGENT</code>
4826
+ * | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
4827
+ * <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
4828
+ * <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code>
4829
+ * </p>
4830
+ */
4831
+ Groupings?: string[];
4832
+ /**
4833
+ * <p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The
4834
+ * following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics definitions</a> in the <i>Amazon Connect Administrator's
4835
+ * Guide</i>.</p>
4836
+ * <dl>
4837
+ * <dt>AGENT_ADHERENT_TIME</dt>
4838
+ * <dd>
4839
+ * <p>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</p>
4840
+ * <p>Unit: Seconds</p>
4841
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p>
4842
+ * </dd>
4843
+ * <dt>AGENT_NON_RESPONSE</dt>
4844
+ * <dd>
4845
+ * <p>Unit: Count</p>
4846
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </p>
4847
+ * </dd>
4848
+ * <dt>AGENT_OCCUPANCY</dt>
4849
+ * <dd>
4850
+ * <p>Unit: Percentage</p>
4851
+ * <p>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy </p>
4852
+ * </dd>
4853
+ * <dt>AGENT_SCHEDULE_ADHERENCE</dt>
4854
+ * <dd>
4855
+ * <p>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</p>
4856
+ * <p>Unit: Percent</p>
4857
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4858
+ * </dd>
4859
+ * <dt>AGENT_SCHEDULED_TIME</dt>
4860
+ * <dd>
4861
+ * <p>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</p>
4862
+ * <p>Unit: Seconds</p>
4863
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4864
+ * </dd>
4865
+ * <dt>AVG_ABANDON_TIME</dt>
4866
+ * <dd>
4867
+ * <p>Unit: Seconds</p>
4868
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4869
+ * </dd>
4870
+ * <dt>AVG_AFTER_CONTACT_WORK_TIME</dt>
4871
+ * <dd>
4872
+ * <p>Unit: Seconds</p>
4873
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4874
+ * </dd>
4875
+ * <dt>AVG_AGENT_CONNECTING_TIME</dt>
4876
+ * <dd>
4877
+ * <p>Unit: Seconds</p>
4878
+ * <p>Valid metric filter key: <code>INITIATION_METHOD</code>. For now, this metric only
4879
+ * supports the following as <code>INITIATION_METHOD</code>: <code>INBOUND</code> |
4880
+ * <code>OUTBOUND</code> | <code>CALLBACK</code> | <code>API</code>
4881
+ * </p>
4882
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4883
+ * </dd>
4884
+ * <dt>AVG_HANDLE_TIME</dt>
4885
+ * <dd>
4886
+ * <p>Unit: Seconds</p>
4887
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4888
+ * </dd>
4889
+ * <dt>AVG_HOLD_TIME</dt>
4890
+ * <dd>
4891
+ * <p>Unit: Seconds</p>
4892
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4893
+ * </dd>
4894
+ * <dt>AVG_INTERACTION_AND_HOLD_TIME</dt>
4895
+ * <dd>
4896
+ * <p>Unit: Seconds</p>
4897
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4898
+ * </dd>
4899
+ * <dt>AVG_INTERACTION_TIME</dt>
4900
+ * <dd>
4901
+ * <p>Unit: Seconds</p>
4902
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
4903
+ * </dd>
4904
+ * <dt>AVG_QUEUE_ANSWER_TIME</dt>
4905
+ * <dd>
4906
+ * <p>Unit: Seconds</p>
4907
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
4908
+ * </dd>
4909
+ * <dt>CONTACTS_ABANDONED</dt>
4910
+ * <dd>
4911
+ * <p>Unit: Count</p>
4912
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4913
+ * </dd>
4914
+ * <dt>CONTACTS_CREATED</dt>
4915
+ * <dd>
4916
+ * <p>Unit: Count</p>
4917
+ * <p>Valid metric filter key: <code>INITIATION_METHOD</code>
4918
+ * </p>
4919
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
4920
+ * </dd>
4921
+ * <dt>CONTACTS_HANDLED</dt>
4922
+ * <dd>
4923
+ * <p>Unit: Count</p>
4924
+ * <p>Valid metric filter key: <code>INITIATION_METHOD</code>,
4925
+ * <code>DISCONNECT_REASON</code>
4926
+ * </p>
4927
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4928
+ * </dd>
4929
+ * <dt>CONTACTS_HOLD_ABANDONS</dt>
4930
+ * <dd>
4931
+ * <p>Unit: Count</p>
4932
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4933
+ * </dd>
4934
+ * <dt>CONTACTS_QUEUED</dt>
4935
+ * <dd>
4936
+ * <p>Unit: Count</p>
4937
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4938
+ * </dd>
4939
+ * <dt>CONTACTS_TRANSFERRED_OUT</dt>
4940
+ * <dd>
4941
+ * <p>Unit: Count</p>
4942
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4943
+ * </dd>
4944
+ * <dt>CONTACTS_TRANSFERRED_OUT_BY_AGENT</dt>
4945
+ * <dd>
4946
+ * <p>Unit: Count</p>
4947
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4948
+ * </dd>
4949
+ * <dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt>
4950
+ * <dd>
4951
+ * <p>Unit: Count</p>
4952
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4953
+ * </dd>
4954
+ * <dt>MAX_QUEUED_TIME</dt>
4955
+ * <dd>
4956
+ * <p>Unit: Seconds</p>
4957
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</p>
4958
+ * </dd>
4959
+ * <dt>SERVICE_LEVEL</dt>
4960
+ * <dd>
4961
+ * <p>You can include up to 20 SERVICE_LEVEL metrics in a request.</p>
4962
+ * <p>Unit: Percent</p>
4963
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
4964
+ * <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
4965
+ * (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
4966
+ * "Less than"). </p>
4967
+ * </dd>
4968
+ * <dt>SUM_CONTACTS_ANSWERED_IN_X</dt>
4969
+ * <dd>
4970
+ * <p>Unit: Count</p>
4971
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
4972
+ * </dd>
4973
+ * <dt>SUM_CONTACTS_ABANDONED_IN_X</dt>
4974
+ * <dd>
4975
+ * <p>Unit: Count</p>
4976
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
4977
+ * </dd>
4978
+ * <dt>SUM_CONTACTS_DISCONNECTED </dt>
4979
+ * <dd>
4980
+ * <p>Valid metric filter key: <code>DISCONNECT_REASON</code>
4981
+ * </p>
4982
+ * <p>Unit: Count</p>
4983
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
4984
+ * </dd>
4985
+ * <dt>SUM_RETRY_CALLBACK_ATTEMPTS</dt>
4986
+ * <dd>
4987
+ * <p>Unit: Count</p>
4988
+ * <p>Valid groupings and filters: Queue, Channel, Routing Profile</p>
4989
+ * </dd>
4990
+ * </dl>
4991
+ */
4992
+ Metrics: MetricV2[] | undefined;
4993
+ /**
4994
+ * <p>The token for the next set of results. Use the value returned in the previous
4995
+ * response in the next request to retrieve the next set of results.</p>
4996
+ */
4997
+ NextToken?: string;
4998
+ /**
4999
+ * <p>The maximum number of results to return per page.</p>
5000
+ */
5001
+ MaxResults?: number;
5002
+ }
5003
+ /**
5004
+ * <p>Contains the name, thresholds, and metric filters.</p>
5005
+ */
5006
+ export interface MetricDataV2 {
5007
+ /**
5008
+ * <p>The metric name, thresholds, and metric filters of the returned metric.</p>
5009
+ */
5010
+ Metric?: MetricV2;
5011
+ /**
5012
+ * <p>The corresponding value of the metric returned in the response.</p>
5013
+ */
5014
+ Value?: number;
5015
+ }
5016
+ /**
5017
+ * <p>Contains information about the metric results.</p>
5018
+ */
5019
+ export interface MetricResultV2 {
5020
+ /**
5021
+ * <p>The dimension for the metrics.</p>
5022
+ */
5023
+ Dimensions?: Record<string, string>;
5024
+ /**
5025
+ * <p>The set of metrics.</p>
5026
+ */
5027
+ Collections?: MetricDataV2[];
5028
+ }
5029
+ export interface GetMetricDataV2Response {
5030
+ /**
5031
+ * <p>If there are additional results, this is the token for the next set of results.</p>
5032
+ */
5033
+ NextToken?: string;
5034
+ /**
5035
+ * <p>Information about the metrics requested in the API request If no grouping is specified, a
5036
+ * summary of metric data is returned. </p>
5037
+ */
5038
+ MetricResults?: MetricResultV2[];
5039
+ }
4677
5040
  export interface GetTaskTemplateRequest {
4678
5041
  /**
4679
5042
  * <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>
@@ -4890,139 +5253,6 @@ export interface ListBotsResponse {
4890
5253
  */
4891
5254
  NextToken?: string;
4892
5255
  }
4893
- export interface ListContactFlowModulesRequest {
4894
- /**
4895
- * <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>
4896
- */
4897
- InstanceId: string | undefined;
4898
- /**
4899
- * <p>The token for the next set of results. Use the value returned in the previous
4900
- * response in the next request to retrieve the next set of results.</p>
4901
- */
4902
- NextToken?: string;
4903
- /**
4904
- * <p>The maximum number of results to return per page.</p>
4905
- */
4906
- MaxResults?: number;
4907
- /**
4908
- * <p>The state of the flow module.</p>
4909
- */
4910
- ContactFlowModuleState?: ContactFlowModuleState | string;
4911
- }
4912
- /**
4913
- * <p>Contains summary information about a flow.</p>
4914
- */
4915
- export interface ContactFlowModuleSummary {
4916
- /**
4917
- * <p>The identifier of the flow module.</p>
4918
- */
4919
- Id?: string;
4920
- /**
4921
- * <p>The Amazon Resource Name (ARN) of the flow module.</p>
4922
- */
4923
- Arn?: string;
4924
- /**
4925
- * <p>The name of the flow module.</p>
4926
- */
4927
- Name?: string;
4928
- /**
4929
- * <p>The type of flow module.</p>
4930
- */
4931
- State?: ContactFlowModuleState | string;
4932
- }
4933
- export interface ListContactFlowModulesResponse {
4934
- /**
4935
- * <p>Information about the flow module.</p>
4936
- */
4937
- ContactFlowModulesSummaryList?: ContactFlowModuleSummary[];
4938
- /**
4939
- * <p>If there are additional results, this is the token for the next set of results.</p>
4940
- */
4941
- NextToken?: string;
4942
- }
4943
- export interface ListContactFlowsRequest {
4944
- /**
4945
- * <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>
4946
- */
4947
- InstanceId: string | undefined;
4948
- /**
4949
- * <p>The type of flow.</p>
4950
- */
4951
- ContactFlowTypes?: (ContactFlowType | string)[];
4952
- /**
4953
- * <p>The token for the next set of results. Use the value returned in the previous
4954
- * response in the next request to retrieve the next set of results.</p>
4955
- */
4956
- NextToken?: string;
4957
- /**
4958
- * <p>The maximum number of results to return per page. The default MaxResult size is 100.</p>
4959
- */
4960
- MaxResults?: number;
4961
- }
4962
- /**
4963
- * <p>Contains summary information about a flow.</p>
4964
- * <p>You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect
4965
- * Flow language</a>.</p>
4966
- */
4967
- export interface ContactFlowSummary {
4968
- /**
4969
- * <p>The identifier of the flow.</p>
4970
- */
4971
- Id?: string;
4972
- /**
4973
- * <p>The Amazon Resource Name (ARN) of the flow.</p>
4974
- */
4975
- Arn?: string;
4976
- /**
4977
- * <p>The name of the flow.</p>
4978
- */
4979
- Name?: string;
4980
- /**
4981
- * <p>The type of flow.</p>
4982
- */
4983
- ContactFlowType?: ContactFlowType | string;
4984
- /**
4985
- * <p>The type of flow.</p>
4986
- */
4987
- ContactFlowState?: ContactFlowState | string;
4988
- }
4989
- export interface ListContactFlowsResponse {
4990
- /**
4991
- * <p>Information about the flows.</p>
4992
- */
4993
- ContactFlowSummaryList?: ContactFlowSummary[];
4994
- /**
4995
- * <p>If there are additional results, this is the token for the next set of results.</p>
4996
- */
4997
- NextToken?: string;
4998
- }
4999
- export interface ListContactReferencesRequest {
5000
- /**
5001
- * <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>
5002
- */
5003
- InstanceId: string | undefined;
5004
- /**
5005
- * <p>The identifier of the initial contact.</p>
5006
- */
5007
- ContactId: string | undefined;
5008
- /**
5009
- * <p>The type of reference.</p>
5010
- */
5011
- ReferenceTypes: (ReferenceType | string)[] | undefined;
5012
- /**
5013
- * <p>The token for the next set of results. Use the value returned in the previous
5014
- * response in the next request to retrieve the next set of results.</p>
5015
- * <important>
5016
- * <p>This is not expected to be set, because the value returned in the previous response is
5017
- * always null.</p>
5018
- * </important>
5019
- */
5020
- NextToken?: string;
5021
- }
5022
- export declare enum ReferenceStatus {
5023
- APPROVED = "APPROVED",
5024
- REJECTED = "REJECTED"
5025
- }
5026
5256
  /**
5027
5257
  * @internal
5028
5258
  */
@@ -5882,80 +6112,84 @@ export declare const GetMetricDataResponseFilterSensitiveLog: (obj: GetMetricDat
5882
6112
  /**
5883
6113
  * @internal
5884
6114
  */
5885
- export declare const GetTaskTemplateRequestFilterSensitiveLog: (obj: GetTaskTemplateRequest) => any;
6115
+ export declare const FilterV2FilterSensitiveLog: (obj: FilterV2) => any;
5886
6116
  /**
5887
6117
  * @internal
5888
6118
  */
5889
- export declare const GetTaskTemplateResponseFilterSensitiveLog: (obj: GetTaskTemplateResponse) => any;
6119
+ export declare const MetricFilterV2FilterSensitiveLog: (obj: MetricFilterV2) => any;
5890
6120
  /**
5891
6121
  * @internal
5892
6122
  */
5893
- export declare const GetTrafficDistributionRequestFilterSensitiveLog: (obj: GetTrafficDistributionRequest) => any;
6123
+ export declare const ThresholdV2FilterSensitiveLog: (obj: ThresholdV2) => any;
5894
6124
  /**
5895
6125
  * @internal
5896
6126
  */
5897
- export declare const DistributionFilterSensitiveLog: (obj: Distribution) => any;
6127
+ export declare const MetricV2FilterSensitiveLog: (obj: MetricV2) => any;
5898
6128
  /**
5899
6129
  * @internal
5900
6130
  */
5901
- export declare const TelephonyConfigFilterSensitiveLog: (obj: TelephonyConfig) => any;
6131
+ export declare const GetMetricDataV2RequestFilterSensitiveLog: (obj: GetMetricDataV2Request) => any;
5902
6132
  /**
5903
6133
  * @internal
5904
6134
  */
5905
- export declare const GetTrafficDistributionResponseFilterSensitiveLog: (obj: GetTrafficDistributionResponse) => any;
6135
+ export declare const MetricDataV2FilterSensitiveLog: (obj: MetricDataV2) => any;
5906
6136
  /**
5907
6137
  * @internal
5908
6138
  */
5909
- export declare const ListAgentStatusRequestFilterSensitiveLog: (obj: ListAgentStatusRequest) => any;
6139
+ export declare const MetricResultV2FilterSensitiveLog: (obj: MetricResultV2) => any;
5910
6140
  /**
5911
6141
  * @internal
5912
6142
  */
5913
- export declare const ListAgentStatusResponseFilterSensitiveLog: (obj: ListAgentStatusResponse) => any;
6143
+ export declare const GetMetricDataV2ResponseFilterSensitiveLog: (obj: GetMetricDataV2Response) => any;
5914
6144
  /**
5915
6145
  * @internal
5916
6146
  */
5917
- export declare const ListApprovedOriginsRequestFilterSensitiveLog: (obj: ListApprovedOriginsRequest) => any;
6147
+ export declare const GetTaskTemplateRequestFilterSensitiveLog: (obj: GetTaskTemplateRequest) => any;
5918
6148
  /**
5919
6149
  * @internal
5920
6150
  */
5921
- export declare const ListApprovedOriginsResponseFilterSensitiveLog: (obj: ListApprovedOriginsResponse) => any;
6151
+ export declare const GetTaskTemplateResponseFilterSensitiveLog: (obj: GetTaskTemplateResponse) => any;
5922
6152
  /**
5923
6153
  * @internal
5924
6154
  */
5925
- export declare const ListBotsRequestFilterSensitiveLog: (obj: ListBotsRequest) => any;
6155
+ export declare const GetTrafficDistributionRequestFilterSensitiveLog: (obj: GetTrafficDistributionRequest) => any;
5926
6156
  /**
5927
6157
  * @internal
5928
6158
  */
5929
- export declare const LexBotConfigFilterSensitiveLog: (obj: LexBotConfig) => any;
6159
+ export declare const DistributionFilterSensitiveLog: (obj: Distribution) => any;
5930
6160
  /**
5931
6161
  * @internal
5932
6162
  */
5933
- export declare const ListBotsResponseFilterSensitiveLog: (obj: ListBotsResponse) => any;
6163
+ export declare const TelephonyConfigFilterSensitiveLog: (obj: TelephonyConfig) => any;
6164
+ /**
6165
+ * @internal
6166
+ */
6167
+ export declare const GetTrafficDistributionResponseFilterSensitiveLog: (obj: GetTrafficDistributionResponse) => any;
5934
6168
  /**
5935
6169
  * @internal
5936
6170
  */
5937
- export declare const ListContactFlowModulesRequestFilterSensitiveLog: (obj: ListContactFlowModulesRequest) => any;
6171
+ export declare const ListAgentStatusRequestFilterSensitiveLog: (obj: ListAgentStatusRequest) => any;
5938
6172
  /**
5939
6173
  * @internal
5940
6174
  */
5941
- export declare const ContactFlowModuleSummaryFilterSensitiveLog: (obj: ContactFlowModuleSummary) => any;
6175
+ export declare const ListAgentStatusResponseFilterSensitiveLog: (obj: ListAgentStatusResponse) => any;
5942
6176
  /**
5943
6177
  * @internal
5944
6178
  */
5945
- export declare const ListContactFlowModulesResponseFilterSensitiveLog: (obj: ListContactFlowModulesResponse) => any;
6179
+ export declare const ListApprovedOriginsRequestFilterSensitiveLog: (obj: ListApprovedOriginsRequest) => any;
5946
6180
  /**
5947
6181
  * @internal
5948
6182
  */
5949
- export declare const ListContactFlowsRequestFilterSensitiveLog: (obj: ListContactFlowsRequest) => any;
6183
+ export declare const ListApprovedOriginsResponseFilterSensitiveLog: (obj: ListApprovedOriginsResponse) => any;
5950
6184
  /**
5951
6185
  * @internal
5952
6186
  */
5953
- export declare const ContactFlowSummaryFilterSensitiveLog: (obj: ContactFlowSummary) => any;
6187
+ export declare const ListBotsRequestFilterSensitiveLog: (obj: ListBotsRequest) => any;
5954
6188
  /**
5955
6189
  * @internal
5956
6190
  */
5957
- export declare const ListContactFlowsResponseFilterSensitiveLog: (obj: ListContactFlowsResponse) => any;
6191
+ export declare const LexBotConfigFilterSensitiveLog: (obj: LexBotConfig) => any;
5958
6192
  /**
5959
6193
  * @internal
5960
6194
  */
5961
- export declare const ListContactReferencesRequestFilterSensitiveLog: (obj: ListContactReferencesRequest) => any;
6195
+ export declare const ListBotsResponseFilterSensitiveLog: (obj: ListBotsResponse) => any;