UNPKG

@aws-sdk/client-iot

Version:

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

74 lines (73 loc) 3.25 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { SetLoggingOptionsRequest } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link SetLoggingOptionsCommand}. */ export interface SetLoggingOptionsCommandInput extends SetLoggingOptionsRequest { } /** * @public * * The output of {@link SetLoggingOptionsCommand}. */ export interface SetLoggingOptionsCommandOutput extends __MetadataBearer { } declare const SetLoggingOptionsCommand_base: { new (input: SetLoggingOptionsCommandInput): import("@smithy/smithy-client").CommandImpl<SetLoggingOptionsCommandInput, SetLoggingOptionsCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: SetLoggingOptionsCommandInput): import("@smithy/smithy-client").CommandImpl<SetLoggingOptionsCommandInput, SetLoggingOptionsCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Sets the logging options.</p> * <p>NOTE: use of this command is not recommended. Use <code>SetV2LoggingOptions</code> * instead.</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">SetLoggingOptions</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, SetLoggingOptionsCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, SetLoggingOptionsCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // SetLoggingOptionsRequest * loggingOptionsPayload: { // LoggingOptionsPayload * roleArn: "STRING_VALUE", // required * logLevel: "DEBUG" || "INFO" || "ERROR" || "WARN" || "DISABLED", * }, * }; * const command = new SetLoggingOptionsCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param SetLoggingOptionsCommandInput - {@link SetLoggingOptionsCommandInput} * @returns {@link SetLoggingOptionsCommandOutput} * @see {@link SetLoggingOptionsCommandInput} for command's `input` shape. * @see {@link SetLoggingOptionsCommandOutput} for command's `response` shape. * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape. * * @throws {@link InternalException} (server fault) * <p>An unexpected error has occurred.</p> * * @throws {@link InvalidRequestException} (client fault) * <p>The request is not valid.</p> * * @throws {@link ServiceUnavailableException} (server fault) * <p>The service is temporarily unavailable.</p> * * @throws {@link IoTServiceException} * <p>Base exception class for all service exceptions from IoT service.</p> * * @public */ export declare class SetLoggingOptionsCommand extends SetLoggingOptionsCommand_base { }