/custom-metric/{metricName}

The AWS IoT Wireless multi-region endpoint

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

POST

/custom-metric/{metricName}

Use this API to define a Custom Metric published by your devices to Device Defender.

Requires permission to access the CreateCustomMetric action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/custom-metric/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "displayName": "string",
    "metricType": "string-list",
    "tags": [
        {
            "Key": "string",
            "Value": "string"
        }
    ],
    "clientRequestToken": "string"
}'

Response Example

200 - Example 1

{
    "metricName": "string",
    "metricArn": "string"
}

Request

Path Params

metricName

string

required

The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with aws:. Cannot be updated once defined.

Body Params application/json

displayName

string

optional

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

<= 128 characters

Match pattern:

[\p{Graph}\x20]*

metricType

enum<string>

required

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

Allowed values:

string-listip-address-listnumber-listnumber

tags

array[object (Tag) {2}]

optional

Metadata that can be used to manage the custom metric.

Key

string

required

The tag's key value.

>= 1 characters<= 128 characters

Value

string

required

The tag's value.

>= 0 characters<= 256 characters

clientRequestToken

string

required

Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

>= 1 characters<= 64 characters

Match pattern:

^[a-zA-Z0-9-_]+$

Examples

Responses

🟢200Success

application/json

Body

metricName

string

optional

The name of the custom metric to be used in the metric report.

>= 1 characters<= 128 characters

Match pattern:

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

metricArn

string

optional

The Amazon Resource Number (ARN) of the custom metric, e.g. arn:aws-partition:iot:region:accountId:custommetric/metricName

🟠480InvalidRequestException

🟠481LimitExceededException

🟠482ResourceAlreadyExistsException

🟠483ThrottlingException

🟠484InternalFailureException

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

/wireless-gateways/{Id}

/wireless-gateways/{Id}