@aws-sdk/client-iot/dist-types/commands/GetCommandExecutionCommand.d.ts

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

import { Command as $Command } from "@smithy/smithy-client";
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient";
import { GetCommandExecutionRequest, GetCommandExecutionResponse } from "../models/models_1";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link GetCommandExecutionCommand}.
 */
export interface GetCommandExecutionCommandInput extends GetCommandExecutionRequest {
}
/**
 * @public
 *
 * The output of {@link GetCommandExecutionCommand}.
 */
export interface GetCommandExecutionCommandOutput extends GetCommandExecutionResponse, __MetadataBearer {
}
declare const GetCommandExecutionCommand_base: {
    new (input: GetCommandExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<GetCommandExecutionCommandInput, GetCommandExecutionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (input: GetCommandExecutionCommandInput): import("@smithy/smithy-client").CommandImpl<GetCommandExecutionCommandInput, GetCommandExecutionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
 * <p>Gets information about the specific command execution on a single device.</p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { IoTClient, GetCommandExecutionCommand } from "@aws-sdk/client-iot"; // ES Modules import
 * // const { IoTClient, GetCommandExecutionCommand } = require("@aws-sdk/client-iot"); // CommonJS import
 * const client = new IoTClient(config);
 * const input = { // GetCommandExecutionRequest
 *   executionId: "STRING_VALUE", // required
 *   targetArn: "STRING_VALUE", // required
 *   includeResult: true || false,
 * };
 * const command = new GetCommandExecutionCommand(input);
 * const response = await client.send(command);
 * // { // GetCommandExecutionResponse
 * //   executionId: "STRING_VALUE",
 * //   commandArn: "STRING_VALUE",
 * //   targetArn: "STRING_VALUE",
 * //   status: "CREATED" || "IN_PROGRESS" || "SUCCEEDED" || "FAILED" || "REJECTED" || "TIMED_OUT",
 * //   statusReason: { // StatusReason
 * //     reasonCode: "STRING_VALUE", // required
 * //     reasonDescription: "STRING_VALUE",
 * //   },
 * //   result: { // CommandExecutionResultMap
 * //     "<keys>": { // CommandExecutionResult
 * //       S: "STRING_VALUE",
 * //       B: true || false,
 * //       BIN: new Uint8Array(),
 * //     },
 * //   },
 * //   parameters: { // CommandExecutionParameterMap
 * //     "<keys>": { // CommandParameterValue
 * //       S: "STRING_VALUE",
 * //       B: true || false,
 * //       I: Number("int"),
 * //       L: Number("long"),
 * //       D: Number("double"),
 * //       BIN: new Uint8Array(),
 * //       UL: "STRING_VALUE",
 * //     },
 * //   },
 * //   executionTimeoutSeconds: Number("long"),
 * //   createdAt: new Date("TIMESTAMP"),
 * //   lastUpdatedAt: new Date("TIMESTAMP"),
 * //   startedAt: new Date("TIMESTAMP"),
 * //   completedAt: new Date("TIMESTAMP"),
 * //   timeToLive: new Date("TIMESTAMP"),
 * // };
 *
 * ```
 *
 * @param GetCommandExecutionCommandInput - {@link GetCommandExecutionCommandInput}
 * @returns {@link GetCommandExecutionCommandOutput}
 * @see {@link GetCommandExecutionCommandInput} for command's `input` shape.
 * @see {@link GetCommandExecutionCommandOutput} for command's `response` shape.
 * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape.
 *
 * @throws {@link InternalServerException} (server fault)
 *  <p>Internal error from the service that indicates an unexpected error or that the service
 *             is unavailable.</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 ValidationException} (client fault)
 *  <p>The request is not valid.</p>
 *
 * @throws {@link IoTServiceException}
 * <p>Base exception class for all service exceptions from IoT service.</p>
 *
 *
 * @public
 */
export declare class GetCommandExecutionCommand extends GetCommandExecutionCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: GetCommandExecutionRequest;
            output: GetCommandExecutionResponse;
        };
        sdk: {
            input: GetCommandExecutionCommandInput;
            output: GetCommandExecutionCommandOutput;
        };
    };
}