GetMetrics - AWS IoT Wireless

GetMetrics

Get the summary metrics for this AWS account.

Request Syntax

POST /metrics HTTP/1.1 Content-type: application/json { "SummaryMetricQueries": [ { "AggregationPeriod": "string", "Dimensions": [ { "name": "string", "value": "string" } ], "EndTimestamp": number, "MetricName": "string", "QueryId": "string", "StartTimestamp": number } ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

SummaryMetricQueries

The list of queries to retrieve the summary metrics.

Type: Array of SummaryMetricQuery objects

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "SummaryMetricQueryResults": [ { "AggregationPeriod": "string", "Dimensions": [ { "name": "string", "value": "string" } ], "EndTimestamp": number, "Error": "string", "MetricName": "string", "QueryId": "string", "QueryStatus": "string", "StartTimestamp": number, "Timestamps": [ number ], "Unit": "string", "Values": [ { "Avg": number, "Max": number, "Min": number, "P90": number, "Std": number, "Sum": 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.

SummaryMetricQueryResults

The list of summary metrics that were retrieved.

Type: Array of SummaryMetricQueryResult objects

Errors

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

AccessDeniedException

User does not have permission to perform this action.

HTTP Status Code: 403

ConflictException

Adding, updating, or deleting the resource can cause an inconsistent state.

HTTP Status Code: 409

InternalServerException

An unexpected error occurred while processing a request.

HTTP Status Code: 500

ResourceNotFoundException

Resource does not exist.

HTTP Status Code: 404

ThrottlingException

The request was denied because it exceeded the allowed API request rate.

HTTP Status Code: 429

ValidationException

The input did not meet the specified constraints.

HTTP Status Code: 400

See Also

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