class Aws::Connect::Types::GetCurrentMetricDataRequest
@note When making an API call, you may pass GetCurrentMetricDataRequest
data as a hash: { instance_id: "InstanceId", # required filters: { # required queues: ["QueueId"], channels: ["VOICE"], # accepts VOICE, CHAT, TASK }, groupings: ["QUEUE"], # accepts QUEUE, CHANNEL current_metrics: [ # required { name: "AGENTS_ONLINE", # accepts 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", # accepts SECONDS, COUNT, PERCENT }, ], next_token: "NextToken", max_results: 1, }
@!attribute [rw] instance_id
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance. @return [String]
@!attribute [rw] 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. @return [Types::Filters]
@!attribute [rw] 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. VOICE, CHAT, and TASK channels are supported. If no `Grouping` is included in the request, a summary of metrics is returned. @return [Array<String>]
@!attribute [rw] current_metrics
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][1] in the *Amazon Connect Administrator Guide*. AGENTS\_AFTER\_CONTACT\_WORK : Unit: COUNT Name in real-time metrics report: [ACW][2] AGENTS\_AVAILABLE : Unit: COUNT Name in real-time metrics report: [Available][3] AGENTS\_ERROR : Unit: COUNT Name in real-time metrics report: [Error][4] AGENTS\_NON\_PRODUCTIVE : Unit: COUNT Name in real-time metrics report: [NPT (Non-Productive Time)][5] AGENTS\_ON\_CALL : Unit: COUNT Name in real-time metrics report: [On contact][6] AGENTS\_ON\_CONTACT : Unit: COUNT Name in real-time metrics report: [On contact][6] AGENTS\_ONLINE : Unit: COUNT Name in real-time metrics report: [Online][7] AGENTS\_STAFFED : Unit: COUNT Name in real-time metrics report: [Staffed][8] CONTACTS\_IN\_QUEUE : Unit: COUNT Name in real-time metrics report: [In queue][9] CONTACTS\_SCHEDULED : Unit: COUNT Name in real-time metrics report: [Scheduled][10] OLDEST\_CONTACT\_AGE : 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": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" \}, "Value": 24113.0 `\\} The actual OLDEST\_CONTACT\_AGE is 24 seconds. Name in real-time metrics report: [Oldest][11] SLOTS\_ACTIVE : Unit: COUNT Name in real-time metrics report: [Active][12] SLOTS\_AVAILABLE : Unit: COUNT Name in real-time metrics report: [Availability][13] [1]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html [2]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time [3]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time [4]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time [5]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time [6]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time [7]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time [8]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time [9]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time [10]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time [11]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time [12]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time [13]: https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time @return [Array<Types::CurrentMetric>]
@!attribute [rw] next_token
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. @return [String]
@!attribute [rw] max_results
The maximum number of results to return per page. @return [Integer]
@see docs.aws.amazon.com/goto/WebAPI/connect-2017-08-08/GetCurrentMetricDataRequest AWS API Documentation
Constants
- SENSITIVE