AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Gets metric data from the specified Amazon Connect instance.
GetMetricDataV2 offers more features than GetMetricData,
the previous version of this API. It has new metrics, offers filtering at a metric
level, and offers the ability to filter and group data by channels, queues, routing
profiles, agents, and agent hierarchy levels. It can retrieve historical data for
the last 3 months, at varying intervals. It does not support agent queues.
For a description of the historical metrics that are supported by GetMetricDataV2
and GetMetricData, see Metrics
definitions in the Amazon Connect Administrator Guide.
When you make a successful API request, you can expect the following metric values in the response:
Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data
Metric value is a number (including 0) of defined type: The number provided is the calculation result
MetricResult list is empty: The request cannot find any data in the system
The following guidelines can help you work with the API:
Each dimension in the metric response must contain a value
Each item in MetricResult must include all requested metrics
If the response is slow due to large result sets, try these approaches:
Narrow the time range of your request
Add filters to reduce the amount of data returned
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetMetricDataV2 and EndGetMetricDataV2.
Namespace: Amazon.Connect
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z
public abstract Task<GetMetricDataV2Response> GetMetricDataV2Async( GetMetricDataV2Request request, CancellationToken cancellationToken )
Container for the necessary parameters to execute the GetMetricDataV2 service method.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| InternalServiceException | Request processing failed because of an error or failure with the service. |
| InvalidParameterException | One or more of the specified parameters are not valid. |
| InvalidRequestException | The request is not valid. |
| ResourceNotFoundException | The specified resource was not found. |
| ThrottlingException | The throttling limit has been exceeded. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer