UNPKG

@aws-sdk/client-iot

Version:

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

103 lines (102 loc) 4.42 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../IoTClient"; import { UpdatePackageVersionRequest, UpdatePackageVersionResponse } from "../models/models_2"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link UpdatePackageVersionCommand}. */ export interface UpdatePackageVersionCommandInput extends UpdatePackageVersionRequest { } /** * @public * * The output of {@link UpdatePackageVersionCommand}. */ export interface UpdatePackageVersionCommandOutput extends UpdatePackageVersionResponse, __MetadataBearer { } declare const UpdatePackageVersionCommand_base: { new (input: UpdatePackageVersionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePackageVersionCommandInput, UpdatePackageVersionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (input: UpdatePackageVersionCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePackageVersionCommandInput, UpdatePackageVersionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Updates the supported fields for a specific 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">UpdatePackageVersion</a> and <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">GetIndexingConfiguration</a> actions.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { IoTClient, UpdatePackageVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import * // const { IoTClient, UpdatePackageVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import * const client = new IoTClient(config); * const input = { // UpdatePackageVersionRequest * packageName: "STRING_VALUE", // required * versionName: "STRING_VALUE", // required * description: "STRING_VALUE", * attributes: { // ResourceAttributes * "<keys>": "STRING_VALUE", * }, * artifact: { // PackageVersionArtifact * s3Location: { // S3Location * bucket: "STRING_VALUE", * key: "STRING_VALUE", * version: "STRING_VALUE", * }, * }, * action: "PUBLISH" || "DEPRECATE", * recipe: "STRING_VALUE", * clientToken: "STRING_VALUE", * }; * const command = new UpdatePackageVersionCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param UpdatePackageVersionCommandInput - {@link UpdatePackageVersionCommandInput} * @returns {@link UpdatePackageVersionCommandOutput} * @see {@link UpdatePackageVersionCommandInput} for command's `input` shape. * @see {@link UpdatePackageVersionCommandOutput} for command's `response` shape. * @see {@link IoTClientResolvedConfig | config} for IoTClient's `config` shape. * * @throws {@link ConflictException} (client fault) * <p>The request conflicts with the current state of the resource.</p> * * @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 UpdatePackageVersionCommand extends UpdatePackageVersionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdatePackageVersionRequest; output: {}; }; sdk: { input: UpdatePackageVersionCommandInput; output: UpdatePackageVersionCommandOutput; }; }; }