Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Gets the real-time metric data from the specified Amazon Connect instance.
For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Synopsis
- data GetCurrentMetricData = GetCurrentMetricData' {}
- newGetCurrentMetricData :: Text -> Filters -> GetCurrentMetricData
- getCurrentMetricData_groupings :: Lens' GetCurrentMetricData (Maybe [Grouping])
- getCurrentMetricData_maxResults :: Lens' GetCurrentMetricData (Maybe Natural)
- getCurrentMetricData_nextToken :: Lens' GetCurrentMetricData (Maybe Text)
- getCurrentMetricData_sortCriteria :: Lens' GetCurrentMetricData (Maybe [CurrentMetricSortCriteria])
- getCurrentMetricData_instanceId :: Lens' GetCurrentMetricData Text
- getCurrentMetricData_filters :: Lens' GetCurrentMetricData Filters
- getCurrentMetricData_currentMetrics :: Lens' GetCurrentMetricData [CurrentMetric]
- data GetCurrentMetricDataResponse = GetCurrentMetricDataResponse' {}
- newGetCurrentMetricDataResponse :: Int -> GetCurrentMetricDataResponse
- getCurrentMetricDataResponse_approximateTotalCount :: Lens' GetCurrentMetricDataResponse (Maybe Integer)
- getCurrentMetricDataResponse_dataSnapshotTime :: Lens' GetCurrentMetricDataResponse (Maybe UTCTime)
- getCurrentMetricDataResponse_metricResults :: Lens' GetCurrentMetricDataResponse (Maybe [CurrentMetricResult])
- getCurrentMetricDataResponse_nextToken :: Lens' GetCurrentMetricDataResponse (Maybe Text)
- getCurrentMetricDataResponse_httpStatus :: Lens' GetCurrentMetricDataResponse Int
Creating a Request
data GetCurrentMetricData Source #
See: newGetCurrentMetricData
smart constructor.
GetCurrentMetricData' | |
|
Instances
newGetCurrentMetricData Source #
Create a value of GetCurrentMetricData
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:groupings:GetCurrentMetricData'
, getCurrentMetricData_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 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.
$sel:maxResults:GetCurrentMetricData'
, getCurrentMetricData_maxResults
- The maximum number of results to return per page.
GetCurrentMetricData
, getCurrentMetricData_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.
$sel:sortCriteria:GetCurrentMetricData'
, getCurrentMetricData_sortCriteria
- 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.
GetCurrentMetricData
, getCurrentMetricData_instanceId
- The identifier of the Amazon Connect instance. You can find the
instanceId in the ARN of the instance.
$sel:filters:GetCurrentMetricData'
, getCurrentMetricData_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.)
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.
Currently tagging is only supported on the resources that are passed in the filter.
$sel:currentMetrics:GetCurrentMetricData'
, getCurrentMetricData_currentMetrics
- 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.
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
Request Lenses
getCurrentMetricData_groupings :: Lens' GetCurrentMetricData (Maybe [Grouping]) Source #
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.
getCurrentMetricData_maxResults :: Lens' GetCurrentMetricData (Maybe Natural) Source #
The maximum number of results to return per page.
getCurrentMetricData_nextToken :: Lens' GetCurrentMetricData (Maybe Text) Source #
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.
getCurrentMetricData_sortCriteria :: Lens' GetCurrentMetricData (Maybe [CurrentMetricSortCriteria]) Source #
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.
getCurrentMetricData_instanceId :: Lens' GetCurrentMetricData Text Source #
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
getCurrentMetricData_filters :: Lens' GetCurrentMetricData Filters Source #
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.)
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.
Currently tagging is only supported on the resources that are passed in the filter.
getCurrentMetricData_currentMetrics :: Lens' GetCurrentMetricData [CurrentMetric] Source #
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.
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
Destructuring the Response
data GetCurrentMetricDataResponse Source #
See: newGetCurrentMetricDataResponse
smart constructor.
GetCurrentMetricDataResponse' | |
|
Instances
newGetCurrentMetricDataResponse Source #
Create a value of GetCurrentMetricDataResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:approximateTotalCount:GetCurrentMetricDataResponse'
, getCurrentMetricDataResponse_approximateTotalCount
- The total count of the result, regardless of the current page size.
$sel:dataSnapshotTime:GetCurrentMetricDataResponse'
, getCurrentMetricDataResponse_dataSnapshotTime
- The time at which the metrics were retrieved and cached for pagination.
$sel:metricResults:GetCurrentMetricDataResponse'
, getCurrentMetricDataResponse_metricResults
- Information about the real-time metrics.
GetCurrentMetricData
, getCurrentMetricDataResponse_nextToken
- If there are additional results, this is the token for 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.
$sel:httpStatus:GetCurrentMetricDataResponse'
, getCurrentMetricDataResponse_httpStatus
- The response's http status code.
Response Lenses
getCurrentMetricDataResponse_approximateTotalCount :: Lens' GetCurrentMetricDataResponse (Maybe Integer) Source #
The total count of the result, regardless of the current page size.
getCurrentMetricDataResponse_dataSnapshotTime :: Lens' GetCurrentMetricDataResponse (Maybe UTCTime) Source #
The time at which the metrics were retrieved and cached for pagination.
getCurrentMetricDataResponse_metricResults :: Lens' GetCurrentMetricDataResponse (Maybe [CurrentMetricResult]) Source #
Information about the real-time metrics.
getCurrentMetricDataResponse_nextToken :: Lens' GetCurrentMetricDataResponse (Maybe Text) Source #
If there are additional results, this is the token for 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.
getCurrentMetricDataResponse_httpStatus :: Lens' GetCurrentMetricDataResponse Int Source #
The response's http status code.