Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Connect.GetCurrentMetricData

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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' {
- nextToken :: Maybe Text
- groupings :: Maybe [Grouping]
- maxResults :: Maybe Natural
- instanceId :: Text
- filters :: Filters
- currentMetrics :: [CurrentMetric]
}
newGetCurrentMetricData :: Text -> Filters -> GetCurrentMetricData
getCurrentMetricData_nextToken :: Lens' GetCurrentMetricData (Maybe Text)
getCurrentMetricData_groupings :: Lens' GetCurrentMetricData (Maybe [Grouping])
getCurrentMetricData_maxResults :: Lens' GetCurrentMetricData (Maybe Natural)
getCurrentMetricData_instanceId :: Lens' GetCurrentMetricData Text
getCurrentMetricData_filters :: Lens' GetCurrentMetricData Filters
getCurrentMetricData_currentMetrics :: Lens' GetCurrentMetricData [CurrentMetric]
data GetCurrentMetricDataResponse = GetCurrentMetricDataResponse' {
- metricResults :: Maybe [CurrentMetricResult]
- dataSnapshotTime :: Maybe POSIX
- nextToken :: Maybe Text
- httpStatus :: Int
}
newGetCurrentMetricDataResponse :: Int -> GetCurrentMetricDataResponse
getCurrentMetricDataResponse_metricResults :: Lens' GetCurrentMetricDataResponse (Maybe [CurrentMetricResult])
getCurrentMetricDataResponse_dataSnapshotTime :: Lens' GetCurrentMetricDataResponse (Maybe UTCTime)
getCurrentMetricDataResponse_nextToken :: Lens' GetCurrentMetricDataResponse (Maybe Text)
getCurrentMetricDataResponse_httpStatus :: Lens' GetCurrentMetricDataResponse Int

Creating a Request

data GetCurrentMetricData Source #

See: newGetCurrentMetricData smart constructor.

Constructors

GetCurrentMetricData'

Fields

nextToken :: Maybe Text
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.
groupings :: Maybe [Grouping]
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.
maxResults :: Maybe Natural
The maximum number of results to return per page.
instanceId :: Text
The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
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.
currentMetrics :: [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.
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

Instances

Instances details

Eq GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods (==) :: GetCurrentMetricData -> GetCurrentMetricData -> Bool # (/=) :: GetCurrentMetricData -> GetCurrentMetricData -> Bool #
Read GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods readsPrec :: Int -> ReadS GetCurrentMetricData # readList :: ReadS [GetCurrentMetricData] # readPrec :: ReadPrec GetCurrentMetricData # readListPrec :: ReadPrec [GetCurrentMetricData] #
Show GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods showsPrec :: Int -> GetCurrentMetricData -> ShowS # show :: GetCurrentMetricData -> String # showList :: [GetCurrentMetricData] -> ShowS #
Generic GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Associated Types type Rep GetCurrentMetricData :: Type -> Type # Methods from :: GetCurrentMetricData -> Rep GetCurrentMetricData x # to :: Rep GetCurrentMetricData x -> GetCurrentMetricData #
NFData GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods rnf :: GetCurrentMetricData -> () #
Hashable GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods hashWithSalt :: Int -> GetCurrentMetricData -> Int # hash :: GetCurrentMetricData -> Int #
ToJSON GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods toJSON :: GetCurrentMetricData -> Value # toEncoding :: GetCurrentMetricData -> Encoding # toJSONList :: [GetCurrentMetricData] -> Value # toEncodingList :: [GetCurrentMetricData] -> Encoding #
AWSRequest GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Associated Types type AWSResponse GetCurrentMetricData # Methods request :: GetCurrentMetricData -> Request GetCurrentMetricData # response :: MonadResource m => Logger -> Service -> Proxy GetCurrentMetricData -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCurrentMetricData))) #
ToHeaders GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods toHeaders :: GetCurrentMetricData -> [Header] #
ToPath GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods toPath :: GetCurrentMetricData -> ByteString #
ToQuery GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods toQuery :: GetCurrentMetricData -> QueryString #
type Rep GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData type Rep GetCurrentMetricData = D1 ('MetaData "GetCurrentMetricData" "Amazonka.Connect.GetCurrentMetricData" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "GetCurrentMetricData'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "groupings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Grouping])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Filters) :*: S1 ('MetaSel ('Just "currentMetrics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [CurrentMetric])))))
type AWSResponse GetCurrentMetricData Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData type AWSResponse GetCurrentMetricData = GetCurrentMetricDataResponse

newGetCurrentMetricData Source #

Arguments

:: Text	`$sel:instanceId:GetCurrentMetricData'`
-> Filters	`$sel:filters:GetCurrentMetricData'`
-> GetCurrentMetricData

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

$sel:instanceId: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 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.

$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_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_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 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_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 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.

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.

Constructors

GetCurrentMetricDataResponse'

Fields

metricResults :: Maybe [CurrentMetricResult]
Information about the real-time metrics.
dataSnapshotTime :: Maybe POSIX
The time at which the metrics were retrieved and cached for pagination.
nextToken :: Maybe Text
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq GetCurrentMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods (==) :: GetCurrentMetricDataResponse -> GetCurrentMetricDataResponse -> Bool # (/=) :: GetCurrentMetricDataResponse -> GetCurrentMetricDataResponse -> Bool #
Read GetCurrentMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods readsPrec :: Int -> ReadS GetCurrentMetricDataResponse # readList :: ReadS [GetCurrentMetricDataResponse] # readPrec :: ReadPrec GetCurrentMetricDataResponse # readListPrec :: ReadPrec [GetCurrentMetricDataResponse] #
Show GetCurrentMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods showsPrec :: Int -> GetCurrentMetricDataResponse -> ShowS # show :: GetCurrentMetricDataResponse -> String # showList :: [GetCurrentMetricDataResponse] -> ShowS #
Generic GetCurrentMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Associated Types type Rep GetCurrentMetricDataResponse :: Type -> Type # Methods from :: GetCurrentMetricDataResponse -> Rep GetCurrentMetricDataResponse x # to :: Rep GetCurrentMetricDataResponse x -> GetCurrentMetricDataResponse #
NFData GetCurrentMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData Methods rnf :: GetCurrentMetricDataResponse -> () #
type Rep GetCurrentMetricDataResponse Source #
Instance details Defined in Amazonka.Connect.GetCurrentMetricData type Rep GetCurrentMetricDataResponse = D1 ('MetaData "GetCurrentMetricDataResponse" "Amazonka.Connect.GetCurrentMetricData" "libZSservicesZSamazonka-connectZSamazonka-connect" 'False) (C1 ('MetaCons "GetCurrentMetricDataResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "metricResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CurrentMetricResult])) :: S1 ('MetaSel ('Just "dataSnapshotTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetCurrentMetricDataResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetCurrentMetricDataResponse'`
-> GetCurrentMetricDataResponse

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:metricResults:GetCurrentMetricDataResponse', getCurrentMetricDataResponse_metricResults - Information about the real-time metrics.

$sel:dataSnapshotTime:GetCurrentMetricDataResponse', getCurrentMetricDataResponse_dataSnapshotTime - The time at which the metrics were retrieved and cached for pagination.

$sel:nextToken: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_metricResults :: Lens' GetCurrentMetricDataResponse (Maybe [CurrentMetricResult]) Source #

Information about the real-time metrics.

getCurrentMetricDataResponse_dataSnapshotTime :: Lens' GetCurrentMetricDataResponse (Maybe UTCTime) Source #

The time at which the metrics were retrieved and cached for pagination.

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.