UNPKG

@aws-sdk/client-iot

Version:

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

86 lines (85 loc) 3.77 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { GetPackageVersionRequest, GetPackageVersionResponse } from "../models/models_1"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetPackageVersionCommand}. */ export interface GetPackageVersionCommandInput extends GetPackageVersionRequest { } /** * @public * * The output of {@link GetPackageVersionCommand}. */ export interface GetPackageVersionCommandOutput extends GetPackageVersionResponse, __MetadataBearer { } declare const GetPackageVersionCommand_base: { new (input: GetPackageVersionCommandInput): import("@smithy/smithy-client").CommandImpl<GetPackageVersionCommandInput, GetPackageVersionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: GetPackageVersionCommandInput): import("@smithy/smithy-client").CommandImpl<GetPackageVersionCommandInput, GetPackageVersionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Gets information about the specified package version. </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">GetPackageVersion</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, GetPackageVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, GetPackageVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // GetPackageVersionRequest * packageName: "STRING_VALUE", // required * versionName: "STRING_VALUE", // required * }; * const command = new GetPackageVersionCommand(input); * const response = await client.send(command); * // { // GetPackageVersionResponse * // packageVersionArn: "STRING_VALUE", * // packageName: "STRING_VALUE", * // versionName: "STRING_VALUE", * // description: "STRING_VALUE", * // attributes: { // ResourceAttributes * // "<keys>": "STRING_VALUE", * // }, * // status: "DRAFT" || "PUBLISHED" || "DEPRECATED", * // errorReason: "STRING_VALUE", * // creationDate: new Date("TIMESTAMP"), * // lastModifiedDate: new Date("TIMESTAMP"), * // }; * * ``` * * @param GetPackageVersionCommandInput - {@link GetPackageVersionCommandInput} * @returns {@link GetPackageVersionCommandOutput} * @see {@link GetPackageVersionCommandInput} for command's `input` shape. * @see {@link GetPackageVersionCommandOutput} 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 GetPackageVersionCommand extends GetPackageVersionCommand_base { }