UNPKG

@aws-sdk/client-lambda

Version:

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

104 lines (103 loc) 5.33 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../LambdaClient"; import { AddLayerVersionPermissionRequest, AddLayerVersionPermissionResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link AddLayerVersionPermissionCommand}. */ export interface AddLayerVersionPermissionCommandInput extends AddLayerVersionPermissionRequest { } /** * @public * * The output of {@link AddLayerVersionPermissionCommand}. */ export interface AddLayerVersionPermissionCommandOutput extends AddLayerVersionPermissionResponse, __MetadataBearer { } declare const AddLayerVersionPermissionCommand_base: { new (input: AddLayerVersionPermissionCommandInput): import("@smithy/smithy-client").CommandImpl<AddLayerVersionPermissionCommandInput, AddLayerVersionPermissionCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: AddLayerVersionPermissionCommandInput): import("@smithy/smithy-client").CommandImpl<AddLayerVersionPermissionCommandInput, AddLayerVersionPermissionCommandOutput, LambdaClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <p>Adds permissions to the resource-based policy of a version of an <a href="https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html">Lambda * layer</a>. Use this action to grant layer * usage permission to other accounts. You can grant permission to a single account, all accounts in an organization, * or all Amazon Web Services accounts. </p> * <p>To revoke permission, call <a>RemoveLayerVersionPermission</a> with the statement ID that you * specified when you added it.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { LambdaClient, AddLayerVersionPermissionCommand } from "@aws-sdk/client-lambda"; // ES Modules import * // const { LambdaClient, AddLayerVersionPermissionCommand } = require("@aws-sdk/client-lambda"); // CommonJS import * const client = new LambdaClient(config); * const input = { // AddLayerVersionPermissionRequest * LayerName: "STRING_VALUE", // required * VersionNumber: Number("long"), // required * StatementId: "STRING_VALUE", // required * Action: "STRING_VALUE", // required * Principal: "STRING_VALUE", // required * OrganizationId: "STRING_VALUE", * RevisionId: "STRING_VALUE", * }; * const command = new AddLayerVersionPermissionCommand(input); * const response = await client.send(command); * // { // AddLayerVersionPermissionResponse * // Statement: "STRING_VALUE", * // RevisionId: "STRING_VALUE", * // }; * * ``` * * @param AddLayerVersionPermissionCommandInput - {@link AddLayerVersionPermissionCommandInput} * @returns {@link AddLayerVersionPermissionCommandOutput} * @see {@link AddLayerVersionPermissionCommandInput} for command's `input` shape. * @see {@link AddLayerVersionPermissionCommandOutput} for command's `response` shape. * @see {@link LambdaClientResolvedConfig | config} for LambdaClient's `config` shape. * * @throws {@link InvalidParameterValueException} (client fault) * <p>One of the parameters in the request is not valid.</p> * * @throws {@link PolicyLengthExceededException} (client fault) * <p>The permissions policy for the resource is too large. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html">Lambda quotas</a>.</p> * * @throws {@link PreconditionFailedException} (client fault) * <p>The RevisionId provided does not match the latest RevisionId for the Lambda function or alias.</p> * <ul> * <li> * <p> * <b>For AddPermission and RemovePermission API operations:</b> Call <code>GetPolicy</code> to retrieve the latest RevisionId for your resource.</p> * </li> * <li> * <p> * <b>For all other API operations:</b> Call <code>GetFunction</code> or <code>GetAlias</code> to retrieve the latest RevisionId for your resource.</p> * </li> * </ul> * * @throws {@link ResourceConflictException} (client fault) * <p>The resource already exists, or another operation is in progress.</p> * * @throws {@link ResourceNotFoundException} (client fault) * <p>The resource specified in the request does not exist.</p> * * @throws {@link ServiceException} (server fault) * <p>The Lambda service encountered an internal error.</p> * * @throws {@link TooManyRequestsException} (client fault) * <p>The request throughput limit was exceeded. For more information, see <a href="https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html#api-requests">Lambda quotas</a>.</p> * * @throws {@link LambdaServiceException} * <p>Base exception class for all service exceptions from Lambda service.</p> * * @public */ export declare class AddLayerVersionPermissionCommand extends AddLayerVersionPermissionCommand_base { }