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

For a description of each metric, 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:

  1. Metric value is null: The calculation cannot be performed due to divide by zero or insufficient data

  2. Metric value is a number (including 0) of defined type: The number provided is the calculation result

  3. 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:

    • Add filters to reduce the amount of data returned

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to GetCurrentMetricDataAsync.

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

Syntax

C#
public abstract GetCurrentMetricDataResponse GetCurrentMetricData(
         GetCurrentMetricDataRequest request
)

Parameters

request
Type: Amazon.Connect.Model.GetCurrentMetricDataRequest

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

Return Value


The response from the GetCurrentMetricData 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 Framework:
Supported in: 4.5 and newer, 3.5

See Also