ListCustomMetrics

Lists your Device Defender detect custom metrics.

Requires permission to access the ListCustomMetrics action.

Request Syntax


GET /custom-metrics?maxResults=maxResults&nextToken=nextToken HTTP/1.1

The request uses the following URI parameters.

The maximum number of results to return at one time. The default is 25.

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

The token for the next set of results.

The request does not have a request body.


HTTP/1.1 200
Content-type: application/json

{
   "metricNames": [ "string" ],
   "nextToken": "string"
}

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

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

The name of the custom metric.

Type: Array of strings

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

Pattern: [a-zA-Z0-9:_-]+

A token that can be used to retrieve the next set of results, or null if there are no additional results.

Type: String

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400