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 StartTime timestamp.

The time range between StartTime and EndTime must be less than 24 hours.

filters: Filters

A Filters object that contains a list of queue IDs or queue ARNs, up to 100, or a list of Channels to use to filter the metrics returned in the response. Metric data is retrieved only for the resources associated with the IDs, ARNs, or Channels included in the filter. You can use both IDs and ARNs together in a request. Only VOICE is supported for Channel.

To find the ARN for a queue, open the queue you want to use in the Amazon Connect Queue editor. The ARN for the queue is displayed in the address bar as part of the URL. For example, the queue ARN is the set of characters at the end of the URL, after 'id=' such as arn:aws:connect:us-east-1:270923740243:instance/78fb859d-1b7d-44b1-8aa3-12f0835c5855/queue/1d1a4575-9618-40ab-bbeb-81e45795fe61. The queue ID is also included in the URL, and is the string after 'queue/'.

groupings: Option<Vec<String>>

The grouping applied to the metrics returned. For example, when results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

The current version supports grouping by Queue

If no Grouping is included in the request, a summary of HistoricalMetrics for all queues is returned.

historical_metrics: Vec<HistoricalMetric>

A list of HistoricalMetric objects that contain the metrics to retrieve with the request.

A HistoricalMetric object contains: HistoricalMetricName, Statistic, Threshold, and Unit.

You must list each metric to retrieve data for in the request. For each historical metric you include in the request, you must include a Unit and a Statistic.

The following historical metrics are available:

CONTACTSQUEUED

Unit: COUNT

Statistic: SUM

CONTACTSHANDLED

Unit: COUNT

Statistics: SUM

CONTACTSABANDONED

Unit: COUNT

Statistics: SUM

CONTACTSCONSULTED

Unit: COUNT

Statistics: SUM

CONTACTSAGENTHUNGUPFIRST

Unit: COUNT

Statistics: SUM

CONTACTSHANDLEDINCOMING

Unit: COUNT

Statistics: SUM

CONTACTSHANDLEDOUTBOUND

Unit: COUNT

Statistics: SUM

CONTACTSHOLDABANDONS

Unit: COUNT

Statistics: SUM

CONTACTSTRANSFERREDIN

Unit: COUNT

Statistics: SUM

CONTACTSTRANSFERREDOUT

Unit: COUNT

Statistics: SUM

CONTACTSTRANSFERREDINFROMQUEUE

Unit: COUNT

Statistics: SUM

CONTACTSTRANSFERREDOUTFROMQUEUE

Unit: COUNT

Statistics: SUM

CALLBACKCONTACTSHANDLED

Unit: COUNT

Statistics: SUM

CALLBACKCONTACTSHANDLED

Unit: COUNT

Statistics: SUM

APICONTACTSHANDLED

Unit: COUNT

Statistics: SUM

CONTACTSMISSED

Unit: COUNT

Statistics: SUM

OCCUPANCY

Unit: PERCENT

Statistics: AVG

HANDLETIME

Unit: SECONDS

Statistics: AVG

AFTERCONTACTWORKTIME

Unit: SECONDS

Statistics: AVG

QUEUEDTIME

Unit: SECONDS

Statistics: MAX

ABANDONTIME

Unit: COUNT

Statistics: SUM

QUEUEANSWERTIME

Unit: SECONDS

Statistics: AVG

HOLDTIME

Unit: SECONDS

Statistics: AVG

INTERACTIONTIME

Unit: SECONDS

Statistics: AVG

INTERACTIONANDHOLDTIME

Unit: SECONDS

Statistics: AVG

SERVICE_LEVEL

Unit: PERCENT

Statistics: AVG

Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

instance_id: String

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

max_results: Option<i64>

Indicates the maximum number of results to return per page in the response, between 1-100.

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.

StartTime cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.

Trait Implementations

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 Default for GetMetricDataRequest

fn default() -> GetMetricDataRequest

Returns the "default value" for a type.

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