Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

ListMetrics

Retrieves a paginated list of metric summaries for the specified Connect Customer instance. Use pagination to ensure that the operation returns quickly and successfully.

Request Syntax


GET /metrics/definitions/InstanceId?maxResults=MaxResults&nextToken=NextToken&type=Type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

InstanceId

The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

MaxResults

The maximum number of results to return per page.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

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.

Type

The type of metrics to list. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.

Valid Values: AWS_MANAGED | CUSTOMER_MANAGED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "MetricSummaryList": [ 
      { 
         "Arn": "string",
         "Id": "string",
         "LastModifiedRegion": "string",
         "LastModifiedTime": number,
         "Name": "string",
         "Status": "string",
         "Type": "string"
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MetricSummaryList

The list of metric summaries.

Type: Array of MetricSummary objects

NextToken

If there are additional results, this is the token for the next set of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient permissions to perform this action.

HTTP Status Code: 403

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Example

The following example lists customer-managed metrics.

Sample Request


GET /metrics/definitions/12345678-1234-1234-1234-123456789012?type=CUSTOMER_MANAGED&maxResults=10