paws.customer.engagement (version 0.1.8)

connect_get_current_metric_data: Gets the real-time metric data from the specified Amazon Connect instance

Description

Gets the real-time metric data from the specified Amazon Connect instance.

Usage

connect_get_current_metric_data(InstanceId, Filters, Groupings,
  CurrentMetrics, NextToken, MaxResults)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance.

Filters

[required] 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. The only supported channel is VOICE.

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. The only supported channel is VOICE.

If no Grouping is included in the request, a summary of metrics is returned.

CurrentMetrics

[required] The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available:

AGENTS\_AFTER\_CONTACT\_WORK

Unit: COUNT

AGENTS\_AVAILABLE

Unit: COUNT

AGENTS\_ERROR

Unit: COUNT

AGENTS\_NON\_PRODUCTIVE

Unit: COUNT

AGENTS\_ON\_CALL

Unit: COUNT

AGENTS\_ON\_CONTACT

Unit: COUNT

AGENTS\_ONLINE

Unit: COUNT

AGENTS\_STAFFED

Unit: COUNT

CONTACTS\_IN\_QUEUE

Unit: COUNT

CONTACTS\_SCHEDULED

Unit: COUNT

OLDEST\_CONTACT\_AGE

Unit: SECONDS

SLOTS\_ACTIVE

Unit: COUNT

SLOTS\_AVAILABLE

Unit: COUNT

NextToken

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.

MaxResults

The maximimum number of results to return per page.

Request syntax

svc$get_current_metric_data(
  InstanceId = "string",
  Filters = list(
    Queues = list(
      "string"
    ),
    Channels = list(
      "VOICE"|"CHAT"
    )
  ),
  Groupings = list(
    "QUEUE"|"CHANNEL"
  ),
  CurrentMetrics = list(
    list(
      Name = "AGENTS_ONLINE"|"AGENTS_AVAILABLE"|"AGENTS_ON_CALL"|"AGENTS_NON_PRODUCTIVE"|"AGENTS_AFTER_CONTACT_WORK"|"AGENTS_ERROR"|"AGENTS_STAFFED"|"CONTACTS_IN_QUEUE"|"OLDEST_CONTACT_AGE"|"CONTACTS_SCHEDULED"|"AGENTS_ON_CONTACT"|"SLOTS_ACTIVE"|"SLOTS_AVAILABLE",
      Unit = "SECONDS"|"COUNT"|"PERCENT"
    )
  ),
  NextToken = "string",
  MaxResults = 123
)

Details

For more information, see Real-time Metrics Reports in the Amazon Connect Administrator Guide.