Interface GetMetricDataRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,ConnectRequest.Builder
,CopyableBuilder<GetMetricDataRequest.Builder,
,GetMetricDataRequest> SdkBuilder<GetMetricDataRequest.Builder,
,GetMetricDataRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetMetricDataRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe 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.The queues, up to 100, or channels, to use to filter the metrics returned.groupings
(Collection<Grouping> groupings) The grouping applied to the metrics returned.The grouping applied to the metrics returned.groupingsWithStrings
(String... groupings) The grouping applied to the metrics returned.groupingsWithStrings
(Collection<String> groupings) The grouping applied to the metrics returned.historicalMetrics
(Collection<HistoricalMetric> historicalMetrics) The metrics to retrieve.historicalMetrics
(Consumer<HistoricalMetric.Builder>... historicalMetrics) The metrics to retrieve.historicalMetrics
(HistoricalMetric... historicalMetrics) The metrics to retrieve.instanceId
(String instanceId) The identifier of the Amazon Connect instance.maxResults
(Integer maxResults) The maximum number of results to return per page.The token for the next set of results.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
instanceId
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Parameters:
instanceId
- The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
To filter by
Queues
, enter the queue ID/ARN, not the name of the queue.- Parameters:
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.RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
To filter by
Queues
, enter the queue ID/ARN, not the name of the queue.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
To filter by
Queues
, enter the queue ID/ARN, not the name of the queue.Filters.Builder
avoiding the need to create one manually viaFilters.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(Filters)
.- Parameters:
filters
- a consumer that will call methods onFilters.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
groupingsWithStrings
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
- Parameters:
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupingsWithStrings
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
- Parameters:
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
- Parameters:
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
- Parameters:
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.
RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 Metrics definition 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).
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
- AVG_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
- SERVICE_LEVEL
-
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. ForComparison
, you must enterLT
(for "Less than").UI name: Average queue abandon time
- Parameters:
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 Metrics definition 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).
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
- AVG_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
- SERVICE_LEVEL
-
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. ForComparison
, you must enterLT
(for "Less than").UI name: Average queue abandon time
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 Metrics definition 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).
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
- AVG_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
- SERVICE_LEVEL
-
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. ForComparison
, you must enterLT
(for "Less than").UI name: Average queue abandon time
- Parameters:
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 Metrics definition 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).
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
- AVG_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
- SERVICE_LEVEL
-
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. ForComparison
, you must enterLT
(for "Less than").UI name: Average queue abandon time
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
historicalMetrics
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 Metrics definition 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).
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue abandon time
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: After contact work time
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: API contacts handled
- AVG_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average customer hold time
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Callback contacts handled
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts abandoned
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
UI name: Contacts agent hung up first
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts consulted
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled incoming
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
UI name: Contacts handled outbound
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
UI name: Contacts hold disconnect
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
UI name: AGENT_NON_RESPONSE
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
UI name: Contacts queued
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred in
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
UI name: Contacts transferred out queue
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average handle time
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average agent interaction time
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
UI name: Occupancy
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
UI name: Average queue answer time
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
UI name: Minimum flow time
- SERVICE_LEVEL
-
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. ForComparison
, you must enterLT
(for "Less than").UI name: Average queue abandon time
HistoricalMetric.Builder
avoiding the need to create one manually viaHistoricalMetric.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohistoricalMetrics(List<HistoricalMetric>)
.- Parameters:
historicalMetrics
- a consumer that will call methods onHistoricalMetric.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
GetMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-