public static interface GetMetricDataRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<GetMetricDataRequest.Builder,GetMetricDataRequest>
Modifier and Type  Method and Description 

GetMetricDataRequest.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.

default GetMetricDataRequest.Builder 
filters(Consumer<Filters.Builder> filters)
The queues, up to 100, or channels, to use to filter the metrics returned.

GetMetricDataRequest.Builder 
filters(Filters filters)
The queues, up to 100, or channels, to use to filter the metrics returned.

GetMetricDataRequest.Builder 
groupings(Collection<Grouping> groupings)
The grouping applied to the metrics returned.

GetMetricDataRequest.Builder 
groupings(Grouping... groupings)
The grouping applied to the metrics returned.

GetMetricDataRequest.Builder 
groupingsWithStrings(Collection<String> groupings)
The grouping applied to the metrics returned.

GetMetricDataRequest.Builder 
groupingsWithStrings(String... groupings)
The grouping applied to the metrics returned.

GetMetricDataRequest.Builder 
historicalMetrics(Collection<HistoricalMetric> historicalMetrics)
The metrics to retrieve.

GetMetricDataRequest.Builder 
historicalMetrics(Consumer<HistoricalMetric.Builder>... historicalMetrics)
The metrics to retrieve.

GetMetricDataRequest.Builder 
historicalMetrics(HistoricalMetric... historicalMetrics)
The metrics to retrieve.

GetMetricDataRequest.Builder 
instanceId(String instanceId)
The identifier of the Amazon Connect instance.

GetMetricDataRequest.Builder 
maxResults(Integer maxResults)
The maximum number of results to return per page.

GetMetricDataRequest.Builder 
nextToken(String nextToken)
The token for the next set of results.

GetMetricDataRequest.Builder 
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.

GetMetricDataRequest.Builder 
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.

GetMetricDataRequest.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.

build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
GetMetricDataRequest.Builder instanceId(String instanceId)
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
instanceId
 The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.GetMetricDataRequest.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 specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
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 specified using a multiple of 5 minutes, such as 10:05,
10:10, 10:15.
The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.
GetMetricDataRequest.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 specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
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 specified using an interval of 5 minutes, such as 11:00,
11:05, 11:10, and must be later than the start time timestamp.
The time range between the start and end time must be less than 24 hours.
GetMetricDataRequest.Builder filters(Filters filters)
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
To filter by Queues
, enter the queue ID/ARN, not the name of the queue.
filters
 The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved
only for the resources associated with the queues or channels included in the filter. You can include
both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
To filter by Queues
, enter the queue ID/ARN, not the name of the queue.
default GetMetricDataRequest.Builder filters(Consumer<Filters.Builder> filters)
The queues, up to 100, or channels, to use to filter the metrics returned. Metric data is retrieved only for the resources associated with the queues or channels included in the filter. You can include both queue IDs and queue ARNs in the same request. VOICE, CHAT, and TASK channels are supported.
To filter by Queues
, enter the queue ID/ARN, not the name of the queue.
Filters.Builder
avoiding the need to
create one manually via Filters.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to filters(Filters)
.filters
 a consumer that will call methods on Filters.Builder
filters(Filters)
GetMetricDataRequest.Builder groupingsWithStrings(Collection<String> groupings)
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
groupings
 The grouping applied to the metrics returned. For example, when results are grouped by queue, the
metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather
than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
GetMetricDataRequest.Builder groupingsWithStrings(String... groupings)
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
groupings
 The grouping applied to the metrics returned. For example, when results are grouped by queue, the
metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather
than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
GetMetricDataRequest.Builder groupings(Collection<Grouping> groupings)
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
groupings
 The grouping applied to the metrics returned. For example, when results are grouped by queue, the
metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather
than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
GetMetricDataRequest.Builder groupings(Grouping... groupings)
The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
groupings
 The grouping applied to the metrics returned. For example, when results are grouped by queue, the
metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather
than aggregated for all queues.
If no grouping is specified, a summary of metrics for all queues is returned.
GetMetricDataRequest.Builder historicalMetrics(Collection<HistoricalMetric> historicalMetrics)
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds.
For Comparison
, you must enter LT
(for "Less than").
historicalMetrics
 The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following
historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide. This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in
seconds. For Comparison
, you must enter LT
(for "Less than").
GetMetricDataRequest.Builder historicalMetrics(HistoricalMetric... historicalMetrics)
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds.
For Comparison
, you must enter LT
(for "Less than").
historicalMetrics
 The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following
historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide. This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in
seconds. For Comparison
, you must enter LT
(for "Less than").
GetMetricDataRequest.Builder historicalMetrics(Consumer<HistoricalMetric.Builder>... historicalMetrics)
The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.
This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: COUNT
Statistic: SUM
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: PERCENT
Statistic: AVG
Unit: SECONDS
Statistic: AVG
Unit: SECONDS
Statistic: MAX
You can include up to 20 SERVICE_LEVEL metrics in a request.
Unit: PERCENT
Statistic: AVG
Threshold: For ThresholdValue
, enter any whole number from 1 to 604800 (inclusive), in seconds.
For Comparison
, you must enter LT
(for "Less than").
List.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #historicalMetrics(List)
.historicalMetrics
 a consumer that will call methods on List.Builder
#historicalMetrics(List)
GetMetricDataRequest.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.
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.GetMetricDataRequest.Builder maxResults(Integer maxResults)
The maximum number of results to return per page.
maxResults
 The maximum number of results to return per page.GetMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
 The override configuration.GetMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
 A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.