@aws-sdk/client-s3

import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { PutBucketAclRequest } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link PutBucketAclCommand}. */ export interface PutBucketAclCommandInput extends PutBucketAclRequest { } /** * @public * * The output of {@link PutBucketAclCommand}. */ export interface PutBucketAclCommandOutput extends __MetadataBearer { } declare const PutBucketAclCommand_base: { new (input: PutBucketAclCommandInput): import("@smithy/smithy-client").CommandImpl<PutBucketAclCommandInput, PutBucketAclCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; new (input: PutBucketAclCommandInput): import("@smithy/smithy-client").CommandImpl<PutBucketAclCommandInput, PutBucketAclCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * <note> * This operation is not supported for directory buckets. * </note> * Sets the permissions on an existing bucket using access control lists (ACL). For more * information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html">Using ACLs</a>. To set the ACL of a * bucket, you must have the <code>WRITE_ACP</code> permission. * You can use one of the following two ways to set a bucket's permissions: * <ul> * <li> * Specify the ACL in the request body * </li> * <li> * Specify permissions using request headers * </li> * </ul> * <note> * You cannot specify access permission using both the body and the request * headers. * </note> * Depending on your application needs, you may choose to set the ACL on a bucket using * either the request body or the headers. For example, if you have an existing application * that updates a bucket ACL using the request body, then you can continue to use that * approach. * <important> * If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs * are disabled and no longer affect permissions. You must use policies to grant access to * your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return * the <code>AccessControlListNotSupported</code> error code. Requests to read ACLs are * still supported. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Controlling object * ownership</a> in the Amazon S3 User Guide. * </important> * <dl> * <dt>Permissions</dt> * <dd> * You can set access permissions by using one of the following methods: * <ul> * <li> * Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 * supports a set of predefined ACLs, known as canned * ACLs. Each canned ACL has a predefined set of grantees and * permissions. Specify the canned ACL name as the value of * <code>x-amz-acl</code>. If you use this header, you cannot use other * access control-specific headers in your request. For more information, see * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL">Canned * ACL</a>. * </li> * <li> * Specify access permissions explicitly with the * <code>x-amz-grant-read</code>, <code>x-amz-grant-read-acp</code>, * <code>x-amz-grant-write-acp</code>, and * <code>x-amz-grant-full-control</code> headers. When using these headers, * you specify explicit access permissions and grantees (Amazon Web Services accounts or Amazon S3 * groups) who will receive the permission. If you use these ACL-specific * headers, you cannot use the <code>x-amz-acl</code> header to set a canned * ACL. These parameters map to the set of permissions that Amazon S3 supports in an * ACL. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html">Access Control List (ACL) * Overview</a>. * You specify each grantee as a type=value pair, where the type is one of * the following: * <ul> * <li> * * <code>id</code> – if the value specified is the canonical user ID * of an Amazon Web Services account * </li> * <li> * * <code>uri</code> – if you are granting permissions to a predefined * group * </li> * <li> * * <code>emailAddress</code> – if the value specified is the email * address of an Amazon Web Services account * <note> * Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: * <ul> * <li> * US East (N. Virginia) * </li> * <li> * US West (N. California) * </li> * <li> * US West (Oregon) * </li> * <li> * Asia Pacific (Singapore) * </li> * <li> * Asia Pacific (Sydney) * </li> * <li> * Asia Pacific (Tokyo) * </li> * <li> * Europe (Ireland) * </li> * <li> * South America (São Paulo) * </li> * </ul> * For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference. * </note> * </li> * </ul> * For example, the following <code>x-amz-grant-write</code> header grants * create, overwrite, and delete objects permission to LogDelivery group * predefined by Amazon S3 and two Amazon Web Services accounts identified by their email * addresses. * * <code>x-amz-grant-write: * uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", * id="555566667777" </code> * * </li> * </ul> * You can use either a canned ACL or specify access permissions explicitly. You * cannot do both. * </dd> * <dt>Grantee Values</dt> * <dd> * You can specify the person (grantee) to whom you're assigning access rights * (using request elements) in the following ways: * <ul> * <li> * By the person's ID: * * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> * </Grantee></code> * * DisplayName is optional and ignored in the request * </li> * <li> * By URI: * * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee></code> * * </li> * <li> * By Email address: * * <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee></code> * * The grantee is resolved to the CanonicalUser and, in a response to a GET * Object acl request, appears as the CanonicalUser. * <note> * Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: * <ul> * <li> * US East (N. Virginia) * </li> * <li> * US West (N. California) * </li> * <li> * US West (Oregon) * </li> * <li> * Asia Pacific (Singapore) * </li> * <li> * Asia Pacific (Sydney) * </li> * <li> * Asia Pacific (Tokyo) * </li> * <li> * Europe (Ireland) * </li> * <li> * South America (São Paulo) * </li> * </ul> * For a list of all the Amazon S3 supported Regions and endpoints, see <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region">Regions and Endpoints</a> in the Amazon Web Services General Reference. * </note> * </li> * </ul> * </dd> * </dl> * The following operations are related to <code>PutBucketAcl</code>: * <ul> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a> * * </li> * </ul> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { S3Client, PutBucketAclCommand } from "@aws-sdk/client-s3"; // ES Modules import * // const { S3Client, PutBucketAclCommand } = require("@aws-sdk/client-s3"); // CommonJS import * const client = new S3Client(config); * const input = { // PutBucketAclRequest * ACL: "private" || "public-read" || "public-read-write" || "authenticated-read", * AccessControlPolicy: { // AccessControlPolicy * Grants: [ // Grants * { // Grant * Grantee: { // Grantee * DisplayName: "STRING_VALUE", * EmailAddress: "STRING_VALUE", * ID: "STRING_VALUE", * URI: "STRING_VALUE", * Type: "CanonicalUser" || "AmazonCustomerByEmail" || "Group", // required * }, * Permission: "FULL_CONTROL" || "WRITE" || "WRITE_ACP" || "READ" || "READ_ACP", * }, * ], * Owner: { // Owner * DisplayName: "STRING_VALUE", * ID: "STRING_VALUE", * }, * }, * Bucket: "STRING_VALUE", // required * ContentMD5: "STRING_VALUE", * ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME", * GrantFullControl: "STRING_VALUE", * GrantRead: "STRING_VALUE", * GrantReadACP: "STRING_VALUE", * GrantWrite: "STRING_VALUE", * GrantWriteACP: "STRING_VALUE", * ExpectedBucketOwner: "STRING_VALUE", * }; * const command = new PutBucketAclCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param PutBucketAclCommandInput - {@link PutBucketAclCommandInput} * @returns {@link PutBucketAclCommandOutput} * @see {@link PutBucketAclCommandInput} for command's `input` shape. * @see {@link PutBucketAclCommandOutput} for command's `response` shape. * @see {@link S3ClientResolvedConfig | config} for S3Client's `config` shape. * * @throws {@link S3ServiceException} * Base exception class for all service exceptions from S3 service. * * * @example Put bucket acl * ```javascript * // The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console. * const input = { * Bucket: "examplebucket", * GrantFullControl: "id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484", * GrantWrite: "uri=http://acs.amazonaws.com/groups/s3/LogDelivery" * }; * const command = new PutBucketAclCommand(input); * const response = await client.send(command); * /* response is * { /* metadata only *\/ } * *\/ * ``` * * @public */ export declare class PutBucketAclCommand extends PutBucketAclCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: PutBucketAclRequest; output: {}; }; sdk: { input: PutBucketAclCommandInput; output: PutBucketAclCommandOutput; }; }; }