Class: Aws::Connect::Types::GetCurrentMetricDataRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::Connect::Types::GetCurrentMetricDataRequest
- Defined in:
- gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#current_metrics ⇒ Array<Types::CurrentMetric>
The metrics to retrieve.
-
#filters ⇒ Types::Filters
The filters to apply to returned metrics.
-
#groupings ⇒ Array<String>
The grouping applied to the metrics returned.
-
#instance_id ⇒ String
The identifier of the Amazon Connect instance.
-
#max_results ⇒ Integer
The maximum number of results to return per page.
-
#next_token ⇒ String
The token for the next set of results.
-
#sort_criteria ⇒ Array<Types::CurrentMetricSortCriteria>
The way to sort the resulting response based on metrics.
Instance Attribute Details
#current_metrics ⇒ Array<Types::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.
- AGENTS_AFTER_CONTACT_WORK
Unit: COUNT
Name in real-time metrics report: ACW
- AGENTS_AVAILABLE
Unit: COUNT
Name in real-time metrics report: Available
- AGENTS_ERROR
Unit: COUNT
Name in real-time metrics report: Error
- AGENTS_NON_PRODUCTIVE
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
- AGENTS_ON_CALL
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ON_CONTACT
Unit: COUNT
Name in real-time metrics report: On contact
- AGENTS_ONLINE
Unit: COUNT
Name in real-time metrics report: Online
- AGENTS_STAFFED
Unit: COUNT
Name in real-time metrics report: Staffed
- CONTACTS_IN_QUEUE
Unit: COUNT
Name in real-time metrics report: In queue
- CONTACTS_SCHEDULED
Unit: COUNT
Name in real-time metrics report: Scheduled
- OLDEST_CONTACT_AGE
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not 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.
When the filter
RoutingStepExpression
is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under<Expression 1>
for 10 seconds has expired and<Expression 2>
becomes active, thenOLDEST_CONTACT_AGE
for this queue will be counted starting from 10, not 0.Name in real-time metrics report: Oldest
- SLOTS_ACTIVE
Unit: COUNT
Name in real-time metrics report: Active
- SLOTS_AVAILABLE
Unit: COUNT
Name in real-time metrics report: Availability
7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7365 class GetCurrentMetricDataRequest < Struct.new( :instance_id, :filters, :groupings, :current_metrics, :next_token, :max_results, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#filters ⇒ Types::Filters
The filters to apply to returned metrics. You can filter up to the following limits:
Queues: 100
Routing profiles: 100
Channels: 3 (VOICE, CHAT, and TASK channels are supported.)
RoutingStepExpressions: 50
Metric data is retrieved only for the resources associated with the queues or routing profiles, and by any channels included in the filter. (You cannot filter by both queue AND routing profile.) You can include both resource IDs and resource ARNs in the same request.
When using the RoutingStepExpression
filter, you need to pass
exactly one QueueId
. The filter is also case sensitive so when
using the RoutingStepExpression
filter, grouping by
ROUTING_STEP_EXPRESSION
is required.
Currently tagging is only supported on the resources that are passed in the filter.
7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7365 class GetCurrentMetricDataRequest < Struct.new( :instance_id, :filters, :groupings, :current_metrics, :next_token, :max_results, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#groupings ⇒ Array<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 you group by
ROUTING_PROFILE
, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metricsCONTACTS_SCHEDULED
,CONTACTS_IN_QUEUE
, andOLDEST_CONTACT_AGE
.If no
Grouping
is included in the request, a summary of metrics is returned.When using the
RoutingStepExpression
filter, group byROUTING_STEP_EXPRESSION
is required.
7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7365 class GetCurrentMetricDataRequest < Struct.new( :instance_id, :filters, :groupings, :current_metrics, :next_token, :max_results, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#instance_id ⇒ String
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7365 class GetCurrentMetricDataRequest < Struct.new( :instance_id, :filters, :groupings, :current_metrics, :next_token, :max_results, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#max_results ⇒ Integer
The maximum number of results to return per page.
7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7365 class GetCurrentMetricDataRequest < Struct.new( :instance_id, :filters, :groupings, :current_metrics, :next_token, :max_results, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#next_token ⇒ 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.
7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7365 class GetCurrentMetricDataRequest < Struct.new( :instance_id, :filters, :groupings, :current_metrics, :next_token, :max_results, :sort_criteria) SENSITIVE = [] include Aws::Structure end |
#sort_criteria ⇒ Array<Types::CurrentMetricSortCriteria>
The way to sort the resulting response based on metrics. You can
enter one sort criteria. By default resources are sorted based on
AGENTS_ONLINE
, DESCENDING
. The metric collection is sorted based
on the input metrics.
Note the following:
- Sorting on
SLOTS_ACTIVE
andSLOTS_AVAILABLE
is not supported.
^
7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 |
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 7365 class GetCurrentMetricDataRequest < Struct.new( :instance_id, :filters, :groupings, :current_metrics, :next_token, :max_results, :sort_criteria) SENSITIVE = [] include Aws::Structure end |