/custom-metric/{metricName}

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

Gets information about a Device Defender detect custom metric.

Requires permission to access the DescribeCustomMetric action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/custom-metric/'

Response Example

200 - Example 1

{
    "metricName": "string",
    "metricArn": "string",
    "metricType": "string-list",
    "displayName": "string",
    "creationDate": "string",
    "lastModifiedDate": "string"
}

Request

Path Params

metricName

string

required

The name of the custom metric.

Responses

🟢200Success

application/json

Body

metricName

string

optional

The name of the custom metric.

>= 1 characters<= 128 characters

Match pattern:

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

metricArn

string

optional

The Amazon Resource Number (ARN) of the custom metric.

metricType

enum<string>

optional

The type of the custom metric. Types include string-list, ip-address-list, number-list, and number.

Allowed values:

string-listip-address-listnumber-listnumber

displayName

string

optional

Field represents a friendly name in the console for the custom metric; doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated.

<= 128 characters

Match pattern:

[\p{Graph}\x20]*

creationDate

string <date-time>

optional

The creation date of the custom metric in milliseconds since epoch.

lastModifiedDate

string <date-time>

optional

The time the custom metric was last modified in milliseconds since epoch.

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483InternalFailureException

Modified at 2022-09-10 23:12:13

/wireless-gateway-task-definitions/{Id}