java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.connect.model.ConnectRequest
    - - software.amazon.awssdk.services.connect.model.GetMetricDataV2Request

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>

@Generated("software.amazon.awssdk:codegen")
public final class GetMetricDataV2Request
extends ConnectRequest
implements ToCopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetMetricDataV2Request.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetMetricDataV2Request.Builder`	`builder()`
`Instant`	`endTime()`	The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<FilterV2>`	`filters()`	The filters to apply to returned metrics.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<String>`	`groupings()`	The grouping applied to the metrics that are returned.
`boolean`	`hasFilters()`	For responses, this returns true if the service returned a value for the Filters property.
`boolean`	`hasGroupings()`	For responses, this returns true if the service returned a value for the Groupings property.
`int`	`hashCode()`
`boolean`	`hasMetrics()`	For responses, this returns true if the service returned a value for the Metrics property.
`IntervalDetails`	`interval()`	The interval period and timezone to apply to returned metrics.
`Integer`	`maxResults()`	The maximum number of results to return per page.
`List<MetricV2>`	`metrics()`	The metrics to retrieve.
`String`	`nextToken()`	The token for the next set of results.
`String`	`resourceArn()`	The Amazon Resource Name (ARN) of the resource.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetMetricDataV2Request.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()`	The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data.
`GetMetricDataV2Request.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - resourceArn
```
public final String resourceArn()
```
    The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
  - startTime
```
public final Instant 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 start and end time depends on the IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.
    
    Returns:
    
    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 start and end time depends on the IntervalPeriod selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.
  - endTime
```
public final Instant 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.
    
    Returns:
    
    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.
  - interval
```
public final IntervalDetails interval()
```
    The interval period and timezone to apply to returned metrics.
    
    IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.
    
    For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period.
    
    The following list describes restrictions on StartTime and EndTime based on which IntervalPeriod is requested.
    
    FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.
    
    THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.
    
    HOUR: The difference between StartTime and EndTime must be less than 3 days.
    
    DAY: The difference between StartTime and EndTime must be less than 35 days.
    
    WEEK: The difference between StartTime and EndTime must be less than 35 days.
    
    TOTAL: The difference between StartTime and EndTime must be less than 35 days.
    
    TimeZone: The timezone applied to requested metrics.
    Returns:
    
    The interval period and timezone to apply to returned metrics.
    
    IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.
    
    For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the TOTAL interval period.
    
    The following list describes restrictions on StartTime and EndTime based on which IntervalPeriod is requested.
    
    FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.
    
    THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.
    
    HOUR: The difference between StartTime and EndTime must be less than 3 days.
    
    DAY: The difference between StartTime and EndTime must be less than 35 days.
    
    WEEK: The difference between StartTime and EndTime must be less than 35 days.
    
    TOTAL: The difference between StartTime and EndTime must be less than 35 days.
    
    TimeZone: The timezone applied to requested metrics.
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filters
```
public final List<FilterV2> filters()
```
    The filters to apply to returned metrics. You can filter on the following resources:
    
    Queues
    
    Routing profiles
    
    Agents
    
    Channels
    
    User hierarchy groups
    
    Feature
    
    Routing step expression
    
    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 | FEATURE | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
    
    Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
    
    contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
    
    connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
    
    ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
    Returns:
    
    The filters to apply to returned metrics. You can filter on the following resources:
    
    Queues
    
    Routing profiles
    
    Agents
    
    Channels
    
    User hierarchy groups
    
    Feature
    
    Routing step expression
    
    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 | FEATURE | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
    
    Filter values: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid filterValue for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters.
    
    contact_lens_conversational_analytics is a valid filterValue for the FEATURE filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.
    
    connect:Chat, connect:SMS, connect:Telephony, and connect:WebRTC are valid filterValue examples (not exhaustive) for the contact/segmentAttributes/connect:Subtype filter key.
    
    ROUTING_STEP_EXPRESSION is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.
  - hasGroupings
```
public final boolean hasGroupings()
```
    For responses, this returns true if the service returned a value for the Groupings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - groupings
```
public final List<String> 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 | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGroupings() method.
    
    Returns:
    
    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 | CASE_TEMPLATE_ARN | CASE_STATUS | contact/segmentAttributes/connect:Subtype | ROUTING_STEP_EXPRESSION
  - hasMetrics
```
public final boolean hasMetrics()
```
    For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - metrics
```
public final List<MetricV2> 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.
    
    ABANDONMENT_RATE
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Abandonment rate
    
    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
    
    UI name: Adherent time
    
    AGENT_ANSWER_RATE
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent answer rate
    
    AGENT_NON_ADHERENT_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Non-adherent time
    
    AGENT_NON_RESPONSE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent non-response
    
    AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
    
    UI name: Agent non-response without customer abandons
    
    AGENT_OCCUPANCY
    
    Unit: Percentage
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    UI name: Occupancy
    
    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
    
    UI name: Adherence
    
    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
    
    UI name: Scheduled time
    
    AVG_ABANDON_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average queue abandon time
    
    AVG_ACTIVE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Average active time
    
    AVG_AFTER_CONTACT_WORK_TIME
    
    Unit: Seconds
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average after contact work time
    
    Feature is a valid filter but not a valid grouping.
    
    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
    
    UI name: Average agent API connecting time
    
    The Negate key in Metric Level Filters is not applicable for this metric.
    
    AVG_AGENT_PAUSE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Average agent pause time
    
    AVG_CASE_RELATED_CONTACTS
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Average contacts per case
    
    AVG_CASE_RESOLUTION_TIME
    
    Unit: Seconds
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Average case resolution time
    
    AVG_CONTACT_DURATION
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average contact duration
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_CONVERSATION_DURATION
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average conversation duration
    
    AVG_GREETING_TIME_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average greeting time agent
    
    AVG_HANDLE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
    
    UI name: Average handle time
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average customer hold time
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_HOLD_TIME_ALL_CONTACTS
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average customer hold time all contacts
    
    AVG_HOLDS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average holds
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_INTERACTION_AND_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average agent interaction and customer hold time
    
    AVG_INTERACTION_TIME
    
    Unit: Seconds
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average agent interaction time
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_INTERRUPTIONS_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average interruptions agent
    
    AVG_INTERRUPTION_TIME_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average interruption time agent
    
    AVG_NON_TALK_TIME
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average non-talk time
    
    AVG_QUEUE_ANSWER_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average queue answer time
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_RESOLUTION_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    UI name: Average resolution time
    
    AVG_TALK_TIME
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average talk time
    
    AVG_TALK_TIME_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average talk time agent
    
    AVG_TALK_TIME_CUSTOMER
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average talk time customer
    
    CASES_CREATED
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Cases created
    
    CONTACTS_ABANDONED
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
    
    UI name: Contact abandoned
    
    CONTACTS_CREATED
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts created
    
    Feature is a valid filter but not a valid grouping.
    
    CONTACTS_HANDLED
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
    
    UI name: API contacts handled
    
    Feature is a valid filter but not a valid grouping.
    
    CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts handled by Connected to agent
    
    CONTACTS_HOLD_ABANDONS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts hold disconnect
    
    CONTACTS_ON_HOLD_AGENT_DISCONNECT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts hold agent disconnect
    
    CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts hold customer disconnect
    
    CONTACTS_PUT_ON_HOLD
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts put on hold
    
    CONTACTS_TRANSFERRED_OUT_EXTERNAL
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts transferred out external
    
    CONTACTS_TRANSFERRED_OUT_INTERNAL
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts transferred out internal
    
    CONTACTS_QUEUED
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts queued
    
    CONTACTS_QUEUED_BY_ENQUEUE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts queued by Enqueue
    
    CONTACTS_RESOLVED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    UI name: Contacts resolved in X
    
    CONTACTS_TRANSFERRED_OUT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts transferred out
    
    Feature is a valid filter but not a valid grouping.
    
    CONTACTS_TRANSFERRED_OUT_BY_AGENT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts transferred out by agent
    
    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts transferred out queue
    
    CURRENT_CASES
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Current cases
    
    MAX_QUEUED_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Maximum queued time
    
    PERCENT_CASES_FIRST_CONTACT_RESOLVED
    
    Unit: Percent
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Cases resolved on first contact
    
    PERCENT_CONTACTS_STEP_EXPIRED
    
    Unit: Percent
    
    Valid groupings and filters: Queue, RoutingStepExpression
    
    UI name: Not available
    
    PERCENT_CONTACTS_STEP_JOINED
    
    Unit: Percent
    
    Valid groupings and filters: Queue, RoutingStepExpression
    
    UI name: Not available
    
    PERCENT_NON_TALK_TIME
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Percentage
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Non-talk time percent
    
    PERCENT_TALK_TIME
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Percentage
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Talk time percent
    
    PERCENT_TALK_TIME_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Percentage
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Talk time agent percent
    
    PERCENT_TALK_TIME_CUSTOMER
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Percentage
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Talk time customer percent
    
    REOPENED_CASE_ACTIONS
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Cases reopened
    
    RESOLVED_CASE_ACTIONS
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Cases resolved
    
    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").
    
    UI name: Service level X
    
    STEP_CONTACTS_QUEUED
    
    Unit: Count
    
    Valid groupings and filters: Queue, RoutingStepExpression
    
    UI name: Not available
    
    SUM_AFTER_CONTACT_WORK_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: After contact work time
    
    SUM_CONNECTING_TIME_AGENT
    
    Unit: Seconds
    
    Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent API connecting time
    
    The Negate key in Metric Level Filters is not applicable for this metric.
    
    SUM_CONTACT_FLOW_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contact flow time
    
    SUM_CONTACT_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent on contact time
    
    SUM_CONTACTS_ANSWERED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    UI name: Contacts answered in X seconds
    
    SUM_CONTACTS_ABANDONED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    UI name: Contacts abandoned in X seconds
    
    SUM_CONTACTS_DISCONNECTED
    
    Valid metric filter key: DISCONNECT_REASON
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contact disconnected
    
    SUM_ERROR_STATUS_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Error status time
    
    SUM_HANDLE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contact handle time
    
    SUM_HOLD_TIME
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Customer hold time
    
    SUM_IDLE_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent idle time
    
    SUM_INTERACTION_AND_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent interaction and hold time
    
    SUM_INTERACTION_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent interaction time
    
    SUM_NON_PRODUCTIVE_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    UI name: Non-Productive Time
    
    SUM_ONLINE_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    UI name: Online time
    
    SUM_RETRY_CALLBACK_ATTEMPTS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    UI name: Callback attempts
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.
    
    Returns:
    
    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.
    
    ABANDONMENT_RATE
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Abandonment rate
    
    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
    
    UI name: Adherent time
    
    AGENT_ANSWER_RATE
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent answer rate
    
    AGENT_NON_ADHERENT_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Non-adherent time
    
    AGENT_NON_RESPONSE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent non-response
    
    AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    Data for this metric is available starting from October 1, 2023 0:00:00 GMT.
    
    UI name: Agent non-response without customer abandons
    
    AGENT_OCCUPANCY
    
    Unit: Percentage
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    UI name: Occupancy
    
    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
    
    UI name: Adherence
    
    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
    
    UI name: Scheduled time
    
    AVG_ABANDON_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average queue abandon time
    
    AVG_ACTIVE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Average active time
    
    AVG_AFTER_CONTACT_WORK_TIME
    
    Unit: Seconds
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average after contact work time
    
    Feature is a valid filter but not a valid grouping.
    
    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
    
    UI name: Average agent API connecting time
    
    The Negate key in Metric Level Filters is not applicable for this metric.
    
    AVG_AGENT_PAUSE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Average agent pause time
    
    AVG_CASE_RELATED_CONTACTS
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Average contacts per case
    
    AVG_CASE_RESOLUTION_TIME
    
    Unit: Seconds
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Average case resolution time
    
    AVG_CONTACT_DURATION
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average contact duration
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_CONVERSATION_DURATION
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average conversation duration
    
    AVG_GREETING_TIME_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average greeting time agent
    
    AVG_HANDLE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
    
    UI name: Average handle time
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average customer hold time
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_HOLD_TIME_ALL_CONTACTS
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average customer hold time all contacts
    
    AVG_HOLDS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average holds
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_INTERACTION_AND_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average agent interaction and customer hold time
    
    AVG_INTERACTION_TIME
    
    Unit: Seconds
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average agent interaction time
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_INTERRUPTIONS_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average interruptions agent
    
    AVG_INTERRUPTION_TIME_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average interruption time agent
    
    AVG_NON_TALK_TIME
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average non-talk time
    
    AVG_QUEUE_ANSWER_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Average queue answer time
    
    Feature is a valid filter but not a valid grouping.
    
    AVG_RESOLUTION_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    UI name: Average resolution time
    
    AVG_TALK_TIME
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average talk time
    
    AVG_TALK_TIME_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average talk time agent
    
    AVG_TALK_TIME_CUSTOMER
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Average talk time customer
    
    CASES_CREATED
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Cases created
    
    CONTACTS_ABANDONED
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
    
    UI name: Contact abandoned
    
    CONTACTS_CREATED
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts created
    
    Feature is a valid filter but not a valid grouping.
    
    CONTACTS_HANDLED
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD, DISCONNECT_REASON
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression
    
    UI name: API contacts handled
    
    Feature is a valid filter but not a valid grouping.
    
    CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT
    
    Unit: Count
    
    Valid metric filter key: INITIATION_METHOD
    
    Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts handled by Connected to agent
    
    CONTACTS_HOLD_ABANDONS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts hold disconnect
    
    CONTACTS_ON_HOLD_AGENT_DISCONNECT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts hold agent disconnect
    
    CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts hold customer disconnect
    
    CONTACTS_PUT_ON_HOLD
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts put on hold
    
    CONTACTS_TRANSFERRED_OUT_EXTERNAL
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts transferred out external
    
    CONTACTS_TRANSFERRED_OUT_INTERNAL
    
    Unit: Percent
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contacts transferred out internal
    
    CONTACTS_QUEUED
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts queued
    
    CONTACTS_QUEUED_BY_ENQUEUE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts queued by Enqueue
    
    CONTACTS_RESOLVED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    Threshold: For ThresholdValue enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    UI name: Contacts resolved in X
    
    CONTACTS_TRANSFERRED_OUT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts transferred out
    
    Feature is a valid filter but not a valid grouping.
    
    CONTACTS_TRANSFERRED_OUT_BY_AGENT
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts transferred out by agent
    
    CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contacts transferred out queue
    
    CURRENT_CASES
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Current cases
    
    MAX_QUEUED_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Maximum queued time
    
    PERCENT_CASES_FIRST_CONTACT_RESOLVED
    
    Unit: Percent
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Cases resolved on first contact
    
    PERCENT_CONTACTS_STEP_EXPIRED
    
    Unit: Percent
    
    Valid groupings and filters: Queue, RoutingStepExpression
    
    UI name: Not available
    
    PERCENT_CONTACTS_STEP_JOINED
    
    Unit: Percent
    
    Valid groupings and filters: Queue, RoutingStepExpression
    
    UI name: Not available
    
    PERCENT_NON_TALK_TIME
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Percentage
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Non-talk time percent
    
    PERCENT_TALK_TIME
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Percentage
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Talk time percent
    
    PERCENT_TALK_TIME_AGENT
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Percentage
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Talk time agent percent
    
    PERCENT_TALK_TIME_CUSTOMER
    
    This metric is available only for contacts analyzed by Contact Lens conversational analytics.
    
    Unit: Percentage
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Talk time customer percent
    
    REOPENED_CASE_ACTIONS
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Cases reopened
    
    RESOLVED_CASE_ACTIONS
    
    Unit: Count
    
    Required filter key: CASE_TEMPLATE_ARN
    
    Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS
    
    UI name: Cases resolved
    
    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").
    
    UI name: Service level X
    
    STEP_CONTACTS_QUEUED
    
    Unit: Count
    
    Valid groupings and filters: Queue, RoutingStepExpression
    
    UI name: Not available
    
    SUM_AFTER_CONTACT_WORK_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: After contact work time
    
    SUM_CONNECTING_TIME_AGENT
    
    Unit: Seconds
    
    Valid metric filter key: INITIATION_METHOD. This metric only supports the following filter keys as INITIATION_METHOD: INBOUND | OUTBOUND | CALLBACK | API
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent API connecting time
    
    The Negate key in Metric Level Filters is not applicable for this metric.
    
    SUM_CONTACT_FLOW_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contact flow time
    
    SUM_CONTACT_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent on contact time
    
    SUM_CONTACTS_ANSWERED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    UI name: Contacts answered in X seconds
    
    SUM_CONTACTS_ABANDONED_IN_X
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").
    
    UI name: Contacts abandoned in X seconds
    
    SUM_CONTACTS_DISCONNECTED
    
    Valid metric filter key: DISCONNECT_REASON
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype
    
    UI name: Contact disconnected
    
    SUM_ERROR_STATUS_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Error status time
    
    SUM_HANDLE_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Contact handle time
    
    SUM_HOLD_TIME
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Customer hold time
    
    SUM_IDLE_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent idle time
    
    SUM_INTERACTION_AND_HOLD_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent interaction and hold time
    
    SUM_INTERACTION_TIME
    
    Unit: Seconds
    
    Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
    
    UI name: Agent interaction time
    
    SUM_NON_PRODUCTIVE_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    UI name: Non-Productive Time
    
    SUM_ONLINE_TIME_AGENT
    
    Unit: Seconds
    
    Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy
    
    UI name: Online time
    
    SUM_RETRY_CALLBACK_ATTEMPTS
    
    Unit: Count
    
    Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype
    
    UI name: Callback attempts
  - nextToken
```
public final String 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:
    
    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.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return per page.
    
    Returns:
    
    The maximum number of results to return per page.
  - toBuilder
```
public GetMetricDataV2Request.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>
    
    Specified by:
    
    toBuilder in class ConnectRequest
  - builder
```
public static GetMetricDataV2Request.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetMetricDataV2Request.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetMetricDataV2Request

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

resourceArn

startTime

endTime

interval

hasFilters

filters

hasGroupings

groupings

hasMetrics

metrics

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields