/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.connect.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Gets metric data from the specified Amazon Connect instance. *

*

* GetMetricDataV2 offers more features than GetMetricData, the previous version of this API. It has new metrics, * offers filtering at a metric level, and offers the ability to filter and * group data by channels, queues, routing profiles, agents, and agent hierarchy * levels. It can retrieve historical data for the last 35 days, in 24-hour * intervals. *

*

* For a description of the historical metrics that are supported by * GetMetricDataV2 and GetMetricData, see Historical metrics definitions in the Amazon Connect Administrator's * Guide. *

*/ public class GetMetricDataV2Request extends AmazonWebServiceRequest implements Serializable { /** *

* The Amazon Resource Name (ARN) of the resource. This includes the * instanceId an Amazon Connect instance. *

*/ private String resourceArn; /** *

* The timestamp, in UNIX Epoch time format, at which to start the reporting * interval for the retrieval of historical metrics data. The time must be * before the end time timestamp. The time range between the start and end * time must be less than 24 hours. The start time cannot be earlier than 35 * days before the time of the request. Historical metrics are available for * 35 days. *

*/ private java.util.Date startTime; /** *

* The timestamp, in UNIX Epoch time format, at which to end the reporting * interval for the retrieval of historical metrics data. The time must be * later than the start time timestamp. It cannot be later than the current * timestamp. *

*

* The time range between the start and end time must be less than 24 hours. *

*/ private java.util.Date endTime; /** *

* The filters to apply to returned metrics. You can filter on the following * resources: *

* *

* At least one filter must be passed from queues, routing profiles, agents, * or user hierarchy groups. *

*

* To filter by phone number, see Create a historical metrics report in the Amazon Connect * Administrator's Guide. *

*

* Note the following limits: *

* */ private java.util.List filters; /** *

* The grouping applied to the metrics that are returned. For example, when * results are grouped 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. *

*

* If no grouping is specified, a summary of all metrics is returned. *

*

* Valid grouping keys: QUEUE | ROUTING_PROFILE | * AGENT | CHANNEL | * AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

*/ private java.util.List groupings; /** *

* 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 Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

*
*
AGENT_ADHERENT_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_NON_RESPONSE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_OCCUPANCY
*
*

* Unit: Percentage *

*

* Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy *

*
*
AGENT_SCHEDULE_ADHERENCE
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_SCHEDULED_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_ABANDON_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AFTER_CONTACT_WORK_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AGENT_CONNECTING_TIME
*
*

* Unit: Seconds *

*

* Valid metric filter key: INITIATION_METHOD. For now, this * metric only supports the following as INITIATION_METHOD: * INBOUND | OUTBOUND | CALLBACK | * API *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HANDLE_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_AND_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
AVG_QUEUE_ANSWER_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_ABANDONED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_CREATED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_HANDLED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD, * DISCONNECT_REASON *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_HOLD_ABANDONS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_QUEUED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_BY_AGENT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
MAX_QUEUED_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
SERVICE_LEVEL
*
*

* You can include up to 20 SERVICE_LEVEL metrics in a request. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ANSWERED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ABANDONED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_DISCONNECTED
*
*

* Valid metric filter key: DISCONNECT_REASON *

*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
SUM_RETRY_CALLBACK_ATTEMPTS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
*/ private java.util.List metrics; /** *

* The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of * results. *

*

* Constraints:
* Length: 1 - 2500
*/ private String nextToken; /** *

* The maximum number of results to return per page. *

*

* Constraints:
* Range: 1 - 100
*/ private Integer maxResults; /** *

* The Amazon Resource Name (ARN) of the resource. This includes the * instanceId an Amazon Connect instance. *

* * @return

* The Amazon Resource Name (ARN) of the resource. This includes the * instanceId an Amazon Connect instance. *

*/ public String getResourceArn() { return resourceArn; } /** *

* The Amazon Resource Name (ARN) of the resource. This includes the * instanceId an Amazon Connect instance. *

* * @param resourceArn

* The Amazon Resource Name (ARN) of the resource. This includes * the instanceId an Amazon Connect instance. *

*/ public void setResourceArn(String resourceArn) { this.resourceArn = resourceArn; } /** *

* The Amazon Resource Name (ARN) of the resource. This includes the * instanceId an Amazon Connect instance. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param resourceArn

* The Amazon Resource Name (ARN) of the resource. This includes * the instanceId an Amazon Connect instance. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withResourceArn(String resourceArn) { this.resourceArn = resourceArn; return this; } /** *

* The timestamp, in UNIX Epoch time format, at which to start the reporting * interval for the retrieval of historical metrics data. The time must be * before the end time timestamp. The time range between the start and end * time must be less than 24 hours. The start time cannot be earlier than 35 * days before the time of the request. Historical metrics are available for * 35 days. *

* * @return

* The timestamp, in UNIX Epoch time format, at which to start the * reporting interval for the retrieval of historical metrics data. * The time must be before the end time timestamp. The time range * between the start and end time must be less than 24 hours. The * start time cannot be earlier than 35 days before the time of the * request. Historical metrics are available for 35 days. *

*/ public java.util.Date getStartTime() { return startTime; } /** *

* The timestamp, in UNIX Epoch time format, at which to start the reporting * interval for the retrieval of historical metrics data. The time must be * before the end time timestamp. The time range between the start and end * time must be less than 24 hours. The start time cannot be earlier than 35 * days before the time of the request. Historical metrics are available for * 35 days. *

* * @param startTime

* The timestamp, in UNIX Epoch time format, at which to start * the reporting interval for the retrieval of historical metrics * data. The time must be before the end time timestamp. The time * range between the start and end time must be less than 24 * hours. The start time cannot be earlier than 35 days before * the time of the request. Historical metrics are available for * 35 days. *

*/ public void setStartTime(java.util.Date startTime) { this.startTime = startTime; } /** *

* The timestamp, in UNIX Epoch time format, at which to start the reporting * interval for the retrieval of historical metrics data. The time must be * before the end time timestamp. The time range between the start and end * time must be less than 24 hours. The start time cannot be earlier than 35 * days before the time of the request. Historical metrics are available for * 35 days. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param startTime

* The timestamp, in UNIX Epoch time format, at which to start * the reporting interval for the retrieval of historical metrics * data. The time must be before the end time timestamp. The time * range between the start and end time must be less than 24 * hours. The start time cannot be earlier than 35 days before * the time of the request. Historical metrics are available for * 35 days. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withStartTime(java.util.Date startTime) { this.startTime = startTime; return this; } /** *

* The timestamp, in UNIX Epoch time format, at which to end the reporting * interval for the retrieval of historical metrics data. The time must be * later than the start time timestamp. It cannot be later than the current * timestamp. *

*

* The time range between the start and end time must be less than 24 hours. *

* * @return

* The timestamp, in UNIX Epoch time format, at which to end the * reporting interval for the retrieval of historical metrics data. * The time must be later than the start time timestamp. It cannot * be later than the current timestamp. *

*

* The time range between the start and end time must be less than * 24 hours. *

*/ public java.util.Date getEndTime() { return endTime; } /** *

* The timestamp, in UNIX Epoch time format, at which to end the reporting * interval for the retrieval of historical metrics data. The time must be * later than the start time timestamp. It cannot be later than the current * timestamp. *

*

* The time range between the start and end time must be less than 24 hours. *

* * @param endTime

* The timestamp, in UNIX Epoch time format, at which to end the * reporting interval for the retrieval of historical metrics * data. The time must be later than the start time timestamp. It * cannot be later than the current timestamp. *

*

* The time range between the start and end time must be less * than 24 hours. *

*/ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** *

* The timestamp, in UNIX Epoch time format, at which to end the reporting * interval for the retrieval of historical metrics data. The time must be * later than the start time timestamp. It cannot be later than the current * timestamp. *

*

* The time range between the start and end time must be less than 24 hours. *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param endTime

* The timestamp, in UNIX Epoch time format, at which to end the * reporting interval for the retrieval of historical metrics * data. The time must be later than the start time timestamp. It * cannot be later than the current timestamp. *

*

* The time range between the start and end time must be less * than 24 hours. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withEndTime(java.util.Date endTime) { this.endTime = endTime; return this; } /** *

* The filters to apply to returned metrics. You can filter on the following * resources: *

*
    *
  • *

    * Queues *

    *
    • *
  • *

    * Routing profiles *

    *
    • *
  • *

    * Agents *

    *
    • *
  • *

    * Channels *

    *
    • *
  • *

    * User hierarchy groups *

    *
    • *
*

* At least one filter must be passed from queues, routing profiles, agents, * or user hierarchy groups. *

*

* To filter by phone number, see Create a historical metrics report in the Amazon Connect * Administrator's Guide. *

*

* Note the following limits: *

*
    *
  • *

    * Filter keys: A maximum of 5 filter keys are supported in a single * request. Valid filter keys: QUEUE | * ROUTING_PROFILE | AGENT | CHANNEL * | AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

    *
    • *
  • *

    * Filter values: A maximum of 100 filter values are supported in a * single request. For example, a GetMetricDataV2 request can * filter by 50 queues, 35 agents, and 15 routing profiles for a total of * 100 filter values. VOICE, CHAT, and * TASK are valid filterValue for the * CHANNEL filter key. *

    *
    • *
* * @return

* The filters to apply to returned metrics. You can filter on the * following resources: *

*
    *
  • *

    * Queues *

    *
    • *
  • *

    * Routing profiles *

    *
    • *
  • *

    * Agents *

    *
    • *
  • *

    * Channels *

    *
    • *
  • *

    * User hierarchy groups *

    *
    • *
*

* At least one filter must be passed from queues, routing profiles, * agents, or user hierarchy groups. *

*

* To filter by phone number, see Create a historical metrics report in the Amazon Connect * Administrator's Guide. *

*

* Note the following limits: *

*
    *
  • *

    * Filter keys: A maximum of 5 filter keys are supported in a * single request. Valid filter keys: QUEUE | * ROUTING_PROFILE | AGENT | * CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

    *
    • *
  • *

    * Filter values: A maximum of 100 filter values are * supported in a single request. For example, a * GetMetricDataV2 request can filter by 50 queues, 35 * agents, and 15 routing profiles for a total of 100 filter values. * VOICE, CHAT, and TASK are * valid filterValue for the CHANNEL * filter key. *

    *
    • *
*/ public java.util.List getFilters() { return filters; } /** *

* The filters to apply to returned metrics. You can filter on the following * resources: *

*
    *
  • *

    * Queues *

    *
    • *
  • *

    * Routing profiles *

    *
    • *
  • *

    * Agents *

    *
    • *
  • *

    * Channels *

    *
    • *
  • *

    * User hierarchy groups *

    *
    • *
*

* At least one filter must be passed from queues, routing profiles, agents, * or user hierarchy groups. *

*

* To filter by phone number, see Create a historical metrics report in the Amazon Connect * Administrator's Guide. *

*

* Note the following limits: *

*
    *
  • *

    * Filter keys: A maximum of 5 filter keys are supported in a single * request. Valid filter keys: QUEUE | * ROUTING_PROFILE | AGENT | CHANNEL * | AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

    *
    • *
  • *

    * Filter values: A maximum of 100 filter values are supported in a * single request. For example, a GetMetricDataV2 request can * filter by 50 queues, 35 agents, and 15 routing profiles for a total of * 100 filter values. VOICE, CHAT, and * TASK are valid filterValue for the * CHANNEL filter key. *

    *
    • *
* * @param filters

* The filters to apply to returned metrics. You can filter on * the following resources: *

*
    *
  • *

    * Queues *

    *
    • *
  • *

    * Routing profiles *

    *
    • *
  • *

    * Agents *

    *
    • *
  • *

    * Channels *

    *
    • *
  • *

    * User hierarchy groups *

    *
    • *
*

* At least one filter must be passed from queues, routing * profiles, agents, or user hierarchy groups. *

*

* To filter by phone number, see Create a historical metrics report in the Amazon * Connect Administrator's Guide. *

*

* Note the following limits: *

*
    *
  • *

    * Filter keys: A maximum of 5 filter keys are supported * in a single request. Valid filter keys: QUEUE | * ROUTING_PROFILE | AGENT | * CHANNEL | AGENT_HIERARCHY_LEVEL_ONE * | AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

    *
    • *
  • *

    * Filter values: A maximum of 100 filter values are * supported in a single request. For example, a * GetMetricDataV2 request can filter by 50 queues, * 35 agents, and 15 routing profiles for a total of 100 filter * values. VOICE, CHAT, and * TASK are valid filterValue for the * CHANNEL filter key. *

    *
    • *
*/ public void setFilters(java.util.Collection filters) { if (filters == null) { this.filters = null; return; } this.filters = new java.util.ArrayList(filters); } /** *

* The filters to apply to returned metrics. You can filter on the following * resources: *

*
    *
  • *

    * Queues *

    *
    • *
  • *

    * Routing profiles *

    *
    • *
  • *

    * Agents *

    *
    • *
  • *

    * Channels *

    *
    • *
  • *

    * User hierarchy groups *

    *
    • *
*

* At least one filter must be passed from queues, routing profiles, agents, * or user hierarchy groups. *

*

* To filter by phone number, see Create a historical metrics report in the Amazon Connect * Administrator's Guide. *

*

* Note the following limits: *

*
    *
  • *

    * Filter keys: A maximum of 5 filter keys are supported in a single * request. Valid filter keys: QUEUE | * ROUTING_PROFILE | AGENT | CHANNEL * | AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

    *
    • *
  • *

    * Filter values: A maximum of 100 filter values are supported in a * single request. For example, a GetMetricDataV2 request can * filter by 50 queues, 35 agents, and 15 routing profiles for a total of * 100 filter values. VOICE, CHAT, and * TASK are valid filterValue for the * CHANNEL filter key. *

    *
    • *
*

* Returns a reference to this object so that method calls can be chained * together. * * @param filters

* The filters to apply to returned metrics. You can filter on * the following resources: *

*
    *
  • *

    * Queues *

    *
    • *
  • *

    * Routing profiles *

    *
    • *
  • *

    * Agents *

    *
    • *
  • *

    * Channels *

    *
    • *
  • *

    * User hierarchy groups *

    *
    • *
*

* At least one filter must be passed from queues, routing * profiles, agents, or user hierarchy groups. *

*

* To filter by phone number, see Create a historical metrics report in the Amazon * Connect Administrator's Guide. *

*

* Note the following limits: *

*
    *
  • *

    * Filter keys: A maximum of 5 filter keys are supported * in a single request. Valid filter keys: QUEUE | * ROUTING_PROFILE | AGENT | * CHANNEL | AGENT_HIERARCHY_LEVEL_ONE * | AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

    *
    • *
  • *

    * Filter values: A maximum of 100 filter values are * supported in a single request. For example, a * GetMetricDataV2 request can filter by 50 queues, * 35 agents, and 15 routing profiles for a total of 100 filter * values. VOICE, CHAT, and * TASK are valid filterValue for the * CHANNEL filter key. *

    *
    • *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withFilters(FilterV2... filters) { if (getFilters() == null) { this.filters = new java.util.ArrayList(filters.length); } for (FilterV2 value : filters) { this.filters.add(value); } return this; } /** *

* The filters to apply to returned metrics. You can filter on the following * resources: *

*
    *
  • *

    * Queues *

    *
    • *
  • *

    * Routing profiles *

    *
    • *
  • *

    * Agents *

    *
    • *
  • *

    * Channels *

    *
    • *
  • *

    * User hierarchy groups *

    *
    • *
*

* At least one filter must be passed from queues, routing profiles, agents, * or user hierarchy groups. *

*

* To filter by phone number, see Create a historical metrics report in the Amazon Connect * Administrator's Guide. *

*

* Note the following limits: *

*
    *
  • *

    * Filter keys: A maximum of 5 filter keys are supported in a single * request. Valid filter keys: QUEUE | * ROUTING_PROFILE | AGENT | CHANNEL * | AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

    *
    • *
  • *

    * Filter values: A maximum of 100 filter values are supported in a * single request. For example, a GetMetricDataV2 request can * filter by 50 queues, 35 agents, and 15 routing profiles for a total of * 100 filter values. VOICE, CHAT, and * TASK are valid filterValue for the * CHANNEL filter key. *

    *
    • *
*

* Returns a reference to this object so that method calls can be chained * together. * * @param filters

* The filters to apply to returned metrics. You can filter on * the following resources: *

*
    *
  • *

    * Queues *

    *
    • *
  • *

    * Routing profiles *

    *
    • *
  • *

    * Agents *

    *
    • *
  • *

    * Channels *

    *
    • *
  • *

    * User hierarchy groups *

    *
    • *
*

* At least one filter must be passed from queues, routing * profiles, agents, or user hierarchy groups. *

*

* To filter by phone number, see Create a historical metrics report in the Amazon * Connect Administrator's Guide. *

*

* Note the following limits: *

*
    *
  • *

    * Filter keys: A maximum of 5 filter keys are supported * in a single request. Valid filter keys: QUEUE | * ROUTING_PROFILE | AGENT | * CHANNEL | AGENT_HIERARCHY_LEVEL_ONE * | AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

    *
    • *
  • *

    * Filter values: A maximum of 100 filter values are * supported in a single request. For example, a * GetMetricDataV2 request can filter by 50 queues, * 35 agents, and 15 routing profiles for a total of 100 filter * values. VOICE, CHAT, and * TASK are valid filterValue for the * CHANNEL filter key. *

    *
    • *
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withFilters(java.util.Collection filters) { setFilters(filters); return this; } /** *

* The grouping applied to the metrics that are returned. For example, when * results are grouped 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. *

*

* If no grouping is specified, a summary of all metrics is returned. *

*

* Valid grouping keys: QUEUE | ROUTING_PROFILE | * AGENT | CHANNEL | * AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

* * @return

* The grouping applied to the metrics that are returned. For * example, when results are grouped 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. *

*

* If no grouping is specified, a summary of all metrics is * returned. *

*

* Valid grouping keys: QUEUE | * ROUTING_PROFILE | AGENT | * CHANNEL | AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

*/ public java.util.List getGroupings() { return groupings; } /** *

* The grouping applied to the metrics that are returned. For example, when * results are grouped 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. *

*

* If no grouping is specified, a summary of all metrics is returned. *

*

* Valid grouping keys: QUEUE | ROUTING_PROFILE | * AGENT | CHANNEL | * AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

* * @param groupings

* The grouping applied to the metrics that are returned. For * example, when results are grouped 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. *

*

* If no grouping is specified, a summary of all metrics is * returned. *

*

* Valid grouping keys: QUEUE | * ROUTING_PROFILE | AGENT | * CHANNEL | AGENT_HIERARCHY_LEVEL_ONE * | AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

*/ public void setGroupings(java.util.Collection groupings) { if (groupings == null) { this.groupings = null; return; } this.groupings = new java.util.ArrayList(groupings); } /** *

* The grouping applied to the metrics that are returned. For example, when * results are grouped 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. *

*

* If no grouping is specified, a summary of all metrics is returned. *

*

* Valid grouping keys: QUEUE | ROUTING_PROFILE | * AGENT | CHANNEL | * AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param groupings

* The grouping applied to the metrics that are returned. For * example, when results are grouped 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. *

*

* If no grouping is specified, a summary of all metrics is * returned. *

*

* Valid grouping keys: QUEUE | * ROUTING_PROFILE | AGENT | * CHANNEL | AGENT_HIERARCHY_LEVEL_ONE * | AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withGroupings(String... groupings) { if (getGroupings() == null) { this.groupings = new java.util.ArrayList(groupings.length); } for (String value : groupings) { this.groupings.add(value); } return this; } /** *

* The grouping applied to the metrics that are returned. For example, when * results are grouped 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. *

*

* If no grouping is specified, a summary of all metrics is returned. *

*

* Valid grouping keys: QUEUE | ROUTING_PROFILE | * AGENT | CHANNEL | * AGENT_HIERARCHY_LEVEL_ONE | * AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

*

* Returns a reference to this object so that method calls can be chained * together. * * @param groupings

* The grouping applied to the metrics that are returned. For * example, when results are grouped 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. *

*

* If no grouping is specified, a summary of all metrics is * returned. *

*

* Valid grouping keys: QUEUE | * ROUTING_PROFILE | AGENT | * CHANNEL | AGENT_HIERARCHY_LEVEL_ONE * | AGENT_HIERARCHY_LEVEL_TWO | * AGENT_HIERARCHY_LEVEL_THREE | * AGENT_HIERARCHY_LEVEL_FOUR | * AGENT_HIERARCHY_LEVEL_FIVE *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withGroupings(java.util.Collection groupings) { setGroupings(groupings); return this; } /** *

* 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 Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

*
*
AGENT_ADHERENT_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_NON_RESPONSE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_OCCUPANCY
*
*

* Unit: Percentage *

*

* Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy *

*
*
AGENT_SCHEDULE_ADHERENCE
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_SCHEDULED_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_ABANDON_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AFTER_CONTACT_WORK_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AGENT_CONNECTING_TIME
*
*

* Unit: Seconds *

*

* Valid metric filter key: INITIATION_METHOD. For now, this * metric only supports the following as INITIATION_METHOD: * INBOUND | OUTBOUND | CALLBACK | * API *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HANDLE_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_AND_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
AVG_QUEUE_ANSWER_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_ABANDONED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_CREATED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_HANDLED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD, * DISCONNECT_REASON *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_HOLD_ABANDONS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_QUEUED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_BY_AGENT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
MAX_QUEUED_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
SERVICE_LEVEL
*
*

* You can include up to 20 SERVICE_LEVEL metrics in a request. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ANSWERED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ABANDONED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_DISCONNECTED
*
*

* Valid metric filter key: DISCONNECT_REASON *

*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
SUM_RETRY_CALLBACK_ATTEMPTS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
* * @return

* 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 Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

*
*
AGENT_ADHERENT_TIME
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_NON_RESPONSE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_OCCUPANCY
*
*

* Unit: Percentage *

*

* Valid groupings and filters: Routing Profile, Agent, Agent * Hierarchy *

*
*
AGENT_SCHEDULE_ADHERENCE
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_SCHEDULED_TIME
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_ABANDON_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_AFTER_CONTACT_WORK_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_AGENT_CONNECTING_TIME
*
*

* Unit: Seconds *

*

* Valid metric filter key: INITIATION_METHOD. For now, * this metric only supports the following as * INITIATION_METHOD: INBOUND | * OUTBOUND | CALLBACK | API *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_HANDLE_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_INTERACTION_AND_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_INTERACTION_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
AVG_QUEUE_ANSWER_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_ABANDONED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_CREATED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_HANDLED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD, * DISCONNECT_REASON *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_HOLD_ABANDONS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_QUEUED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_BY_AGENT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
MAX_QUEUED_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
SERVICE_LEVEL
*
*

* You can include up to 20 SERVICE_LEVEL metrics in a request. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_ANSWERED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_ABANDONED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_DISCONNECTED
*
*

* Valid metric filter key: DISCONNECT_REASON *

*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
SUM_RETRY_CALLBACK_ATTEMPTS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
*/ public java.util.List getMetrics() { return metrics; } /** *

* 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 Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

*
*
AGENT_ADHERENT_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_NON_RESPONSE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_OCCUPANCY
*
*

* Unit: Percentage *

*

* Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy *

*
*
AGENT_SCHEDULE_ADHERENCE
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_SCHEDULED_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_ABANDON_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AFTER_CONTACT_WORK_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AGENT_CONNECTING_TIME
*
*

* Unit: Seconds *

*

* Valid metric filter key: INITIATION_METHOD. For now, this * metric only supports the following as INITIATION_METHOD: * INBOUND | OUTBOUND | CALLBACK | * API *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HANDLE_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_AND_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
AVG_QUEUE_ANSWER_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_ABANDONED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_CREATED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_HANDLED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD, * DISCONNECT_REASON *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_HOLD_ABANDONS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_QUEUED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_BY_AGENT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
MAX_QUEUED_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
SERVICE_LEVEL
*
*

* You can include up to 20 SERVICE_LEVEL metrics in a request. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ANSWERED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ABANDONED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_DISCONNECTED
*
*

* Valid metric filter key: DISCONNECT_REASON *

*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
SUM_RETRY_CALLBACK_ATTEMPTS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
* * @param metrics

* 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 Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

*
*
AGENT_ADHERENT_TIME
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is * available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_NON_RESPONSE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_OCCUPANCY
*
*

* Unit: Percentage *

*

* Valid groupings and filters: Routing Profile, Agent, Agent * Hierarchy *

*
*
AGENT_SCHEDULE_ADHERENCE
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is * available. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_SCHEDULED_TIME
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is * available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_ABANDON_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_AFTER_CONTACT_WORK_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_AGENT_CONNECTING_TIME
*
*

* Unit: Seconds *

*

* Valid metric filter key: INITIATION_METHOD. For * now, this metric only supports the following as * INITIATION_METHOD: INBOUND | * OUTBOUND | CALLBACK | * API *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_HANDLE_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_INTERACTION_AND_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_INTERACTION_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
AVG_QUEUE_ANSWER_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_ABANDONED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_CREATED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_HANDLED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD, * DISCONNECT_REASON *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_HOLD_ABANDONS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_QUEUED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_BY_AGENT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
MAX_QUEUED_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
SERVICE_LEVEL
*
*

* You can include up to 20 SERVICE_LEVEL metrics in a request. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_ANSWERED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_ABANDONED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_DISCONNECTED
*
*

* Valid metric filter key: DISCONNECT_REASON *

*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
SUM_RETRY_CALLBACK_ATTEMPTS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
*/ public void setMetrics(java.util.Collection metrics) { if (metrics == null) { this.metrics = null; return; } this.metrics = new java.util.ArrayList(metrics); } /** *

* 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 Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

*
*
AGENT_ADHERENT_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_NON_RESPONSE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_OCCUPANCY
*
*

* Unit: Percentage *

*

* Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy *

*
*
AGENT_SCHEDULE_ADHERENCE
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_SCHEDULED_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_ABANDON_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AFTER_CONTACT_WORK_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AGENT_CONNECTING_TIME
*
*

* Unit: Seconds *

*

* Valid metric filter key: INITIATION_METHOD. For now, this * metric only supports the following as INITIATION_METHOD: * INBOUND | OUTBOUND | CALLBACK | * API *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HANDLE_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_AND_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
AVG_QUEUE_ANSWER_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_ABANDONED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_CREATED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_HANDLED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD, * DISCONNECT_REASON *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_HOLD_ABANDONS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_QUEUED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_BY_AGENT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
MAX_QUEUED_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
SERVICE_LEVEL
*
*

* You can include up to 20 SERVICE_LEVEL metrics in a request. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ANSWERED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ABANDONED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_DISCONNECTED
*
*

* Valid metric filter key: DISCONNECT_REASON *

*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
SUM_RETRY_CALLBACK_ATTEMPTS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
*

* Returns a reference to this object so that method calls can be chained * together. * * @param metrics

* 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 Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

*
*
AGENT_ADHERENT_TIME
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is * available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_NON_RESPONSE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_OCCUPANCY
*
*

* Unit: Percentage *

*

* Valid groupings and filters: Routing Profile, Agent, Agent * Hierarchy *

*
*
AGENT_SCHEDULE_ADHERENCE
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is * available. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_SCHEDULED_TIME
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is * available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_ABANDON_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_AFTER_CONTACT_WORK_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_AGENT_CONNECTING_TIME
*
*

* Unit: Seconds *

*

* Valid metric filter key: INITIATION_METHOD. For * now, this metric only supports the following as * INITIATION_METHOD: INBOUND | * OUTBOUND | CALLBACK | * API *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_HANDLE_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_INTERACTION_AND_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_INTERACTION_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
AVG_QUEUE_ANSWER_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_ABANDONED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_CREATED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_HANDLED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD, * DISCONNECT_REASON *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_HOLD_ABANDONS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_QUEUED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_BY_AGENT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
MAX_QUEUED_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
SERVICE_LEVEL
*
*

* You can include up to 20 SERVICE_LEVEL metrics in a request. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_ANSWERED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_ABANDONED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_DISCONNECTED
*
*

* Valid metric filter key: DISCONNECT_REASON *

*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
SUM_RETRY_CALLBACK_ATTEMPTS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withMetrics(MetricV2... metrics) { if (getMetrics() == null) { this.metrics = new java.util.ArrayList(metrics.length); } for (MetricV2 value : metrics) { this.metrics.add(value); } return this; } /** *

* 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 Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

*
*
AGENT_ADHERENT_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_NON_RESPONSE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_OCCUPANCY
*
*

* Unit: Percentage *

*

* Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy *

*
*
AGENT_SCHEDULE_ADHERENCE
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AGENT_SCHEDULED_TIME
*
*

* This metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_ABANDON_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AFTER_CONTACT_WORK_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_AGENT_CONNECTING_TIME
*
*

* Unit: Seconds *

*

* Valid metric filter key: INITIATION_METHOD. For now, this * metric only supports the following as INITIATION_METHOD: * INBOUND | OUTBOUND | CALLBACK | * API *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HANDLE_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_AND_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
AVG_INTERACTION_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
AVG_QUEUE_ANSWER_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_ABANDONED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_CREATED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_HANDLED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD, * DISCONNECT_REASON *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_HOLD_ABANDONS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_QUEUED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_BY_AGENT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
MAX_QUEUED_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, Agent, * Agent Hierarchy *

*
*
SERVICE_LEVEL
*
*

* You can include up to 20 SERVICE_LEVEL metrics in a request. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ANSWERED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_ABANDONED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole number from 1 * to 604800 (inclusive), in seconds. For Comparison, you must * enter LT (for "Less than"). *

*
*
SUM_CONTACTS_DISCONNECTED
*
*

* Valid metric filter key: DISCONNECT_REASON *

*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
SUM_RETRY_CALLBACK_ATTEMPTS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
*

* Returns a reference to this object so that method calls can be chained * together. * * @param metrics

* 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 Historical metrics definitions in the Amazon Connect * Administrator's Guide. *

*
*
AGENT_ADHERENT_TIME
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is * available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_NON_RESPONSE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_OCCUPANCY
*
*

* Unit: Percentage *

*

* Valid groupings and filters: Routing Profile, Agent, Agent * Hierarchy *

*
*
AGENT_SCHEDULE_ADHERENCE
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is * available. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AGENT_SCHEDULED_TIME
*
*

* This metric is available only in Amazon Web Services Regions * where Forecasting, capacity planning, and scheduling is * available. *

*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_ABANDON_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_AFTER_CONTACT_WORK_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_AGENT_CONNECTING_TIME
*
*

* Unit: Seconds *

*

* Valid metric filter key: INITIATION_METHOD. For * now, this metric only supports the following as * INITIATION_METHOD: INBOUND | * OUTBOUND | CALLBACK | * API *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_HANDLE_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_INTERACTION_AND_HOLD_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
AVG_INTERACTION_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
AVG_QUEUE_ANSWER_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_ABANDONED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_CREATED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
CONTACTS_HANDLED
*
*

* Unit: Count *

*

* Valid metric filter key: INITIATION_METHOD, * DISCONNECT_REASON *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_HOLD_ABANDONS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_QUEUED
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_BY_AGENT
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
MAX_QUEUED_TIME
*
*

* Unit: Seconds *

*

* Valid groupings and filters: Queue, Channel, Routing Profile, * Agent, Agent Hierarchy *

*
*
SERVICE_LEVEL
*
*

* You can include up to 20 SERVICE_LEVEL metrics in a request. *

*

* Unit: Percent *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_ANSWERED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_ABANDONED_IN_X
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*

* Threshold: For ThresholdValue, enter any whole * number from 1 to 604800 (inclusive), in seconds. For * Comparison, you must enter LT (for * "Less than"). *

*
*
SUM_CONTACTS_DISCONNECTED
*
*

* Valid metric filter key: DISCONNECT_REASON *

*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
SUM_RETRY_CALLBACK_ATTEMPTS
*
*

* Unit: Count *

*

* Valid groupings and filters: Queue, Channel, Routing Profile *

*
*
* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withMetrics(java.util.Collection metrics) { setMetrics(metrics); return this; } /** *

* The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of * results. *

*

* Constraints:
* Length: 1 - 2500
* * @return

* The token for the next set of results. Use the value returned in * the previous response in the next request to retrieve the next * set of results. *

*/ public String getNextToken() { return nextToken; } /** *

* The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of * results. *

*

* Constraints:
* Length: 1 - 2500
* * @param nextToken

* The token for the next set of results. Use the value returned * in the previous response in the next request to retrieve the * next set of results. *

*/ public void setNextToken(String nextToken) { this.nextToken = nextToken; } /** *

* The token for the next set of results. Use the value returned in the * previous response in the next request to retrieve the next set of * results. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Length: 1 - 2500
* * @param nextToken

* The token for the next set of results. Use the value returned * in the previous response in the next request to retrieve the * next set of results. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withNextToken(String nextToken) { this.nextToken = nextToken; return this; } /** *

* The maximum number of results to return per page. *

*

* Constraints:
* Range: 1 - 100
* * @return

* The maximum number of results to return per page. *

*/ public Integer getMaxResults() { return maxResults; } /** *

* The maximum number of results to return per page. *

*

* Constraints:
* Range: 1 - 100
* * @param maxResults

* The maximum number of results to return per page. *

*/ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *

* The maximum number of results to return per page. *

*

* Returns a reference to this object so that method calls can be chained * together. *

* Constraints:
* Range: 1 - 100
* * @param maxResults

* The maximum number of results to return per page. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetMetricDataV2Request withMaxResults(Integer maxResults) { this.maxResults = maxResults; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getResourceArn() != null) sb.append("ResourceArn: " + getResourceArn() + ","); if (getStartTime() != null) sb.append("StartTime: " + getStartTime() + ","); if (getEndTime() != null) sb.append("EndTime: " + getEndTime() + ","); if (getFilters() != null) sb.append("Filters: " + getFilters() + ","); if (getGroupings() != null) sb.append("Groupings: " + getGroupings() + ","); if (getMetrics() != null) sb.append("Metrics: " + getMetrics() + ","); if (getNextToken() != null) sb.append("NextToken: " + getNextToken() + ","); if (getMaxResults() != null) sb.append("MaxResults: " + getMaxResults()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getResourceArn() == null) ? 0 : getResourceArn().hashCode()); hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode()); hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode()); hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode()); hashCode = prime * hashCode + ((getGroupings() == null) ? 0 : getGroupings().hashCode()); hashCode = prime * hashCode + ((getMetrics() == null) ? 0 : getMetrics().hashCode()); hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode()); hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetMetricDataV2Request == false) return false; GetMetricDataV2Request other = (GetMetricDataV2Request) obj; if (other.getResourceArn() == null ^ this.getResourceArn() == null) return false; if (other.getResourceArn() != null && other.getResourceArn().equals(this.getResourceArn()) == false) return false; if (other.getStartTime() == null ^ this.getStartTime() == null) return false; if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false) return false; if (other.getEndTime() == null ^ this.getEndTime() == null) return false; if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false) return false; if (other.getFilters() == null ^ this.getFilters() == null) return false; if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false; if (other.getGroupings() == null ^ this.getGroupings() == null) return false; if (other.getGroupings() != null && other.getGroupings().equals(this.getGroupings()) == false) return false; if (other.getMetrics() == null ^ this.getMetrics() == null) return false; if (other.getMetrics() != null && other.getMetrics().equals(this.getMetrics()) == false) return false; if (other.getNextToken() == null ^ this.getNextToken() == null) return false; if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false) return false; if (other.getMaxResults() == null ^ this.getMaxResults() == null) return false; if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false) return false; return true; } }