#[non_exhaustive]pub struct GetCurrentMetricDataInput {
pub instance_id: Option<String>,
pub filters: Option<Filters>,
pub groupings: Option<Vec<Grouping>>,
pub current_metrics: Option<Vec<CurrentMetric>>,
pub next_token: Option<String>,
pub max_results: Option<i32>,
pub sort_criteria: Option<Vec<CurrentMetricSortCriteria>>,
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.instance_id: Option<String>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
filters: Option<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.)
-
RoutingStepExpressions: 50
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.
When using the RoutingStepExpression
filter, you need to pass exactly one QueueId
. The filter is also case sensitive so when using the RoutingStepExpression
filter, grouping by ROUTING_STEP_EXPRESSION
is required.
Currently tagging is only supported on the resources that are passed in the filter.
groupings: Option<Vec<Grouping>>
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 metricsCONTACTS_SCHEDULED
,CONTACTS_IN_QUEUE
, andOLDEST_CONTACT_AGE
. -
If no
Grouping
is included in the request, a summary of metrics is returned. -
When using the
RoutingStepExpression
filter, group byROUTING_STEP_EXPRESSION
is required.
current_metrics: Option<Vec<CurrentMetric>>
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.
- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
-
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
-
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
-
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
-
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
-
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
-
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.
When the filter
RoutingStepExpression
is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under
for 10 seconds has expired and
becomes active, thenOLDEST_CONTACT_AGE
for this queue will be counted starting from 10, not 0.Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
-
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Availability
next_token: Option<String>
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.
max_results: Option<i32>
The maximum number of results to return per page.
sort_criteria: Option<Vec<CurrentMetricSortCriteria>>
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
andSLOTS_AVAILABLE
is not supported.
Implementations§
source§impl GetCurrentMetricDataInput
impl GetCurrentMetricDataInput
sourcepub fn instance_id(&self) -> Option<&str>
pub fn instance_id(&self) -> Option<&str>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
sourcepub fn filters(&self) -> Option<&Filters>
pub fn filters(&self) -> Option<&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.)
-
RoutingStepExpressions: 50
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.
When using the RoutingStepExpression
filter, you need to pass exactly one QueueId
. The filter is also case sensitive so when using the RoutingStepExpression
filter, grouping by ROUTING_STEP_EXPRESSION
is required.
Currently tagging is only supported on the resources that are passed in the filter.
sourcepub fn groupings(&self) -> &[Grouping]
pub fn groupings(&self) -> &[Grouping]
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 metricsCONTACTS_SCHEDULED
,CONTACTS_IN_QUEUE
, andOLDEST_CONTACT_AGE
. -
If no
Grouping
is included in the request, a summary of metrics is returned. -
When using the
RoutingStepExpression
filter, group byROUTING_STEP_EXPRESSION
is required.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .groupings.is_none()
.
sourcepub fn current_metrics(&self) -> &[CurrentMetric]
pub fn current_metrics(&self) -> &[CurrentMetric]
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.
- AGENTS_AFTER_CONTACT_WORK
-
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
-
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
-
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
-
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
-
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
-
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
-
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
-
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
-
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.
When the filter
RoutingStepExpression
is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under
for 10 seconds has expired and
becomes active, thenOLDEST_CONTACT_AGE
for this queue will be counted starting from 10, not 0.Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
-
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
-
Unit: COUNT
Name in real-time metrics report: Availability
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .current_metrics.is_none()
.
sourcepub fn next_token(&self) -> Option<&str>
pub fn next_token(&self) -> Option<&str>
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.
sourcepub fn max_results(&self) -> Option<i32>
pub fn max_results(&self) -> Option<i32>
The maximum number of results to return per page.
sourcepub fn sort_criteria(&self) -> &[CurrentMetricSortCriteria]
pub fn sort_criteria(&self) -> &[CurrentMetricSortCriteria]
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
andSLOTS_AVAILABLE
is not supported.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sort_criteria.is_none()
.
source§impl GetCurrentMetricDataInput
impl GetCurrentMetricDataInput
sourcepub fn builder() -> GetCurrentMetricDataInputBuilder
pub fn builder() -> GetCurrentMetricDataInputBuilder
Creates a new builder-style object to manufacture GetCurrentMetricDataInput
.
Trait Implementations§
source§impl Clone for GetCurrentMetricDataInput
impl Clone for GetCurrentMetricDataInput
source§fn clone(&self) -> GetCurrentMetricDataInput
fn clone(&self) -> GetCurrentMetricDataInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for GetCurrentMetricDataInput
impl Debug for GetCurrentMetricDataInput
source§impl PartialEq for GetCurrentMetricDataInput
impl PartialEq for GetCurrentMetricDataInput
source§fn eq(&self, other: &GetCurrentMetricDataInput) -> bool
fn eq(&self, other: &GetCurrentMetricDataInput) -> bool
self
and other
values to be equal, and is used
by ==
.