@aws-sdk/client-iot
Version:
AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native
109 lines (108 loc) • 4.95 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { DescribeFleetMetricRequest, DescribeFleetMetricResponse } from "../models/models_1";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link DescribeFleetMetricCommand}.
*/
export interface DescribeFleetMetricCommandInput extends DescribeFleetMetricRequest {
}
/**
* @public
*
* The output of {@link DescribeFleetMetricCommand}.
*/
export interface DescribeFleetMetricCommandOutput extends DescribeFleetMetricResponse, __MetadataBearer {
}
declare const DescribeFleetMetricCommand_base: {
new (input: DescribeFleetMetricCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeFleetMetricCommandInput, DescribeFleetMetricCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: DescribeFleetMetricCommandInput): import("@smithy/smithy-client").CommandImpl<DescribeFleetMetricCommandInput, DescribeFleetMetricCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Gets information about the specified fleet metric.</p>
* <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeFleetMetric</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { IoTClient, DescribeFleetMetricCommand } from "@aws-sdk/client-iot"; // ES Modules import
* // const { IoTClient, DescribeFleetMetricCommand } = require("@aws-sdk/client-iot"); // CommonJS import
* const client = new IoTClient(config);
* const input = { // DescribeFleetMetricRequest
* metricName: "STRING_VALUE", // required
* };
* const command = new DescribeFleetMetricCommand(input);
* const response = await client.send(command);
* // { // DescribeFleetMetricResponse
* // metricName: "STRING_VALUE",
* // queryString: "STRING_VALUE",
* // aggregationType: { // AggregationType
* // name: "Statistics" || "Percentiles" || "Cardinality", // required
* // values: [ // AggregationTypeValues
* // "STRING_VALUE",
* // ],
* // },
* // period: Number("int"),
* // aggregationField: "STRING_VALUE",
* // description: "STRING_VALUE",
* // queryVersion: "STRING_VALUE",
* // indexName: "STRING_VALUE",
* // creationDate: new Date("TIMESTAMP"),
* // lastModifiedDate: new Date("TIMESTAMP"),
* // unit: "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: Number("long"),
* // metricArn: "STRING_VALUE",
* // };
*
* ```
*
* @param DescribeFleetMetricCommandInput - {@link DescribeFleetMetricCommandInput}
* @returns {@link DescribeFleetMetricCommandOutput}
* @see {@link DescribeFleetMetricCommandInput} for command's `input` shape.
* @see {@link DescribeFleetMetricCommandOutput} for command's `response` shape.
* @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape.
*
* @throws {@link InternalFailureException} (server fault)
* <p>An unexpected error has occurred.</p>
*
* @throws {@link InvalidRequestException} (client fault)
* <p>The request is not valid.</p>
*
* @throws {@link ResourceNotFoundException} (client fault)
* <p>The specified resource does not exist.</p>
*
* @throws {@link ServiceUnavailableException} (server fault)
* <p>The service is temporarily unavailable.</p>
*
* @throws {@link ThrottlingException} (client fault)
* <p>The rate exceeds the limit.</p>
*
* @throws {@link UnauthorizedException} (client fault)
* <p>You are not authorized to perform this operation.</p>
*
* @throws {@link IoTServiceException}
* <p>Base exception class for all service exceptions from IoT service.</p>
*
*
* @public
*/
export declare class DescribeFleetMetricCommand extends DescribeFleetMetricCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: DescribeFleetMetricRequest;
output: DescribeFleetMetricResponse;
};
sdk: {
input: DescribeFleetMetricCommandInput;
output: DescribeFleetMetricCommandOutput;
};
};
}