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

#include <GetMetricDataRequest.h>

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

Public Member Functions

 GetMetricDataRequest ()
 
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)
 
GetMetricDataRequestWithInstanceId (const Aws::String &value)
 
GetMetricDataRequestWithInstanceId (Aws::String &&value)
 
GetMetricDataRequestWithInstanceId (const char *value)
 
const Aws::Utils::DateTimeGetStartTime () const
 
bool StartTimeHasBeenSet () const
 
void SetStartTime (const Aws::Utils::DateTime &value)
 
void SetStartTime (Aws::Utils::DateTime &&value)
 
GetMetricDataRequestWithStartTime (const Aws::Utils::DateTime &value)
 
GetMetricDataRequestWithStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetEndTime () const
 
bool EndTimeHasBeenSet () const
 
void SetEndTime (const Aws::Utils::DateTime &value)
 
void SetEndTime (Aws::Utils::DateTime &&value)
 
GetMetricDataRequestWithEndTime (const Aws::Utils::DateTime &value)
 
GetMetricDataRequestWithEndTime (Aws::Utils::DateTime &&value)
 
const FiltersGetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Filters &value)
 
void SetFilters (Filters &&value)
 
GetMetricDataRequestWithFilters (const Filters &value)
 
GetMetricDataRequestWithFilters (Filters &&value)
 
const Aws::Vector< Grouping > & GetGroupings () const
 
bool GroupingsHasBeenSet () const
 
void SetGroupings (const Aws::Vector< Grouping > &value)
 
void SetGroupings (Aws::Vector< Grouping > &&value)
 
GetMetricDataRequestWithGroupings (const Aws::Vector< Grouping > &value)
 
GetMetricDataRequestWithGroupings (Aws::Vector< Grouping > &&value)
 
GetMetricDataRequestAddGroupings (const Grouping &value)
 
GetMetricDataRequestAddGroupings (Grouping &&value)
 
const Aws::Vector< HistoricalMetric > & GetHistoricalMetrics () const
 
bool HistoricalMetricsHasBeenSet () const
 
void SetHistoricalMetrics (const Aws::Vector< HistoricalMetric > &value)
 
void SetHistoricalMetrics (Aws::Vector< HistoricalMetric > &&value)
 
GetMetricDataRequestWithHistoricalMetrics (const Aws::Vector< HistoricalMetric > &value)
 
GetMetricDataRequestWithHistoricalMetrics (Aws::Vector< HistoricalMetric > &&value)
 
GetMetricDataRequestAddHistoricalMetrics (const HistoricalMetric &value)
 
GetMetricDataRequestAddHistoricalMetrics (HistoricalMetric &&value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
GetMetricDataRequestWithNextToken (const Aws::String &value)
 
GetMetricDataRequestWithNextToken (Aws::String &&value)
 
GetMetricDataRequestWithNextToken (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetMetricDataRequestWithMaxResults (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 26 of file GetMetricDataRequest.h.

Constructor & Destructor Documentation

◆ GetMetricDataRequest()

Aws::Connect::Model::GetMetricDataRequest::GetMetricDataRequest ( )

Member Function Documentation

◆ AddGroupings() [1/2]

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

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

Definition at line 321 of file GetMetricDataRequest.h.

◆ AddGroupings() [2/2]

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

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

Definition at line 330 of file GetMetricDataRequest.h.

◆ AddHistoricalMetrics() [1/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::AddHistoricalMetrics ( const HistoricalMetric value)
inline

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

Definition at line 632 of file GetMetricDataRequest.h.

◆ AddHistoricalMetrics() [2/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::AddHistoricalMetrics ( HistoricalMetric &&  value)
inline

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

Definition at line 675 of file GetMetricDataRequest.h.

◆ EndTimeHasBeenSet()

bool Aws::Connect::Model::GetMetricDataRequest::EndTimeHasBeenSet ( ) const
inline

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Definition at line 160 of file GetMetricDataRequest.h.

◆ FiltersHasBeenSet()

bool Aws::Connect::Model::GetMetricDataRequest::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. VOICE, CHAT, and TASK channels are supported.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

Definition at line 217 of file GetMetricDataRequest.h.

◆ GetEndTime()

const Aws::Utils::DateTime& Aws::Connect::Model::GetMetricDataRequest::GetEndTime ( ) const
inline

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Definition at line 151 of file GetMetricDataRequest.h.

◆ GetFilters()

const Filters& Aws::Connect::Model::GetMetricDataRequest::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. VOICE, CHAT, and TASK channels are supported.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

Definition at line 207 of file GetMetricDataRequest.h.

◆ GetGroupings()

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

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

Definition at line 267 of file GetMetricDataRequest.h.

◆ GetHistoricalMetrics()

const Aws::Vector<HistoricalMetric>& Aws::Connect::Model::GetMetricDataRequest::GetHistoricalMetrics ( ) const
inline

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

Definition at line 374 of file GetMetricDataRequest.h.

◆ GetInstanceId()

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Definition at line 44 of file GetMetricDataRequest.h.

◆ GetMaxResults()

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

The maximum number of results to return per page.

Definition at line 730 of file GetMetricDataRequest.h.

◆ GetNextToken()

const Aws::String& Aws::Connect::Model::GetMetricDataRequest::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.

Definition at line 682 of file GetMetricDataRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file GetMetricDataRequest.h.

◆ GetStartTime()

const Aws::Utils::DateTime& Aws::Connect::Model::GetMetricDataRequest::GetStartTime ( ) const
inline

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Definition at line 96 of file GetMetricDataRequest.h.

◆ GroupingsHasBeenSet()

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

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

Definition at line 276 of file GetMetricDataRequest.h.

◆ HistoricalMetricsHasBeenSet()

bool Aws::Connect::Model::GetMetricDataRequest::HistoricalMetricsHasBeenSet ( ) const
inline

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

Definition at line 417 of file GetMetricDataRequest.h.

◆ InstanceIdHasBeenSet()

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Definition at line 50 of file GetMetricDataRequest.h.

◆ MaxResultsHasBeenSet()

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

The maximum number of results to return per page.

Definition at line 735 of file GetMetricDataRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::Connect::Model::GetMetricDataRequest::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.

Definition at line 688 of file GetMetricDataRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetEndTime() [1/2]

void Aws::Connect::Model::GetMetricDataRequest::SetEndTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Definition at line 178 of file GetMetricDataRequest.h.

◆ SetEndTime() [2/2]

void Aws::Connect::Model::GetMetricDataRequest::SetEndTime ( const Aws::Utils::DateTime value)
inline

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Definition at line 169 of file GetMetricDataRequest.h.

◆ SetFilters() [1/2]

void Aws::Connect::Model::GetMetricDataRequest::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. VOICE, CHAT, and TASK channels are supported.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

Definition at line 227 of file GetMetricDataRequest.h.

◆ SetFilters() [2/2]

void Aws::Connect::Model::GetMetricDataRequest::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. VOICE, CHAT, and TASK channels are supported.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

Definition at line 237 of file GetMetricDataRequest.h.

◆ SetGroupings() [1/2]

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

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

Definition at line 294 of file GetMetricDataRequest.h.

◆ SetGroupings() [2/2]

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

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

Definition at line 285 of file GetMetricDataRequest.h.

◆ SetHistoricalMetrics() [1/2]

void Aws::Connect::Model::GetMetricDataRequest::SetHistoricalMetrics ( Aws::Vector< HistoricalMetric > &&  value)
inline

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

Definition at line 503 of file GetMetricDataRequest.h.

◆ SetHistoricalMetrics() [2/2]

void Aws::Connect::Model::GetMetricDataRequest::SetHistoricalMetrics ( const Aws::Vector< HistoricalMetric > &  value)
inline

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

Definition at line 460 of file GetMetricDataRequest.h.

◆ SetInstanceId() [1/3]

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Definition at line 62 of file GetMetricDataRequest.h.

◆ SetInstanceId() [2/3]

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Definition at line 56 of file GetMetricDataRequest.h.

◆ SetInstanceId() [3/3]

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Definition at line 68 of file GetMetricDataRequest.h.

◆ SetMaxResults()

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

The maximum number of results to return per page.

Definition at line 740 of file GetMetricDataRequest.h.

◆ SetNextToken() [1/3]

void Aws::Connect::Model::GetMetricDataRequest::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.

Definition at line 700 of file GetMetricDataRequest.h.

◆ SetNextToken() [2/3]

void Aws::Connect::Model::GetMetricDataRequest::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.

Definition at line 694 of file GetMetricDataRequest.h.

◆ SetNextToken() [3/3]

void Aws::Connect::Model::GetMetricDataRequest::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.

Definition at line 706 of file GetMetricDataRequest.h.

◆ SetStartTime() [1/2]

void Aws::Connect::Model::GetMetricDataRequest::SetStartTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Definition at line 123 of file GetMetricDataRequest.h.

◆ SetStartTime() [2/2]

void Aws::Connect::Model::GetMetricDataRequest::SetStartTime ( const Aws::Utils::DateTime value)
inline

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Definition at line 114 of file GetMetricDataRequest.h.

◆ StartTimeHasBeenSet()

bool Aws::Connect::Model::GetMetricDataRequest::StartTimeHasBeenSet ( ) const
inline

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Definition at line 105 of file GetMetricDataRequest.h.

◆ WithEndTime() [1/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::WithEndTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Definition at line 196 of file GetMetricDataRequest.h.

◆ WithEndTime() [2/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::WithEndTime ( const Aws::Utils::DateTime value)
inline

The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the start time timestamp.

The time range between the start and end time must be less than 24 hours.

Definition at line 187 of file GetMetricDataRequest.h.

◆ WithFilters() [1/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::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. VOICE, CHAT, and TASK channels are supported.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

Definition at line 247 of file GetMetricDataRequest.h.

◆ WithFilters() [2/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::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. VOICE, CHAT, and TASK channels are supported.

To filter by Queues, enter the queue ID/ARN, not the name of the queue.

Definition at line 257 of file GetMetricDataRequest.h.

◆ WithGroupings() [1/2]

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

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

Definition at line 312 of file GetMetricDataRequest.h.

◆ WithGroupings() [2/2]

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

The grouping applied to the metrics returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.

If no grouping is specified, a summary of metrics for all queues is returned.

Definition at line 303 of file GetMetricDataRequest.h.

◆ WithHistoricalMetrics() [1/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::WithHistoricalMetrics ( Aws::Vector< HistoricalMetric > &&  value)
inline

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

Definition at line 589 of file GetMetricDataRequest.h.

◆ WithHistoricalMetrics() [2/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::WithHistoricalMetrics ( const Aws::Vector< HistoricalMetric > &  value)
inline

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list).

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

You can include up to 20 SERVICE_LEVEL metrics in a request.

Unit: PERCENT

Statistic: AVG

Threshold: For ThresholdValue, enter any whole number from 1 to 604800 (inclusive), in seconds. For Comparison, you must enter LT (for "Less than").

Definition at line 546 of file GetMetricDataRequest.h.

◆ WithInstanceId() [1/3]

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Definition at line 80 of file GetMetricDataRequest.h.

◆ WithInstanceId() [2/3]

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Definition at line 74 of file GetMetricDataRequest.h.

◆ WithInstanceId() [3/3]

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

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

Definition at line 86 of file GetMetricDataRequest.h.

◆ WithMaxResults()

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

The maximum number of results to return per page.

Definition at line 745 of file GetMetricDataRequest.h.

◆ WithNextToken() [1/3]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::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.

Definition at line 718 of file GetMetricDataRequest.h.

◆ WithNextToken() [2/3]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::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.

Definition at line 712 of file GetMetricDataRequest.h.

◆ WithNextToken() [3/3]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::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.

Definition at line 724 of file GetMetricDataRequest.h.

◆ WithStartTime() [1/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::WithStartTime ( Aws::Utils::DateTime &&  value)
inline

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Definition at line 141 of file GetMetricDataRequest.h.

◆ WithStartTime() [2/2]

GetMetricDataRequest& Aws::Connect::Model::GetMetricDataRequest::WithStartTime ( const Aws::Utils::DateTime value)
inline

The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.

The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.

Definition at line 132 of file GetMetricDataRequest.h.


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