AWS SDK for C++  1.8.60
AWS SDK for C++
Public Member Functions | List of all members
Aws::Connect::Model::GetCurrentMetricDataRequest Class Reference

#include <GetCurrentMetricDataRequest.h>

+ Inheritance diagram for Aws::Connect::Model::GetCurrentMetricDataRequest:

Public Member Functions

 GetCurrentMetricDataRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetInstanceId () const
 
bool InstanceIdHasBeenSet () const
 
void SetInstanceId (const Aws::String &value)
 
void SetInstanceId (Aws::String &&value)
 
void SetInstanceId (const char *value)
 
GetCurrentMetricDataRequestWithInstanceId (const Aws::String &value)
 
GetCurrentMetricDataRequestWithInstanceId (Aws::String &&value)
 
GetCurrentMetricDataRequestWithInstanceId (const char *value)
 
const FiltersGetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Filters &value)
 
void SetFilters (Filters &&value)
 
GetCurrentMetricDataRequestWithFilters (const Filters &value)
 
GetCurrentMetricDataRequestWithFilters (Filters &&value)
 
const Aws::Vector< Grouping > & GetGroupings () const
 
bool GroupingsHasBeenSet () const
 
void SetGroupings (const Aws::Vector< Grouping > &value)
 
void SetGroupings (Aws::Vector< Grouping > &&value)
 
GetCurrentMetricDataRequestWithGroupings (const Aws::Vector< Grouping > &value)
 
GetCurrentMetricDataRequestWithGroupings (Aws::Vector< Grouping > &&value)
 
GetCurrentMetricDataRequestAddGroupings (const Grouping &value)
 
GetCurrentMetricDataRequestAddGroupings (Grouping &&value)
 
const Aws::Vector< CurrentMetric > & GetCurrentMetrics () const
 
bool CurrentMetricsHasBeenSet () const
 
void SetCurrentMetrics (const Aws::Vector< CurrentMetric > &value)
 
void SetCurrentMetrics (Aws::Vector< CurrentMetric > &&value)
 
GetCurrentMetricDataRequestWithCurrentMetrics (const Aws::Vector< CurrentMetric > &value)
 
GetCurrentMetricDataRequestWithCurrentMetrics (Aws::Vector< CurrentMetric > &&value)
 
GetCurrentMetricDataRequestAddCurrentMetrics (const CurrentMetric &value)
 
GetCurrentMetricDataRequestAddCurrentMetrics (CurrentMetric &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
GetCurrentMetricDataRequestWithNextToken (const Aws::String &value)
 
GetCurrentMetricDataRequestWithNextToken (Aws::String &&value)
 
GetCurrentMetricDataRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetCurrentMetricDataRequestWithMaxResults (int value)
 
- Public Member Functions inherited from Aws::Connect::ConnectRequest
virtual ~ConnectRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Connect::ConnectRequest
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 25 of file GetCurrentMetricDataRequest.h.

Constructor & Destructor Documentation

◆ GetCurrentMetricDataRequest()

Aws::Connect::Model::GetCurrentMetricDataRequest::GetCurrentMetricDataRequest ( )

Member Function Documentation

◆ AddCurrentMetrics() [1/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::AddCurrentMetrics ( const CurrentMetric value)
inline

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 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

Definition at line 578 of file GetCurrentMetricDataRequest.h.

◆ AddCurrentMetrics() [2/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::AddCurrentMetrics ( CurrentMetric &&  value)
inline

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 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

Definition at line 630 of file GetCurrentMetricDataRequest.h.

◆ AddGroupings() [1/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::AddGroupings ( const Grouping value)
inline

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. Both VOICE and CHAT channels are supported.

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

Definition at line 203 of file GetCurrentMetricDataRequest.h.

◆ AddGroupings() [2/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::AddGroupings ( Grouping &&  value)
inline

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. Both VOICE and CHAT channels are supported.

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

Definition at line 213 of file GetCurrentMetricDataRequest.h.

◆ CurrentMetricsHasBeenSet()

bool Aws::Connect::Model::GetCurrentMetricDataRequest::CurrentMetricsHasBeenSet ( ) const
inline

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 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

Definition at line 318 of file GetCurrentMetricDataRequest.h.

◆ FiltersHasBeenSet()

bool Aws::Connect::Model::GetCurrentMetricDataRequest::FiltersHasBeenSet ( ) const
inline

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. Both VOICE and CHAT channels are supported.

Definition at line 96 of file GetCurrentMetricDataRequest.h.

◆ GetCurrentMetrics()

const Aws::Vector<CurrentMetric>& Aws::Connect::Model::GetCurrentMetricDataRequest::GetCurrentMetrics ( ) const
inline

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 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

Definition at line 266 of file GetCurrentMetricDataRequest.h.

◆ GetFilters()

const Filters& Aws::Connect::Model::GetCurrentMetricDataRequest::GetFilters ( ) const
inline

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. Both VOICE and CHAT channels are supported.

Definition at line 87 of file GetCurrentMetricDataRequest.h.

◆ GetGroupings()

const Aws::Vector<Grouping>& Aws::Connect::Model::GetCurrentMetricDataRequest::GetGroupings ( ) const
inline

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. Both VOICE and CHAT channels are supported.

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

Definition at line 143 of file GetCurrentMetricDataRequest.h.

◆ GetInstanceId()

const Aws::String& Aws::Connect::Model::GetCurrentMetricDataRequest::GetInstanceId ( ) const
inline

The identifier of the Amazon Connect instance.

Definition at line 42 of file GetCurrentMetricDataRequest.h.

◆ GetMaxResults()

int Aws::Connect::Model::GetCurrentMetricDataRequest::GetMaxResults ( ) const
inline

The maximimum number of results to return per page.

Definition at line 709 of file GetCurrentMetricDataRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Connect::Model::GetCurrentMetricDataRequest::GetNextToken ( ) const
inline

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.

Definition at line 640 of file GetCurrentMetricDataRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Connect::Model::GetCurrentMetricDataRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file GetCurrentMetricDataRequest.h.

◆ GroupingsHasBeenSet()

bool Aws::Connect::Model::GetCurrentMetricDataRequest::GroupingsHasBeenSet ( ) const
inline

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. Both VOICE and CHAT channels are supported.

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

Definition at line 153 of file GetCurrentMetricDataRequest.h.

◆ InstanceIdHasBeenSet()

bool Aws::Connect::Model::GetCurrentMetricDataRequest::InstanceIdHasBeenSet ( ) const
inline

The identifier of the Amazon Connect instance.

Definition at line 47 of file GetCurrentMetricDataRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::Connect::Model::GetCurrentMetricDataRequest::MaxResultsHasBeenSet ( ) const
inline

The maximimum number of results to return per page.

Definition at line 714 of file GetCurrentMetricDataRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Connect::Model::GetCurrentMetricDataRequest::NextTokenHasBeenSet ( ) const
inline

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.

Definition at line 649 of file GetCurrentMetricDataRequest.h.

◆ SerializePayload()

Aws::String Aws::Connect::Model::GetCurrentMetricDataRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCurrentMetrics() [1/2]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetCurrentMetrics ( const Aws::Vector< CurrentMetric > &  value)
inline

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 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

Definition at line 370 of file GetCurrentMetricDataRequest.h.

◆ SetCurrentMetrics() [2/2]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetCurrentMetrics ( Aws::Vector< CurrentMetric > &&  value)
inline

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 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

Definition at line 422 of file GetCurrentMetricDataRequest.h.

◆ SetFilters() [1/2]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetFilters ( const Filters value)
inline

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. Both VOICE and CHAT channels are supported.

Definition at line 105 of file GetCurrentMetricDataRequest.h.

◆ SetFilters() [2/2]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetFilters ( Filters &&  value)
inline

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. Both VOICE and CHAT channels are supported.

Definition at line 114 of file GetCurrentMetricDataRequest.h.

◆ SetGroupings() [1/2]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetGroupings ( const Aws::Vector< Grouping > &  value)
inline

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. Both VOICE and CHAT channels are supported.

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

Definition at line 163 of file GetCurrentMetricDataRequest.h.

◆ SetGroupings() [2/2]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetGroupings ( Aws::Vector< Grouping > &&  value)
inline

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. Both VOICE and CHAT channels are supported.

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

Definition at line 173 of file GetCurrentMetricDataRequest.h.

◆ SetInstanceId() [1/3]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetInstanceId ( const Aws::String value)
inline

The identifier of the Amazon Connect instance.

Definition at line 52 of file GetCurrentMetricDataRequest.h.

◆ SetInstanceId() [2/3]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetInstanceId ( Aws::String &&  value)
inline

The identifier of the Amazon Connect instance.

Definition at line 57 of file GetCurrentMetricDataRequest.h.

◆ SetInstanceId() [3/3]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetInstanceId ( const char *  value)
inline

The identifier of the Amazon Connect instance.

Definition at line 62 of file GetCurrentMetricDataRequest.h.

◆ SetMaxResults()

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetMaxResults ( int  value)
inline

The maximimum number of results to return per page.

Definition at line 719 of file GetCurrentMetricDataRequest.h.

◆ SetNextToken() [1/3]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetNextToken ( const Aws::String value)
inline

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.

Definition at line 658 of file GetCurrentMetricDataRequest.h.

◆ SetNextToken() [2/3]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetNextToken ( Aws::String &&  value)
inline

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.

Definition at line 667 of file GetCurrentMetricDataRequest.h.

◆ SetNextToken() [3/3]

void Aws::Connect::Model::GetCurrentMetricDataRequest::SetNextToken ( const char *  value)
inline

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.

Definition at line 676 of file GetCurrentMetricDataRequest.h.

◆ WithCurrentMetrics() [1/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithCurrentMetrics ( const Aws::Vector< CurrentMetric > &  value)
inline

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 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

Definition at line 474 of file GetCurrentMetricDataRequest.h.

◆ WithCurrentMetrics() [2/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithCurrentMetrics ( Aws::Vector< CurrentMetric > &&  value)
inline

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 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

Definition at line 526 of file GetCurrentMetricDataRequest.h.

◆ WithFilters() [1/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithFilters ( const Filters value)
inline

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. Both VOICE and CHAT channels are supported.

Definition at line 123 of file GetCurrentMetricDataRequest.h.

◆ WithFilters() [2/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithFilters ( Filters &&  value)
inline

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. Both VOICE and CHAT channels are supported.

Definition at line 132 of file GetCurrentMetricDataRequest.h.

◆ WithGroupings() [1/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithGroupings ( const Aws::Vector< Grouping > &  value)
inline

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. Both VOICE and CHAT channels are supported.

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

Definition at line 183 of file GetCurrentMetricDataRequest.h.

◆ WithGroupings() [2/2]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithGroupings ( Aws::Vector< Grouping > &&  value)
inline

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. Both VOICE and CHAT channels are supported.

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

Definition at line 193 of file GetCurrentMetricDataRequest.h.

◆ WithInstanceId() [1/3]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithInstanceId ( const Aws::String value)
inline

The identifier of the Amazon Connect instance.

Definition at line 67 of file GetCurrentMetricDataRequest.h.

◆ WithInstanceId() [2/3]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithInstanceId ( Aws::String &&  value)
inline

The identifier of the Amazon Connect instance.

Definition at line 72 of file GetCurrentMetricDataRequest.h.

◆ WithInstanceId() [3/3]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithInstanceId ( const char *  value)
inline

The identifier of the Amazon Connect instance.

Definition at line 77 of file GetCurrentMetricDataRequest.h.

◆ WithMaxResults()

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithMaxResults ( int  value)
inline

The maximimum number of results to return per page.

Definition at line 724 of file GetCurrentMetricDataRequest.h.

◆ WithNextToken() [1/3]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithNextToken ( const Aws::String value)
inline

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.

Definition at line 685 of file GetCurrentMetricDataRequest.h.

◆ WithNextToken() [2/3]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithNextToken ( Aws::String &&  value)
inline

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.

Definition at line 694 of file GetCurrentMetricDataRequest.h.

◆ WithNextToken() [3/3]

GetCurrentMetricDataRequest& Aws::Connect::Model::GetCurrentMetricDataRequest::WithNextToken ( const char *  value)
inline

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.

Definition at line 703 of file GetCurrentMetricDataRequest.h.


The documentation for this class was generated from the following file: