public static interface GetCurrentMetricDataRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<GetCurrentMetricDataRequest.Builder,GetCurrentMetricDataRequest>
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildGetCurrentMetricDataRequest.Builder instanceId(String instanceId)
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
instanceId - The identifier of the Amazon Connect instance. You can find the instance
ID in the Amazon Resource Name (ARN) of the instance.GetCurrentMetricDataRequest.Builder filters(Filters filters)
The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
Currently tagging is only supported on the resources that are passed in the filter.
filters - The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
Currently tagging is only supported on the resources that are passed in the filter.
default GetCurrentMetricDataRequest.Builder filters(Consumer<Filters.Builder> filters)
The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
Currently tagging is only supported on the resources that are passed in the filter.
This is a convenience method that creates an instance of theFilters.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.Builderfilters(Filters)GetCurrentMetricDataRequest.Builder groupingsWithStrings(Collection<String> groupings)
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics
returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels
are supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.
groupings - The grouping applied to the metrics returned. For example, when grouped by QUEUE, the
metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
channels are supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile
filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.
GetCurrentMetricDataRequest.Builder groupingsWithStrings(String... groupings)
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics
returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels
are supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.
groupings - The grouping applied to the metrics returned. For example, when grouped by QUEUE, the
metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
channels are supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile
filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.
GetCurrentMetricDataRequest.Builder groupings(Collection<Grouping> groupings)
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics
returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels
are supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.
groupings - The grouping applied to the metrics returned. For example, when grouped by QUEUE, the
metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
channels are supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile
filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.
GetCurrentMetricDataRequest.Builder groupings(Grouping... groupings)
The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics
returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK channels
are supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile filter. In
addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.
groupings - The grouping applied to the metrics returned. For example, when grouped by QUEUE, the
metrics returned apply to each queue rather than aggregated for all queues.
If you group by CHANNEL, you should include a Channels filter. VOICE, CHAT, and TASK
channels are supported.
If you group by ROUTING_PROFILE, you must include either a queue or routing profile
filter. In addition, a routing profile filter is required for metrics CONTACTS_SCHEDULED,
CONTACTS_IN_QUEUE, and OLDEST_CONTACT_AGE.
If no Grouping is included in the request, a summary of metrics is returned.
GetCurrentMetricDataRequest.Builder currentMetrics(Collection<CurrentMetric> currentMetrics)
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
currentMetrics - The metrics to retrieve. Specify the name and unit for each metric. The following metrics are
available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
GetCurrentMetricDataRequest.Builder currentMetrics(CurrentMetric... currentMetrics)
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
currentMetrics - The metrics to retrieve. Specify the name and unit for each metric. The following metrics are
available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
GetCurrentMetricDataRequest.Builder currentMetrics(Consumer<CurrentMetric.Builder>... currentMetrics)
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
CurrentMetric.Builder avoiding the need to create one
manually via CurrentMetric.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #currentMetrics(List.
currentMetrics - a consumer that will call methods on
CurrentMetric.Builder#currentMetrics(java.util.Collection) GetCurrentMetricDataRequest.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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
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.
The token expires after 5 minutes from the time it is created. Subsequent requests that use the token must use the same request parameters as the request that generated the token.
GetCurrentMetricDataRequest.Builder maxResults(Integer maxResults)
The maximum number of results to return per page.
maxResults - The maximum number of results to return per page.GetCurrentMetricDataRequest.Builder sortCriteria(Collection<CurrentMetricSortCriteria> sortCriteria)
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is
sorted based on the input metrics.
Note the following:
Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
sortCriteria - The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric
collection is sorted based on the input metrics.
Note the following:
Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
GetCurrentMetricDataRequest.Builder sortCriteria(CurrentMetricSortCriteria... sortCriteria)
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is
sorted based on the input metrics.
Note the following:
Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
sortCriteria - The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric
collection is sorted based on the input metrics.
Note the following:
Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
GetCurrentMetricDataRequest.Builder sortCriteria(Consumer<CurrentMetricSortCriteria.Builder>... sortCriteria)
The way to sort the resulting response based on metrics. You can enter one sort criteria. By default
resources are sorted based on AGENTS_ONLINE, DESCENDING. The metric collection is
sorted based on the input metrics.
Note the following:
Sorting on SLOTS_ACTIVE and SLOTS_AVAILABLE is not supported.
CurrentMetricSortCriteria.Builder avoiding the need to
create one manually via
CurrentMetricSortCriteria.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #sortCriteria(List.
sortCriteria - a consumer that will call methods on
CurrentMetricSortCriteria.Builder#sortCriteria(java.util.Collection) GetCurrentMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderGetCurrentMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.