UNPKG

@aws-sdk/client-s3-control

Version:

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

89 lines (88 loc) 4.46 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { PutAccessPointPolicyForObjectLambdaRequest } from "../models/models_1"; import { S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3ControlClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PutAccessPointPolicyForObjectLambdaCommand}. */ export interface PutAccessPointPolicyForObjectLambdaCommandInput extends PutAccessPointPolicyForObjectLambdaRequest { } /** * @public * * The output of {@link PutAccessPointPolicyForObjectLambdaCommand}. */ export interface PutAccessPointPolicyForObjectLambdaCommandOutput extends __MetadataBearer { } declare const PutAccessPointPolicyForObjectLambdaCommand_base: { new (input: PutAccessPointPolicyForObjectLambdaCommandInput): import("@smithy/smithy-client").CommandImpl<PutAccessPointPolicyForObjectLambdaCommandInput, PutAccessPointPolicyForObjectLambdaCommandOutput, S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: PutAccessPointPolicyForObjectLambdaCommandInput): import("@smithy/smithy-client").CommandImpl<PutAccessPointPolicyForObjectLambdaCommandInput, PutAccessPointPolicyForObjectLambdaCommandOutput, S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <note> * <p>This operation is not supported by directory buckets.</p> * </note> * <p>Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli">Creating Object Lambda Access Points</a> in the <i>Amazon S3 User Guide</i>.</p> * <p>The following actions are related to * <code>PutAccessPointPolicyForObjectLambda</code>:</p> * <ul> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html">DeleteAccessPointPolicyForObjectLambda</a> * </p> * </li> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html">GetAccessPointPolicyForObjectLambda</a> * </p> * </li> * </ul> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3ControlClient, PutAccessPointPolicyForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import * // const { S3ControlClient, PutAccessPointPolicyForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import * const client = new S3ControlClient(config); * const input = { // PutAccessPointPolicyForObjectLambdaRequest * AccountId: "STRING_VALUE", * Name: "STRING_VALUE", // required * Policy: "STRING_VALUE", // required * }; * const command = new PutAccessPointPolicyForObjectLambdaCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param PutAccessPointPolicyForObjectLambdaCommandInput - {@link PutAccessPointPolicyForObjectLambdaCommandInput} * @returns {@link PutAccessPointPolicyForObjectLambdaCommandOutput} * @see {@link PutAccessPointPolicyForObjectLambdaCommandInput} for command's `input` shape. * @see {@link PutAccessPointPolicyForObjectLambdaCommandOutput} for command's `response` shape. * @see {@link S3ControlClientResolvedConfig | config} for S3ControlClient's `config` shape. * * @throws {@link S3ControlServiceException} * <p>Base exception class for all service exceptions from S3Control service.</p> * * @public */ export declare class PutAccessPointPolicyForObjectLambdaCommand extends PutAccessPointPolicyForObjectLambdaCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: PutAccessPointPolicyForObjectLambdaRequest; output: {}; }; sdk: { input: PutAccessPointPolicyForObjectLambdaCommandInput; output: PutAccessPointPolicyForObjectLambdaCommandOutput; }; }; }