AWS SDK Version 3 for .NET
API Reference

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 historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

We recommend using the GetMetricDataV2 API. It provides more flexibility, features, and the ability to query longer time ranges than GetMetricData. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week.

Note:

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 BeginGetMetricData and EndGetMetricData.

Namespace: Amazon.Connect
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<GetMetricDataResponse> GetMetricDataAsync(
         GetMetricDataRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.Connect.Model.GetMetricDataRequest

Container for the necessary parameters to execute the GetMetricData service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the GetMetricData service method, as returned by Connect.

Exceptions

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also