docs(client-connect): Adding Contact Flow metrics to the GetMetricDat…

…aV2 API
aws · May 16, 2024 · bd7756b · bd7756b
1 parent 12647db
commit bd7756b
Show file tree

Hide file tree

Showing 5 changed files with 128 additions and 56 deletions.
diff --git a/clients/client-connect/src/commands/CreatePromptCommand.ts b/clients/client-connect/src/commands/CreatePromptCommand.ts
@@ -28,7 +28,7 @@ export interface CreatePromptCommandOutput extends CreatePromptResponse, __Metad
 
 /**
  * <p>Creates a prompt. For more information about prompts, such as supported file types and
- *    maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator's
+ *    maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator
  *    Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-connect/src/commands/GetMetricDataV2Command.ts b/clients/client-connect/src/commands/GetMetricDataV2Command.ts
@@ -35,7 +35,7 @@ export interface GetMetricDataV2CommandOutput extends GetMetricDataV2Response, _
  *    hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. </p>
  *          <p>For a description of the historical metrics that are supported by
  *     <code>GetMetricDataV2</code> and <code>GetMetricData</code>, 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 Guide</i>.</p>
+ *     definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts
@@ -2474,7 +2474,7 @@ export interface CreateContactFlowRequest {
 
   /**
    * <p>Indicates the flow status as either <code>SAVED</code> or <code>PUBLISHED</code>. The
-   *     <code>PUBLISHED</code> status will initiate validation on the content. the <code>SAVED</code>
+   *    <code>PUBLISHED</code> status will initiate validation on the content. the <code>SAVED</code>
    *    status does not initiate validation of the content. <code>SAVED</code> |
    *    <code>PUBLISHED</code>.</p>
    * @public

diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts
@@ -3942,8 +3942,8 @@ export interface MetricFilterV2 {
    * <p>The key to use for filtering data. </p>
    *          <p>Valid metric filter keys: <code>INITIATION_METHOD</code>, <code>DISCONNECT_REASON</code>.
    *    These are the same values as the <code>InitiationMethod</code> and <code>DisconnectReason</code>
-   *    in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator's
-   *    Guide</i>. </p>
+   *    in the contact record. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord">ContactTraceRecord</a> in the <i>Amazon Connect Administrator Guide</i>.
+   *   </p>
    * @public
    */
   MetricFilterKey?: string;
@@ -4106,45 +4106,49 @@ export interface GetMetricDataV2Request {
    * <p>The filters to apply to returned metrics. You can filter on the following resources:</p>
    *          <ul>
    *             <li>
-   *                <p>Queues</p>
+   *                <p>Agents</p>
    *             </li>
    *             <li>
-   *                <p>Routing profiles</p>
+   *                <p>Channels</p>
    *             </li>
    *             <li>
-   *                <p>Agents</p>
+   *                <p>Feature</p>
    *             </li>
    *             <li>
-   *                <p>Channels</p>
+   *                <p>Queues</p>
    *             </li>
    *             <li>
-   *                <p>User hierarchy groups</p>
+   *                <p>Routing profiles</p>
    *             </li>
    *             <li>
-   *                <p>Feature</p>
+   *                <p>Routing step expression</p>
    *             </li>
    *             <li>
-   *                <p>Routing step expression</p>
+   *                <p>User hierarchy groups</p>
    *             </li>
    *          </ul>
    *          <p>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy
    *    groups.</p>
    *          <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
-   *     metrics report</a> in the <i>Amazon Connect Administrator's
+   *     metrics report</a> in the <i>Amazon Connect Administrator
    *    Guide</i>.</p>
    *          <p>Note the following limits:</p>
    *          <ul>
    *             <li>
    *                <p>
    *                   <b>Filter keys</b>: A maximum of 5 filter keys are supported in
-   *      a single request. Valid filter keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> |
-   *       <code>AGENT</code> | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
-   *       <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
-   *       <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
-   *       <code>FEATURE</code> | <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> |
-   *       <code>contact/segmentAttributes/connect:Subtype</code> | <code>ROUTING_STEP_EXPRESSION</code>
-   *      | <code>Q_CONNECT_ENABLED</code>
-   *                </p>
+   *      a single request. Valid filter keys: <code>AGENT</code> |
+   *       <code>AGENT_HIERARCHY_LEVEL_ONE</code> | <code>AGENT_HIERARCHY_LEVEL_TWO</code> |
+   *       <code>AGENT_HIERARCHY_LEVEL_THREE</code> | <code>AGENT_HIERARCHY_LEVEL_FOUR</code> |
+   *       <code>AGENT_HIERARCHY_LEVEL_FIVE</code> | <code>CASE_TEMPLATE_ARN</code> |
+   *       <code>CASE_STATUS</code> | <code>CHANNEL</code> |
+   *       <code>contact/segmentAttributes/connect:Subtype</code> | <code>FEATURE</code> |
+   *       <code>FLOW_TYPE</code> | <code>FLOWS_NEXT_RESOURCE_ID</code> |
+   *       <code>FLOWS_NEXT_RESOURCE_QUEUE_ID</code> | <code>FLOWS_OUTCOME_TYPE</code> |
+   *       <code>FLOWS_RESOURCE_ID</code> | <code>INITIATION_METHOD</code> |
+   *       <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> |
+   *       <code>ROUTING_STEP_EXPRESSION</code> | <code>QUEUE</code> | <code>Q_CONNECT_ENABLED</code> |
+   *     </p>
    *             </li>
    *             <li>
    *                <p>
@@ -4188,21 +4192,23 @@ export interface GetMetricDataV2Request {
    *    by queue, the metrics returned are grouped by queue. The values that are returned apply to the
    *    metrics for each queue. They are not aggregated for all queues.</p>
    *          <p>If no grouping is specified, a summary of all metrics is returned.</p>
-   *          <p>Valid grouping keys: <code>QUEUE</code> | <code>ROUTING_PROFILE</code> | <code>AGENT</code>
-   *    | <code>CHANNEL</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
+   *          <p>Valid grouping keys: <code>AGENT</code> | <code>AGENT_HIERARCHY_LEVEL_ONE</code> |
    *     <code>AGENT_HIERARCHY_LEVEL_TWO</code> | <code>AGENT_HIERARCHY_LEVEL_THREE</code> |
    *     <code>AGENT_HIERARCHY_LEVEL_FOUR</code> | <code>AGENT_HIERARCHY_LEVEL_FIVE</code> |
-   *     <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> |
-   *     <code>contact/segmentAttributes/connect:Subtype</code> | <code>ROUTING_STEP_EXPRESSION</code> |
-   *     <code>Q_CONNECT_ENABLED</code>
+   *     <code>CASE_TEMPLATE_ARN</code> | <code>CASE_STATUS</code> | <code>CHANNEL</code> |
+   *     <code>contact/segmentAttributes/connect:Subtype</code> | <code>FLOWS_RESOURCE_ID</code> |
+   *     <code>FLOWS_MODULE_RESOURCE_ID</code> | <code>FLOW_TYPE</code> | <code>FLOWS_OUTCOME_TYPE</code>
+   *    | <code>INITIATION_METHOD</code> | <code>Q_CONNECT_ENABLED</code> | <code>QUEUE</code> |
+   *     <code>RESOURCE_PUBLISHED_TIMESTAMP</code> | <code>ROUTING_PROFILE</code> |
+   *     <code>ROUTING_STEP_EXPRESSION</code>
    *          </p>
    * @public
    */
   Groupings?: string[];
 
   /**
    * <p>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The
-   *    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
+   *    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
    *     Guide</i>.</p>
    *          <dl>
    *             <dt>ABANDONMENT_RATE</dt>
@@ -4359,6 +4365,15 @@ export interface GetMetricDataV2Request {
    *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical">Average conversation duration</a>
    *                </p>
    *             </dd>
+   *             <dt>AVG_FLOW_TIME</dt>
+   *             <dd>
+   *                <p>Unit: Seconds</p>
+   *                <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
+   *       resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
+   *       resource ID, Initiation method, Resource published timestamp</p>
+   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-flow-time-historical">Average flow time</a>
+   *                </p>
+   *             </dd>
    *             <dt>AVG_GREETING_TIME_AGENT</dt>
    *             <dd>
    *                <p>This metric is available only for contacts analyzed by Contact Lens conversational
@@ -4521,11 +4536,42 @@ export interface GetMetricDataV2Request {
    *             <dt>CONTACTS_ABANDONED</dt>
    *             <dd>
    *                <p>Unit: Count</p>
+   *                <p>Metric filter: </p>
+   *                <ul>
+   *                   <li>
+   *                      <p>Valid values: <code>API</code>| <code>Incoming</code> | <code>Outbound</code> |
+   *          <code>Transfer</code> | <code>Callback</code> | <code>Queue_Transfer</code>|
+   *          <code>Disconnect</code>
+   *                      </p>
+   *                   </li>
+   *                </ul>
    *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy,
    *       contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</p>
    *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical">Contact abandoned</a>
    *                </p>
    *             </dd>
+   *             <dt>CONTACTS_ABANDONED_IN_X</dt>
+   *             <dd>
+   *                <p>Unit: Count</p>
+   *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
+   *       Q in Connect</p>
+   *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
+   *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
+   *       "Less than"). </p>
+   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical">Contacts abandoned in X seconds</a>
+   *                </p>
+   *             </dd>
+   *             <dt>CONTACTS_ANSWERED_IN_X</dt>
+   *             <dd>
+   *                <p>Unit: Count</p>
+   *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
+   *       Q in Connect</p>
+   *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
+   *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
+   *       "Less than"). </p>
+   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical">Contacts answered in X seconds</a>
+   *                </p>
+   *             </dd>
    *             <dt>CONTACTS_CREATED</dt>
    *             <dd>
    *                <p>Unit: Count</p>
@@ -4668,6 +4714,32 @@ export interface GetMetricDataV2Request {
    *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical">Current cases</a>
    *                </p>
    *             </dd>
+   *             <dt>FLOWS_OUTCOME</dt>
+   *             <dd>
+   *                <p>Unit: Count</p>
+   *                <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
+   *       resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
+   *       resource ID, Initiation method, Resource published timestamp</p>
+   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical">Flows outcome</a>
+   *                </p>
+   *             </dd>
+   *             <dt>FLOWS_STARTED</dt>
+   *             <dd>
+   *                <p>Unit: Count</p>
+   *                <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
+   *       resource ID, Flows resource ID, Initiation method, Resource published timestamp</p>
+   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical">Flows started</a>
+   *                </p>
+   *             </dd>
+   *             <dt>MAX_FLOW_TIME</dt>
+   *             <dd>
+   *                <p>Unit: Seconds</p>
+   *                <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
+   *       resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
+   *       resource ID, Initiation method, Resource published timestamp</p>
+   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical">Maximum flow time</a>
+   *                </p>
+   *             </dd>
    *             <dt>MAX_QUEUED_TIME</dt>
    *             <dd>
    *                <p>Unit: Seconds</p>
@@ -4676,6 +4748,15 @@ export interface GetMetricDataV2Request {
    *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical">Maximum queued time</a>
    *                </p>
    *             </dd>
+   *             <dt>MIN_FLOW_TIME</dt>
+   *             <dd>
+   *                <p>Unit: Seconds</p>
+   *                <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
+   *       resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
+   *       resource ID, Initiation method, Resource published timestamp</p>
+   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical">Minimum flow time</a>
+   *                </p>
+   *             </dd>
    *             <dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt>
    *             <dd>
    *                <p>Unit: Percent</p>
@@ -4696,6 +4777,19 @@ export interface GetMetricDataV2Request {
    *                <p>Valid groupings and filters: Queue, RoutingStepExpression</p>
    *                <p>UI name: Not available </p>
    *             </dd>
+   *             <dt>PERCENT_FLOWS_OUTCOME</dt>
+   *             <dd>
+   *                <p>Unit: Percent</p>
+   *                <p>Valid metric filter key: <code>FLOWS_OUTCOME_TYPE</code>
+   *                </p>
+   *                <p>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module
+   *       resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows
+   *       resource ID, Initiation method, Resource published timestamp</p>
+   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical">Flows outcome percentage</a>.</p>
+   *                <note>
+   *                   <p>The <code>FLOWS_OUTCOME_TYPE</code> is not a valid grouping.</p>
+   *                </note>
+   *             </dd>
    *             <dt>PERCENT_NON_TALK_TIME</dt>
    *             <dd>
    *                <p>This metric is available only for contacts analyzed by Contact Lens conversational
@@ -4809,28 +4903,6 @@ export interface GetMetricDataV2Request {
    *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical">Agent on contact time</a>
    *                </p>
    *             </dd>
-   *             <dt>SUM_CONTACTS_ANSWERED_IN_X</dt>
-   *             <dd>
-   *                <p>Unit: Count</p>
-   *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
-   *       Q in Connect</p>
-   *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
-   *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
-   *       "Less than"). </p>
-   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical">Contacts answered in X seconds</a>
-   *                </p>
-   *             </dd>
-   *             <dt>SUM_CONTACTS_ABANDONED_IN_X</dt>
-   *             <dd>
-   *                <p>Unit: Count</p>
-   *                <p>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype,
-   *       Q in Connect</p>
-   *                <p>Threshold: For <code>ThresholdValue</code>, enter any whole number from 1 to 604800
-   *       (inclusive), in seconds. For <code>Comparison</code>, you must enter <code>LT</code> (for
-   *       "Less than"). </p>
-   *                <p>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical">Contacts abandoned in X seconds</a>
-   *                </p>
-   *             </dd>
    *             <dt>SUM_CONTACTS_DISCONNECTED </dt>
    *             <dd>
    *                <p>Valid metric filter key: <code>DISCONNECT_REASON</code>