UNPKG

@aws-sdk/client-iot

Version:

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

93 lines (92 loc) 3.73 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { ListPackagesRequest, ListPackagesResponse } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link ListPackagesCommand}. */ export interface ListPackagesCommandInput extends ListPackagesRequest { } /** * @public * * The output of {@link ListPackagesCommand}. */ export interface ListPackagesCommandOutput extends ListPackagesResponse, __MetadataBearer { } declare const ListPackagesCommand_base: { new (input: ListPackagesCommandInput): import("@smithy/smithy-client").CommandImpl<ListPackagesCommandInput, ListPackagesCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (...[input]: [] | [ListPackagesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListPackagesCommandInput, ListPackagesCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Lists the software packages associated to the account.</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">ListPackages</a> action.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, ListPackagesCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, ListPackagesCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // ListPackagesRequest * maxResults: Number("int"), * nextToken: "STRING_VALUE", * }; * const command = new ListPackagesCommand(input); * const response = await client.send(command); * // { // ListPackagesResponse * // packageSummaries: [ // PackageSummaryList * // { // PackageSummary * // packageName: "STRING_VALUE", * // defaultVersionName: "STRING_VALUE", * // creationDate: new Date("TIMESTAMP"), * // lastModifiedDate: new Date("TIMESTAMP"), * // }, * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param ListPackagesCommandInput - {@link ListPackagesCommandInput} * @returns {@link ListPackagesCommandOutput} * @see {@link ListPackagesCommandInput} for command's `input` shape. * @see {@link ListPackagesCommandOutput} 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 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 ListPackagesCommand extends ListPackagesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: ListPackagesRequest; output: ListPackagesResponse; }; sdk: { input: ListPackagesCommandInput; output: ListPackagesCommandOutput; }; }; }