UNPKG

@aws-sdk/client-s3-control

Version:

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

104 lines (103 loc) 5.4 kB
import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { GetAccessPointConfigurationForObjectLambdaRequest, GetAccessPointConfigurationForObjectLambdaResult } from "../models/models_0"; import { S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3ControlClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link GetAccessPointConfigurationForObjectLambdaCommand}. */ export interface GetAccessPointConfigurationForObjectLambdaCommandInput extends GetAccessPointConfigurationForObjectLambdaRequest { } /** * @public * * The output of {@link GetAccessPointConfigurationForObjectLambdaCommand}. */ export interface GetAccessPointConfigurationForObjectLambdaCommandOutput extends GetAccessPointConfigurationForObjectLambdaResult, __MetadataBearer { } declare const GetAccessPointConfigurationForObjectLambdaCommand_base: { new (input: GetAccessPointConfigurationForObjectLambdaCommandInput): import("@smithy/smithy-client").CommandImpl<GetAccessPointConfigurationForObjectLambdaCommandInput, GetAccessPointConfigurationForObjectLambdaCommandOutput, S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (__0_0: GetAccessPointConfigurationForObjectLambdaCommandInput): import("@smithy/smithy-client").CommandImpl<GetAccessPointConfigurationForObjectLambdaCommandInput, GetAccessPointConfigurationForObjectLambdaCommandOutput, S3ControlClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <note> * <p>This operation is not supported by directory buckets.</p> * </note> * <p>Returns configuration for an Object Lambda Access Point.</p> * <p>The following actions are related to * <code>GetAccessPointConfigurationForObjectLambda</code>:</p> * <ul> * <li> * <p> * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html">PutAccessPointConfigurationForObjectLambda</a> * </p> * </li> * </ul> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3ControlClient, GetAccessPointConfigurationForObjectLambdaCommand } from "@aws-sdk/client-s3-control"; // ES Modules import * // const { S3ControlClient, GetAccessPointConfigurationForObjectLambdaCommand } = require("@aws-sdk/client-s3-control"); // CommonJS import * const client = new S3ControlClient(config); * const input = { // GetAccessPointConfigurationForObjectLambdaRequest * AccountId: "STRING_VALUE", * Name: "STRING_VALUE", // required * }; * const command = new GetAccessPointConfigurationForObjectLambdaCommand(input); * const response = await client.send(command); * // { // GetAccessPointConfigurationForObjectLambdaResult * // Configuration: { // ObjectLambdaConfiguration * // SupportingAccessPoint: "STRING_VALUE", // required * // CloudWatchMetricsEnabled: true || false, * // AllowedFeatures: [ // ObjectLambdaAllowedFeaturesList * // "GetObject-Range" || "GetObject-PartNumber" || "HeadObject-Range" || "HeadObject-PartNumber", * // ], * // TransformationConfigurations: [ // ObjectLambdaTransformationConfigurationsList // required * // { // ObjectLambdaTransformationConfiguration * // Actions: [ // ObjectLambdaTransformationConfigurationActionsList // required * // "GetObject" || "HeadObject" || "ListObjects" || "ListObjectsV2", * // ], * // ContentTransformation: { // ObjectLambdaContentTransformation Union: only one key present * // AwsLambda: { // AwsLambdaTransformation * // FunctionArn: "STRING_VALUE", // required * // FunctionPayload: "STRING_VALUE", * // }, * // }, * // }, * // ], * // }, * // }; * * ``` * * @param GetAccessPointConfigurationForObjectLambdaCommandInput - {@link GetAccessPointConfigurationForObjectLambdaCommandInput} * @returns {@link GetAccessPointConfigurationForObjectLambdaCommandOutput} * @see {@link GetAccessPointConfigurationForObjectLambdaCommandInput} for command's `input` shape. * @see {@link GetAccessPointConfigurationForObjectLambdaCommandOutput} 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 GetAccessPointConfigurationForObjectLambdaCommand extends GetAccessPointConfigurationForObjectLambdaCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetAccessPointConfigurationForObjectLambdaRequest; output: GetAccessPointConfigurationForObjectLambdaResult; }; sdk: { input: GetAccessPointConfigurationForObjectLambdaCommandInput; output: GetAccessPointConfigurationForObjectLambdaCommandOutput; }; }; }