@aws-sdk/client-iot/dist-types/commands/AssociateSbomWithPackageVersionCommand.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 { AssociateSbomWithPackageVersionRequest, AssociateSbomWithPackageVersionResponse } from "../models/models_0";
/**
 * @public
 */
export type { __MetadataBearer };
export { $Command };
/**
 * @public
 *
 * The input for {@link AssociateSbomWithPackageVersionCommand}.
 */
export interface AssociateSbomWithPackageVersionCommandInput extends AssociateSbomWithPackageVersionRequest {
}
/**
 * @public
 *
 * The output of {@link AssociateSbomWithPackageVersionCommand}.
 */
export interface AssociateSbomWithPackageVersionCommandOutput extends AssociateSbomWithPackageVersionResponse, __MetadataBearer {
}
declare const AssociateSbomWithPackageVersionCommand_base: {
    new (input: AssociateSbomWithPackageVersionCommandInput): import("@smithy/smithy-client").CommandImpl<AssociateSbomWithPackageVersionCommandInput, AssociateSbomWithPackageVersionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    new (input: AssociateSbomWithPackageVersionCommandInput): import("@smithy/smithy-client").CommandImpl<AssociateSbomWithPackageVersionCommandInput, AssociateSbomWithPackageVersionCommandOutput, IoTClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
 * <p>Associates the selected software bill of materials (SBOM) with a specific software 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">AssociateSbomWithPackageVersion</a> action.</p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { IoTClient, AssociateSbomWithPackageVersionCommand } from "@aws-sdk/client-iot"; // ES Modules import
 * // const { IoTClient, AssociateSbomWithPackageVersionCommand } = require("@aws-sdk/client-iot"); // CommonJS import
 * const client = new IoTClient(config);
 * const input = { // AssociateSbomWithPackageVersionRequest
 *   packageName: "STRING_VALUE", // required
 *   versionName: "STRING_VALUE", // required
 *   sbom: { // Sbom
 *     s3Location: { // S3Location
 *       bucket: "STRING_VALUE",
 *       key: "STRING_VALUE",
 *       version: "STRING_VALUE",
 *     },
 *   },
 *   clientToken: "STRING_VALUE",
 * };
 * const command = new AssociateSbomWithPackageVersionCommand(input);
 * const response = await client.send(command);
 * // { // AssociateSbomWithPackageVersionResponse
 * //   packageName: "STRING_VALUE",
 * //   versionName: "STRING_VALUE",
 * //   sbom: { // Sbom
 * //     s3Location: { // S3Location
 * //       bucket: "STRING_VALUE",
 * //       key: "STRING_VALUE",
 * //       version: "STRING_VALUE",
 * //     },
 * //   },
 * //   sbomValidationStatus: "IN_PROGRESS" || "FAILED" || "SUCCEEDED",
 * // };
 *
 * ```
 *
 * @param AssociateSbomWithPackageVersionCommandInput - {@link AssociateSbomWithPackageVersionCommandInput}
 * @returns {@link AssociateSbomWithPackageVersionCommandOutput}
 * @see {@link AssociateSbomWithPackageVersionCommandInput} for command's `input` shape.
 * @see {@link AssociateSbomWithPackageVersionCommandOutput} 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 ServiceQuotaExceededException} (client fault)
 *  <p>Service quota has been exceeded.</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 AssociateSbomWithPackageVersionCommand extends AssociateSbomWithPackageVersionCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: AssociateSbomWithPackageVersionRequest;
            output: AssociateSbomWithPackageVersionResponse;
        };
        sdk: {
            input: AssociateSbomWithPackageVersionCommandInput;
            output: AssociateSbomWithPackageVersionCommandOutput;
        };
    };
}