UNPKG

@aws-sdk/client-iot

Version:

AWS SDK for JavaScript Iot Client for Node.js, Browser and React Native

81 lines (80 loc) 3.57 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { UpdateCustomMetricRequest, UpdateCustomMetricResponse } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdateCustomMetricCommand}. */ export interface UpdateCustomMetricCommandInput extends UpdateCustomMetricRequest { } /** * @public * * The output of {@link UpdateCustomMetricCommand}. */ export interface UpdateCustomMetricCommandOutput extends UpdateCustomMetricResponse, __MetadataBearer { } declare const UpdateCustomMetricCommand_base: { new (input: UpdateCustomMetricCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCustomMetricCommandInput, UpdateCustomMetricCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: UpdateCustomMetricCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateCustomMetricCommandInput, UpdateCustomMetricCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Updates a * Device Defender detect custom 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">UpdateCustomMetric</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, UpdateCustomMetricCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, UpdateCustomMetricCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // UpdateCustomMetricRequest * metricName: "STRING_VALUE", // required * displayName: "STRING_VALUE", // required * }; * const command = new UpdateCustomMetricCommand(input); * const response = await client.send(command); * // { // UpdateCustomMetricResponse * // metricName: "STRING_VALUE", * // metricArn: "STRING_VALUE", * // metricType: "string-list" || "ip-address-list" || "number-list" || "number", * // displayName: "STRING_VALUE", * // creationDate: new Date("TIMESTAMP"), * // lastModifiedDate: new Date("TIMESTAMP"), * // }; * * ``` * * @param UpdateCustomMetricCommandInput - {@link UpdateCustomMetricCommandInput} * @returns {@link UpdateCustomMetricCommandOutput} * @see {@link UpdateCustomMetricCommandInput} for command's `input` shape. * @see {@link UpdateCustomMetricCommandOutput} 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 ThrottlingException} (client fault) * <p>The rate exceeds the limit.</p> * * @throws {@link IoTServiceException} * <p>Base exception class for all service exceptions from IoT service.</p> * * @public */ export declare class UpdateCustomMetricCommand extends UpdateCustomMetricCommand_base { }