GetMetricDataV2Request.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>, SdkBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetMetricDataV2Request
```
public static interface GetMetricDataV2Request.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<GetMetricDataV2Request.Builder,GetMetricDataV2Request>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`GetMetricDataV2Request.Builder`	`endTime(Instant endTime)` The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data.
`GetMetricDataV2Request.Builder`	`filters(Collection<FilterV2> filters)` The filters to apply to returned metrics.
`GetMetricDataV2Request.Builder`	`filters(Consumer<FilterV2.Builder>... filters)` The filters to apply to returned metrics.
`GetMetricDataV2Request.Builder`	`filters(FilterV2... filters)` The filters to apply to returned metrics.
`GetMetricDataV2Request.Builder`	`groupings(Collection<String> groupings)` The grouping applied to the metrics that are returned.
`GetMetricDataV2Request.Builder`	`groupings(String... groupings)` The grouping applied to the metrics that are returned.
`GetMetricDataV2Request.Builder`	`maxResults(Integer maxResults)` The maximum number of results to return per page.
`GetMetricDataV2Request.Builder`	`metrics(Collection<MetricV2> metrics)` The metrics to retrieve.
`GetMetricDataV2Request.Builder`	`metrics(Consumer<MetricV2.Builder>... metrics)` The metrics to retrieve.
`GetMetricDataV2Request.Builder`	`metrics(MetricV2... metrics)` The metrics to retrieve.
`GetMetricDataV2Request.Builder`	`nextToken(String nextToken)` The token for the next set of results.
`GetMetricDataV2Request.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`GetMetricDataV2Request.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`GetMetricDataV2Request.Builder`	`resourceArn(String resourceArn)` The Amazon Resource Name (ARN) of the resource.
`GetMetricDataV2Request.Builder`	`startTime(Instant startTime)` The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data.

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - resourceArn
```
GetMetricDataV2Request.Builder resourceArn(String resourceArn)
```
    The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
    
    Parameters:
    
    resourceArn - The Amazon Resource Name (ARN) of the resource. This includes the instanceId an Amazon Connect instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - startTime
```
GetMetricDataV2Request.Builder startTime(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 time range between the start and end time must be less than 24 hours. The start time cannot be earlier than 14 days before the time of the request. Historical metrics are available for 14 days.
    
    Parameters:
    
    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 14 days before the time of the request. Historical metrics are available for 14 days.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - endTime
```
GetMetricDataV2Request.Builder endTime(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.
    
    The time range between the start and end time must be less than 24 hours.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
GetMetricDataV2Request.Builder filters(Collection<FilterV2> 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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
GetMetricDataV2Request.Builder filters(FilterV2... 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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
GetMetricDataV2Request.Builder filters(Consumer<FilterV2.Builder>... 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.
    This is a convenience method that creates an instance of the FilterV2.Builder avoiding the need to create one manually via FilterV2.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #filters(List).
    Parameters:
    
    filters - a consumer that will call methods on FilterV2.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #filters(java.util.Collection)
  - groupings
```
GetMetricDataV2Request.Builder groupings(Collection<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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - groupings
```
GetMetricDataV2Request.Builder groupings(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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - metrics
```
GetMetricDataV2Request.Builder metrics(Collection<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.
    
    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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - metrics
```
GetMetricDataV2Request.Builder metrics(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.
    
    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
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - metrics
```
GetMetricDataV2Request.Builder metrics(Consumer<MetricV2.Builder>... 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
    
    This is a convenience method that creates an instance of the MetricV2.Builder avoiding the need to create one manually via MetricV2.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #metrics(List).
    
    Parameters:
    
    metrics - a consumer that will call methods on MetricV2.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #metrics(java.util.Collection)
  - nextToken
```
GetMetricDataV2Request.Builder nextToken(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - maxResults
```
GetMetricDataV2Request.Builder maxResults(Integer maxResults)
```
    The maximum number of results to return per page.
    
    Parameters:
    
    maxResults - The maximum number of results to return per page.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
GetMetricDataV2Request.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
GetMetricDataV2Request.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface GetMetricDataV2Request.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

resourceArn

startTime

endTime

filters

filters

filters

groupings

groupings

metrics

metrics

metrics

nextToken

maxResults

overrideConfiguration

overrideConfiguration