480 lines
25 KiB
C++
480 lines
25 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/connect/Connect_EXPORTS.h>
|
|
#include <aws/connect/ConnectRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/connect/model/Filters.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/connect/model/Grouping.h>
|
|
#include <aws/connect/model/CurrentMetric.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Connect
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class AWS_CONNECT_API GetCurrentMetricDataRequest : public ConnectRequest
|
|
{
|
|
public:
|
|
GetCurrentMetricDataRequest();
|
|
|
|
// Service request name is the Operation name which will send this request out,
|
|
// each operation should has unique request name, so that we can get operation's name from this request.
|
|
// Note: this is not true for response, multiple operations may have the same response name,
|
|
// so we can not get operation's name from response.
|
|
inline virtual const char* GetServiceRequestName() const override { return "GetCurrentMetricData"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
|
|
/**
|
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
*/
|
|
inline const Aws::String& GetInstanceId() const{ return m_instanceId; }
|
|
|
|
/**
|
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
*/
|
|
inline bool InstanceIdHasBeenSet() const { return m_instanceIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
*/
|
|
inline void SetInstanceId(const Aws::String& value) { m_instanceIdHasBeenSet = true; m_instanceId = value; }
|
|
|
|
/**
|
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
*/
|
|
inline void SetInstanceId(Aws::String&& value) { m_instanceIdHasBeenSet = true; m_instanceId = std::move(value); }
|
|
|
|
/**
|
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
*/
|
|
inline void SetInstanceId(const char* value) { m_instanceIdHasBeenSet = true; m_instanceId.assign(value); }
|
|
|
|
/**
|
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithInstanceId(const Aws::String& value) { SetInstanceId(value); return *this;}
|
|
|
|
/**
|
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithInstanceId(Aws::String&& value) { SetInstanceId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The identifier of the Amazon Connect instance.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithInstanceId(const char* value) { SetInstanceId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>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. The only supported channel is <code>VOICE</code>.</p>
|
|
*/
|
|
inline const Filters& GetFilters() const{ return m_filters; }
|
|
|
|
/**
|
|
* <p>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. The only supported channel is <code>VOICE</code>.</p>
|
|
*/
|
|
inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
|
|
|
|
/**
|
|
* <p>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. The only supported channel is <code>VOICE</code>.</p>
|
|
*/
|
|
inline void SetFilters(const Filters& value) { m_filtersHasBeenSet = true; m_filters = value; }
|
|
|
|
/**
|
|
* <p>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. The only supported channel is <code>VOICE</code>.</p>
|
|
*/
|
|
inline void SetFilters(Filters&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
|
|
|
|
/**
|
|
* <p>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. The only supported channel is <code>VOICE</code>.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithFilters(const Filters& value) { SetFilters(value); return *this;}
|
|
|
|
/**
|
|
* <p>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. The only supported channel is <code>VOICE</code>.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithFilters(Filters&& value) { SetFilters(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
* <code>QUEUE</code>, the metrics returned apply to each queue rather than
|
|
* aggregated for all queues. If you group by <code>CHANNEL</code>, you should
|
|
* include a Channels filter. The only supported channel is <code>VOICE</code>.</p>
|
|
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics
|
|
* is returned.</p>
|
|
*/
|
|
inline const Aws::Vector<Grouping>& GetGroupings() const{ return m_groupings; }
|
|
|
|
/**
|
|
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
* <code>QUEUE</code>, the metrics returned apply to each queue rather than
|
|
* aggregated for all queues. If you group by <code>CHANNEL</code>, you should
|
|
* include a Channels filter. The only supported channel is <code>VOICE</code>.</p>
|
|
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics
|
|
* is returned.</p>
|
|
*/
|
|
inline bool GroupingsHasBeenSet() const { return m_groupingsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
* <code>QUEUE</code>, the metrics returned apply to each queue rather than
|
|
* aggregated for all queues. If you group by <code>CHANNEL</code>, you should
|
|
* include a Channels filter. The only supported channel is <code>VOICE</code>.</p>
|
|
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics
|
|
* is returned.</p>
|
|
*/
|
|
inline void SetGroupings(const Aws::Vector<Grouping>& value) { m_groupingsHasBeenSet = true; m_groupings = value; }
|
|
|
|
/**
|
|
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
* <code>QUEUE</code>, the metrics returned apply to each queue rather than
|
|
* aggregated for all queues. If you group by <code>CHANNEL</code>, you should
|
|
* include a Channels filter. The only supported channel is <code>VOICE</code>.</p>
|
|
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics
|
|
* is returned.</p>
|
|
*/
|
|
inline void SetGroupings(Aws::Vector<Grouping>&& value) { m_groupingsHasBeenSet = true; m_groupings = std::move(value); }
|
|
|
|
/**
|
|
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
* <code>QUEUE</code>, the metrics returned apply to each queue rather than
|
|
* aggregated for all queues. If you group by <code>CHANNEL</code>, you should
|
|
* include a Channels filter. The only supported channel is <code>VOICE</code>.</p>
|
|
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics
|
|
* is returned.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithGroupings(const Aws::Vector<Grouping>& value) { SetGroupings(value); return *this;}
|
|
|
|
/**
|
|
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
* <code>QUEUE</code>, the metrics returned apply to each queue rather than
|
|
* aggregated for all queues. If you group by <code>CHANNEL</code>, you should
|
|
* include a Channels filter. The only supported channel is <code>VOICE</code>.</p>
|
|
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics
|
|
* is returned.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithGroupings(Aws::Vector<Grouping>&& value) { SetGroupings(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
* <code>QUEUE</code>, the metrics returned apply to each queue rather than
|
|
* aggregated for all queues. If you group by <code>CHANNEL</code>, you should
|
|
* include a Channels filter. The only supported channel is <code>VOICE</code>.</p>
|
|
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics
|
|
* is returned.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& AddGroupings(const Grouping& value) { m_groupingsHasBeenSet = true; m_groupings.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The grouping applied to the metrics returned. For example, when grouped by
|
|
* <code>QUEUE</code>, the metrics returned apply to each queue rather than
|
|
* aggregated for all queues. If you group by <code>CHANNEL</code>, you should
|
|
* include a Channels filter. The only supported channel is <code>VOICE</code>.</p>
|
|
* <p>If no <code>Grouping</code> is included in the request, a summary of metrics
|
|
* is returned.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& AddGroupings(Grouping&& value) { m_groupingsHasBeenSet = true; m_groupings.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The metrics to retrieve. Specify the name and unit for each metric. The
|
|
* following metrics are available. For a description of each metric, see <a
|
|
* href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time
|
|
* Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
* <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ERROR</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit:
|
|
* COUNT</p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ONLINE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p>
|
|
* </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> </dd>
|
|
* <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>SLOTS_AVAILABLE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> </dl>
|
|
*/
|
|
inline const Aws::Vector<CurrentMetric>& GetCurrentMetrics() const{ return m_currentMetrics; }
|
|
|
|
/**
|
|
* <p>The metrics to retrieve. Specify the name and unit for each metric. The
|
|
* following metrics are available. For a description of each metric, see <a
|
|
* href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time
|
|
* Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
* <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ERROR</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit:
|
|
* COUNT</p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ONLINE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p>
|
|
* </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> </dd>
|
|
* <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>SLOTS_AVAILABLE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> </dl>
|
|
*/
|
|
inline bool CurrentMetricsHasBeenSet() const { return m_currentMetricsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The metrics to retrieve. Specify the name and unit for each metric. The
|
|
* following metrics are available. For a description of each metric, see <a
|
|
* href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time
|
|
* Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
* <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ERROR</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit:
|
|
* COUNT</p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ONLINE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p>
|
|
* </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> </dd>
|
|
* <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>SLOTS_AVAILABLE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> </dl>
|
|
*/
|
|
inline void SetCurrentMetrics(const Aws::Vector<CurrentMetric>& value) { m_currentMetricsHasBeenSet = true; m_currentMetrics = value; }
|
|
|
|
/**
|
|
* <p>The metrics to retrieve. Specify the name and unit for each metric. The
|
|
* following metrics are available. For a description of each metric, see <a
|
|
* href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time
|
|
* Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
* <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ERROR</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit:
|
|
* COUNT</p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ONLINE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p>
|
|
* </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> </dd>
|
|
* <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>SLOTS_AVAILABLE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> </dl>
|
|
*/
|
|
inline void SetCurrentMetrics(Aws::Vector<CurrentMetric>&& value) { m_currentMetricsHasBeenSet = true; m_currentMetrics = std::move(value); }
|
|
|
|
/**
|
|
* <p>The metrics to retrieve. Specify the name and unit for each metric. The
|
|
* following metrics are available. For a description of each metric, see <a
|
|
* href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time
|
|
* Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
* <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ERROR</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit:
|
|
* COUNT</p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ONLINE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p>
|
|
* </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> </dd>
|
|
* <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>SLOTS_AVAILABLE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> </dl>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithCurrentMetrics(const Aws::Vector<CurrentMetric>& value) { SetCurrentMetrics(value); return *this;}
|
|
|
|
/**
|
|
* <p>The metrics to retrieve. Specify the name and unit for each metric. The
|
|
* following metrics are available. For a description of each metric, see <a
|
|
* href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time
|
|
* Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
* <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ERROR</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit:
|
|
* COUNT</p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ONLINE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p>
|
|
* </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> </dd>
|
|
* <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>SLOTS_AVAILABLE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> </dl>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithCurrentMetrics(Aws::Vector<CurrentMetric>&& value) { SetCurrentMetrics(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The metrics to retrieve. Specify the name and unit for each metric. The
|
|
* following metrics are available. For a description of each metric, see <a
|
|
* href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time
|
|
* Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
* <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ERROR</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit:
|
|
* COUNT</p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ONLINE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p>
|
|
* </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> </dd>
|
|
* <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>SLOTS_AVAILABLE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> </dl>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& AddCurrentMetrics(const CurrentMetric& value) { m_currentMetricsHasBeenSet = true; m_currentMetrics.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>The metrics to retrieve. Specify the name and unit for each metric. The
|
|
* following metrics are available. For a description of each metric, see <a
|
|
* href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time
|
|
* Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</p>
|
|
* <dl> <dt>AGENTS_AFTER_CONTACT_WORK</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_AVAILABLE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ERROR</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_NON_PRODUCTIVE</dt> <dd> <p>Unit:
|
|
* COUNT</p> </dd> <dt>AGENTS_ON_CALL</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>AGENTS_ON_CONTACT</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_ONLINE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> <dt>AGENTS_STAFFED</dt> <dd> <p>Unit: COUNT</p>
|
|
* </dd> <dt>CONTACTS_IN_QUEUE</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>CONTACTS_SCHEDULED</dt> <dd> <p>Unit: COUNT</p> </dd>
|
|
* <dt>OLDEST_CONTACT_AGE</dt> <dd> <p>Unit: SECONDS</p> </dd>
|
|
* <dt>SLOTS_ACTIVE</dt> <dd> <p>Unit: COUNT</p> </dd> <dt>SLOTS_AVAILABLE</dt>
|
|
* <dd> <p>Unit: COUNT</p> </dd> </dl>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& AddCurrentMetrics(CurrentMetric&& value) { m_currentMetricsHasBeenSet = true; m_currentMetrics.push_back(std::move(value)); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>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.</p> <p>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.</p>
|
|
*/
|
|
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
|
|
|
|
/**
|
|
* <p>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.</p> <p>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.</p>
|
|
*/
|
|
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
|
|
|
|
/**
|
|
* <p>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.</p> <p>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.</p>
|
|
*/
|
|
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
|
|
|
|
/**
|
|
* <p>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.</p> <p>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.</p>
|
|
*/
|
|
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
|
|
|
|
/**
|
|
* <p>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.</p> <p>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.</p>
|
|
*/
|
|
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
|
|
|
|
/**
|
|
* <p>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.</p> <p>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.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p> <p>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.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>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.</p> <p>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.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The maximimum number of results to return per page.</p>
|
|
*/
|
|
inline int GetMaxResults() const{ return m_maxResults; }
|
|
|
|
/**
|
|
* <p>The maximimum number of results to return per page.</p>
|
|
*/
|
|
inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The maximimum number of results to return per page.</p>
|
|
*/
|
|
inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
|
|
|
|
/**
|
|
* <p>The maximimum number of results to return per page.</p>
|
|
*/
|
|
inline GetCurrentMetricDataRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_instanceId;
|
|
bool m_instanceIdHasBeenSet;
|
|
|
|
Filters m_filters;
|
|
bool m_filtersHasBeenSet;
|
|
|
|
Aws::Vector<Grouping> m_groupings;
|
|
bool m_groupingsHasBeenSet;
|
|
|
|
Aws::Vector<CurrentMetric> m_currentMetrics;
|
|
bool m_currentMetricsHasBeenSet;
|
|
|
|
Aws::String m_nextToken;
|
|
bool m_nextTokenHasBeenSet;
|
|
|
|
int m_maxResults;
|
|
bool m_maxResultsHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace Connect
|
|
} // namespace Aws
|