DescribeFleetMetric - AWS IoT

DescribeFleetMetric

Gets information about the specified fleet metric.

Requires permission to access the DescribeFleetMetric action.

Request Syntax

GET /fleet-metric/metricName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

metricName

The name of the fleet metric to describe.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "aggregationField": "string", "aggregationType": { "name": "string", "values": [ "string" ] }, "creationDate": number, "description": "string", "indexName": "string", "lastModifiedDate": number, "metricArn": "string", "metricName": "string", "period": number, "queryString": "string", "queryVersion": "string", "unit": "string", "version": number }

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.

aggregationField

The field to aggregate.

Type: String

Length Constraints: Minimum length of 1.

aggregationType

The type of the aggregation query.

Type: AggregationType object

creationDate

The date when the fleet metric is created.

Type: Timestamp

description

The fleet metric description.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: [\p{Graph}\x20]*

indexName

The name of the index to search.

Type: String

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

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

lastModifiedDate

The date when the fleet metric is last modified.

Type: Timestamp

metricArn

The ARN of the fleet metric to describe.

Type: String

metricName

The name of the fleet metric to describe.

Type: String

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

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

period

The time in seconds between fleet metric emissions. Range [60(1 min), 86400(1 day)] and must be multiple of 60.

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 86400.

queryString

The search query string.

Type: String

Length Constraints: Minimum length of 1.

queryVersion

The query version.

Type: String

unit

Used to support unit transformation such as milliseconds to seconds. The unit must be supported by CW metric.

Type: String

Valid Values: Seconds | Microseconds | Milliseconds | Bytes | Kilobytes | Megabytes | Gigabytes | Terabytes | Bits | Kilobits | Megabits | Gigabits | Terabits | Percent | Count | Bytes/Second | Kilobytes/Second | Megabytes/Second | Gigabytes/Second | Terabytes/Second | Bits/Second | Kilobits/Second | Megabits/Second | Gigabits/Second | Terabits/Second | Count/Second | None

version

The version of the fleet metric.

Type: Long

Errors

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: