SummaryMetricQueryResult - AWS IoT Wireless

SummaryMetricQueryResult

The result of the summary metrics aggregation operation.

Contents

AggregationPeriod

The aggregation period of the metric.

Type: String

Valid Values: OneHour | OneDay | OneWeek

Required: No

Dimensions

The dimensions of the metric.

Type: Array of Dimension objects

Required: No

EndTimestamp

The end timestamp for the summary metric query.

Type: Timestamp

Required: No

Error

The error message for the summary metric query result.

Type: String

Length Constraints: Maximum length of 256.

Required: No

MetricName

The name of the summary metric query result.

Type: String

Length Constraints: Maximum length of 256.

Valid Values: DeviceRSSI | DeviceSNR | DeviceRoamingRSSI | DeviceRoamingSNR | DeviceUplinkCount | DeviceDownlinkCount | DeviceUplinkLostCount | DeviceUplinkLostRate | DeviceJoinRequestCount | DeviceJoinAcceptCount | DeviceRoamingUplinkCount | DeviceRoamingDownlinkCount | GatewayUpTime | GatewayDownTime | GatewayRSSI | GatewaySNR | GatewayUplinkCount | GatewayDownlinkCount | GatewayJoinRequestCount | GatewayJoinAcceptCount | AwsAccountUplinkCount | AwsAccountDownlinkCount | AwsAccountUplinkLostCount | AwsAccountUplinkLostRate | AwsAccountJoinRequestCount | AwsAccountJoinAcceptCount | AwsAccountRoamingUplinkCount | AwsAccountRoamingDownlinkCount | AwsAccountDeviceCount | AwsAccountGatewayCount | AwsAccountActiveDeviceCount | AwsAccountActiveGatewayCount

Required: No

QueryId

The ID of the summary metric results query operation.

Type: String

Length Constraints: Maximum length of 256.

Required: No

QueryStatus

The status of the summary metric query result.

Type: String

Valid Values: Succeeded | Failed

Required: No

StartTimestamp

The start timestamp for the summary metric query.

Type: Timestamp

Required: No

Timestamps

The timestamp of each aggregation result.

Type: Array of timestamps

Required: No

Unit

The units of measurement to be used for interpreting the aggregation result.

Type: String

Length Constraints: Maximum length of 256.

Required: No

Values

The list of aggregated summary metric query results.

Type: Array of MetricQueryValue objects

Required: No

See Also

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