Struct aws_sdk_connect::input::GetMetricDataInput
source · #[non_exhaustive]pub struct GetMetricDataInput { /* private fields */ }Implementations§
source§impl GetMetricDataInput
impl GetMetricDataInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetMetricData, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<GetMetricData, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<GetMetricData>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture GetMetricDataInput.
source§impl GetMetricDataInput
impl GetMetricDataInput
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 instanceId in the ARN of the instance.
sourcepub fn start_time(&self) -> Option<&DateTime>
pub fn start_time(&self) -> Option<&DateTime>
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.
sourcepub fn end_time(&self) -> Option<&DateTime>
pub fn end_time(&self) -> Option<&DateTime>
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.
sourcepub fn filters(&self) -> Option<&Filters>
pub fn filters(&self) -> Option<&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.
sourcepub fn groupings(&self) -> Option<&[Grouping]>
pub fn groupings(&self) -> Option<&[Grouping]>
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.
sourcepub fn historical_metrics(&self) -> Option<&[HistoricalMetric]>
pub fn historical_metrics(&self) -> Option<&[HistoricalMetric]>
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).
- ABANDON_TIME
-
Unit: SECONDS
Statistic: AVG
- AFTER_CONTACT_WORK_TIME
-
Unit: SECONDS
Statistic: AVG
- API_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
- CALLBACK_CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_ABANDONED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_AGENT_HUNG_UP_FIRST
-
Unit: COUNT
Statistic: SUM
- CONTACTS_CONSULTED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED_INCOMING
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HANDLED_OUTBOUND
-
Unit: COUNT
Statistic: SUM
- CONTACTS_HOLD_ABANDONS
-
Unit: COUNT
Statistic: SUM
- CONTACTS_MISSED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_QUEUED
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_IN
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_IN_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_OUT
-
Unit: COUNT
Statistic: SUM
- CONTACTS_TRANSFERRED_OUT_FROM_QUEUE
-
Unit: COUNT
Statistic: SUM
- HANDLE_TIME
-
Unit: SECONDS
Statistic: AVG
- HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_AND_HOLD_TIME
-
Unit: SECONDS
Statistic: AVG
- INTERACTION_TIME
-
Unit: SECONDS
Statistic: AVG
- OCCUPANCY
-
Unit: PERCENT
Statistic: AVG
- QUEUE_ANSWER_TIME
-
Unit: SECONDS
Statistic: AVG
- QUEUED_TIME
-
Unit: SECONDS
Statistic: MAX
- 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").
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.
sourcepub fn max_results(&self) -> Option<i32>
pub fn max_results(&self) -> Option<i32>
The maximum number of results to return per page.
Trait Implementations§
source§impl Clone for GetMetricDataInput
impl Clone for GetMetricDataInput
source§fn clone(&self) -> GetMetricDataInput
fn clone(&self) -> GetMetricDataInput
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moresource§impl Debug for GetMetricDataInput
impl Debug for GetMetricDataInput
source§impl PartialEq<GetMetricDataInput> for GetMetricDataInput
impl PartialEq<GetMetricDataInput> for GetMetricDataInput
source§fn eq(&self, other: &GetMetricDataInput) -> bool
fn eq(&self, other: &GetMetricDataInput) -> bool
self and other values to be equal, and is used
by ==.