@aws-sdk/client-iot
Version:
AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native
106 lines (105 loc) • 4.79 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { UpdateFleetMetricRequest } from "../models/models_2";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link UpdateFleetMetricCommand}.
*/
export interface UpdateFleetMetricCommandInput extends UpdateFleetMetricRequest {
}
/**
* @public
*
* The output of {@link UpdateFleetMetricCommand}.
*/
export interface UpdateFleetMetricCommandOutput extends __MetadataBearer {
}
declare const UpdateFleetMetricCommand_base: {
new (input: UpdateFleetMetricCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateFleetMetricCommandInput, UpdateFleetMetricCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (__0_0: UpdateFleetMetricCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateFleetMetricCommandInput, UpdateFleetMetricCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Updates the data for a 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">UpdateFleetMetric</a> action.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { IoTClient, UpdateFleetMetricCommand } from "@aws-sdk/client-iot"; // ES Modules import
* // const { IoTClient, UpdateFleetMetricCommand } = require("@aws-sdk/client-iot"); // CommonJS import
* const client = new IoTClient(config);
* const input = { // UpdateFleetMetricRequest
* metricName: "STRING_VALUE", // required
* 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", // required
* 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",
* expectedVersion: Number("long"),
* };
* const command = new UpdateFleetMetricCommand(input);
* const response = await client.send(command);
* // {};
*
* ```
*
* @param UpdateFleetMetricCommandInput - {@link UpdateFleetMetricCommandInput}
* @returns {@link UpdateFleetMetricCommandOutput}
* @see {@link UpdateFleetMetricCommandInput} for command's `input` shape.
* @see {@link UpdateFleetMetricCommandOutput} for command's `response` shape.
* @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape.
*
* @throws {@link IndexNotReadyException} (client fault)
* <p>The index is not ready.</p>
*
* @throws {@link InternalFailureException} (server fault)
* <p>An unexpected error has occurred.</p>
*
* @throws {@link InvalidAggregationException} (client fault)
* <p>The aggregation is invalid.</p>
*
* @throws {@link InvalidQueryException} (client fault)
* <p>The query is invalid.</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 VersionConflictException} (client fault)
* <p>An exception thrown when the version of an entity specified with the
* <code>expectedVersion</code> parameter does not match the latest version in the
* system.</p>
*
* @throws {@link IoTServiceException}
* <p>Base exception class for all service exceptions from IoT service.</p>
*
* @public
*/
export declare class UpdateFleetMetricCommand extends UpdateFleetMetricCommand_base {
}