Struct rusoto_connect::GetCurrentMetricDataRequest

pub struct GetCurrentMetricDataRequest {
    pub current_metrics: Vec<CurrentMetric>,
    pub filters: Filters,
    pub groupings: Option<Vec<String>>,
    pub instance_id: String,
    pub max_results: Option<i64>,
    pub next_token: Option<String>,
}

Fields

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

AGENTSAFTERCONTACTWORK

Unit: COUNT

Name in real-time metrics report: ACW

AGENTSAVAILABLE

Unit: COUNT

Name in real-time metrics report: Available

AGENTSERROR

Unit: COUNT

Name in real-time metrics report: Error

AGENTSNONPRODUCTIVE

Unit: COUNT

Name in real-time metrics report: NPT (Non-Productive Time)

AGENTSONCALL

Unit: COUNT

Name in real-time metrics report: On contact

AGENTSONCONTACT

Unit: COUNT

Name in real-time metrics report: On contact

AGENTSONLINE

Unit: COUNT

Name in real-time metrics report: Online

AGENTSSTAFFED

Unit: COUNT

Name in real-time metrics report: Staffed

CONTACTSINQUEUE

Unit: COUNT

Name in real-time metrics report: In queue

CONTACTSSCHEDULED

Unit: COUNT

Name in real-time metrics report: Scheduled

OLDESTCONTACTAGE

Unit: SECONDS

When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

{ "Metric": { "Name": "OLDESTCONTACTAGE", "Unit": "SECONDS" }, "Value": 24113.0 }

The actual OLDESTCONTACTAGE is 24 seconds.

Name in real-time metrics report: Oldest

SLOTSACTIVE

Unit: COUNT

Name in real-time metrics report: Active

SLOTSAVAILABLE

Unit: COUNT

Name in real-time metrics report: Availability

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.

groupings: Option<Vec<String>>

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 no Grouping is included in the request, a summary of metrics is returned.

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.

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.

Trait Implementations

impl Clone for GetCurrentMetricDataRequest

fn clone(&self) -> GetCurrentMetricDataRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetCurrentMetricDataRequest

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

Formats the value using the given formatter.

impl Default for GetCurrentMetricDataRequest

fn default() -> GetCurrentMetricDataRequest

Returns the “default value” for a type.

impl PartialEq<GetCurrentMetricDataRequest> for GetCurrentMetricDataRequest

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

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

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

This method tests for !=.

impl Serialize for GetCurrentMetricDataRequest

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 GetCurrentMetricDataRequest