Struct rusoto_connect::GetMetricDataRequest

pub struct GetMetricDataRequest {
    pub end_time: f64,
    pub filters: Filters,
    pub groupings: Option<Vec<String>>,
    pub historical_metrics: Vec<HistoricalMetric>,
    pub instance_id: String,
    pub max_results: Option<i64>,
    pub next_token: Option<String>,
    pub start_time: f64,
}

Fields

end_time: f64

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.

filters: 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.

groupings: Option<Vec<String>>

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.

historical_metrics: Vec<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 CONTACTSINCOMING metric missing from the documented list).

ABANDONTIME

Unit: SECONDS

Statistic: AVG

AFTERCONTACTWORKTIME

Unit: SECONDS

Statistic: AVG

APICONTACTSHANDLED

Unit: COUNT

Statistic: SUM

CALLBACKCONTACTSHANDLED

Unit: COUNT

Statistic: SUM

CONTACTSABANDONED

Unit: COUNT

Statistic: SUM

CONTACTSAGENTHUNGUPFIRST

Unit: COUNT

Statistic: SUM

CONTACTSCONSULTED

Unit: COUNT

Statistic: SUM

CONTACTSHANDLED

Unit: COUNT

Statistic: SUM

CONTACTSHANDLEDINCOMING

Unit: COUNT

Statistic: SUM

CONTACTSHANDLEDOUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTSHOLDABANDONS

Unit: COUNT

Statistic: SUM

CONTACTSMISSED

Unit: COUNT

Statistic: SUM

CONTACTSQUEUED

Unit: COUNT

Statistic: SUM

CONTACTSTRANSFERREDIN

Unit: COUNT

Statistic: SUM

CONTACTSTRANSFERREDINFROMQUEUE

Unit: COUNT

Statistic: SUM

CONTACTSTRANSFERREDOUT

Unit: COUNT

Statistic: SUM

CONTACTSTRANSFERREDOUTFROMQUEUE

Unit: COUNT

Statistic: SUM

HANDLETIME

Unit: SECONDS

Statistic: AVG

HOLDTIME

Unit: SECONDS

Statistic: AVG

INTERACTIONANDHOLDTIME

Unit: SECONDS

Statistic: AVG

INTERACTIONTIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUEANSWERTIME

Unit: SECONDS

Statistic: AVG

QUEUEDTIME

Unit: SECONDS

Statistic: MAX

SERVICELEVEL

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. For Comparison, you must enter LT (for "Less than").

instance_id: String

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

max_results: Option<i64>

The maximum number of results to return per page.

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.

start_time: f64

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.

Trait Implementations

impl Clone for GetMetricDataRequest

fn clone(&self) -> GetMetricDataRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetMetricDataRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetMetricDataRequest

fn default() -> GetMetricDataRequest

Returns the “default value” for a type.

impl PartialEq<GetMetricDataRequest> for GetMetricDataRequest

fn eq(&self, other: &GetMetricDataRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GetMetricDataRequest) -> bool

This method tests for !=.

impl Serialize for GetMetricDataRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetMetricDataRequest