Struct aws_sdk_connect::operation::get_current_metric_data::builders::GetCurrentMetricDataFluentBuilder
source · pub struct GetCurrentMetricDataFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to GetCurrentMetricData
.
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Implementations§
source§impl GetCurrentMetricDataFluentBuilder
impl GetCurrentMetricDataFluentBuilder
sourcepub fn as_input(&self) -> &GetCurrentMetricDataInputBuilder
pub fn as_input(&self) -> &GetCurrentMetricDataInputBuilder
Access the GetCurrentMetricData as a reference.
sourcepub async fn send(
self
) -> Result<GetCurrentMetricDataOutput, SdkError<GetCurrentMetricDataError, HttpResponse>>
pub async fn send( self ) -> Result<GetCurrentMetricDataOutput, SdkError<GetCurrentMetricDataError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<GetCurrentMetricDataOutput, GetCurrentMetricDataError, Self>, SdkError<GetCurrentMetricDataError>>
pub async fn customize( self ) -> Result<CustomizableOperation<GetCurrentMetricDataOutput, GetCurrentMetricDataError, Self>, SdkError<GetCurrentMetricDataError>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> GetCurrentMetricDataPaginator
pub fn into_paginator(self) -> GetCurrentMetricDataPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a Stream
.
sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
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, input: Filters) -> Self
pub fn filters(self, input: Filters) -> Self
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.
sourcepub fn set_filters(self, input: Option<Filters>) -> Self
pub fn set_filters(self, input: Option<Filters>) -> Self
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.
sourcepub fn get_filters(&self) -> &Option<Filters>
pub fn get_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.)
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.
sourcepub fn groupings(self, input: Grouping) -> Self
pub fn groupings(self, input: Grouping) -> Self
Appends an item to Groupings
.
To override the contents of this collection use set_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 metricsCONTACTS_SCHEDULED
,CONTACTS_IN_QUEUE
, andOLDEST_CONTACT_AGE
. -
If no
Grouping
is included in the request, a summary of metrics is returned.
sourcepub fn set_groupings(self, input: Option<Vec<Grouping>>) -> Self
pub fn set_groupings(self, input: Option<Vec<Grouping>>) -> Self
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.
sourcepub fn get_groupings(&self) -> &Option<Vec<Grouping>>
pub fn get_groupings(&self) -> &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.
sourcepub fn current_metrics(self, input: CurrentMetric) -> Self
pub fn current_metrics(self, input: CurrentMetric) -> Self
Appends an item to CurrentMetrics
.
To override the contents of this collection use set_current_metrics
.
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.
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
sourcepub fn set_current_metrics(self, input: Option<Vec<CurrentMetric>>) -> Self
pub fn set_current_metrics(self, input: Option<Vec<CurrentMetric>>) -> Self
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.
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
sourcepub fn get_current_metrics(&self) -> &Option<Vec<CurrentMetric>>
pub fn get_current_metrics(&self) -> &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.
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
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
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 set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
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 get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &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.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
The maximum number of results to return per page.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
pub fn set_max_results(self, input: Option<i32>) -> Self
The maximum number of results to return per page.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
The maximum number of results to return per page.
sourcepub fn sort_criteria(self, input: CurrentMetricSortCriteria) -> Self
pub fn sort_criteria(self, input: CurrentMetricSortCriteria) -> Self
Appends an item to SortCriteria
.
To override the contents of this collection use set_sort_criteria
.
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.
sourcepub fn set_sort_criteria(
self,
input: Option<Vec<CurrentMetricSortCriteria>>
) -> Self
pub fn set_sort_criteria( self, input: Option<Vec<CurrentMetricSortCriteria>> ) -> Self
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.
sourcepub fn get_sort_criteria(&self) -> &Option<Vec<CurrentMetricSortCriteria>>
pub fn get_sort_criteria(&self) -> &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.
Trait Implementations§
source§impl Clone for GetCurrentMetricDataFluentBuilder
impl Clone for GetCurrentMetricDataFluentBuilder
source§fn clone(&self) -> GetCurrentMetricDataFluentBuilder
fn clone(&self) -> GetCurrentMetricDataFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more