DMleadgen
46d973904b
Next.js website for Rocky Mountain Vending company featuring: - Product catalog with Stripe integration - Service areas and parts pages - Admin dashboard with Clerk authentication - SEO optimized pages with JSON-LD structured data Co-authored-by: Cursor <cursoragent@cursor.com>
314 lines
16 KiB
Text
314 lines
16 KiB
Text
import { Command as $Command } from "@smithy/smithy-client";
|
||
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
||
import type { PutBucketAclRequest } from "../models/models_0";
|
||
import type { 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;
|
||
};
|
||
/**
|
||
* <important>
|
||
* <p>End of support notice: As of October 1, 2025, Amazon S3 has discontinued support for Email Grantee Access Control Lists (ACLs). If you attempt to use an Email Grantee ACL in a request after October 1, 2025,
|
||
* the request will receive an <code>HTTP 405</code> (Method Not Allowed) error.</p>
|
||
* <p>This change affects the following Amazon Web Services Regions: US East (N. Virginia), US West (N. California), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Europe (Ireland), and South America (São Paulo).</p>
|
||
* </important>
|
||
* <note>
|
||
* <p>This operation is not supported for directory buckets.</p>
|
||
* </note>
|
||
* <p>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.</p>
|
||
* <p>You can use one of the following two ways to set a bucket's permissions:</p>
|
||
* <ul>
|
||
* <li>
|
||
* <p>Specify the ACL in the request body</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>Specify permissions using request headers</p>
|
||
* </li>
|
||
* </ul>
|
||
* <note>
|
||
* <p>You cannot specify access permission using both the body and the request headers.</p>
|
||
* </note>
|
||
* <p>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.</p>
|
||
* <important>
|
||
* <p>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 <i>Amazon S3 User Guide</i>.</p>
|
||
* </important>
|
||
* <dl>
|
||
* <dt>Permissions</dt>
|
||
* <dd>
|
||
* <p>You can set access permissions by using one of the following methods:</p>
|
||
* <ul>
|
||
* <li>
|
||
* <p>Specify a canned ACL with the <code>x-amz-acl</code> request header. Amazon S3 supports a set
|
||
* of predefined ACLs, known as <i>canned ACLs</i>. 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>.</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>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>.</p>
|
||
* <p>You specify each grantee as a type=value pair, where the type is one of the
|
||
* following:</p>
|
||
* <ul>
|
||
* <li>
|
||
* <p>
|
||
* <code>id</code> – if the value specified is the canonical user ID of an
|
||
* Amazon Web Services account</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>
|
||
* <code>uri</code> – if you are granting permissions to a predefined group</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>
|
||
* <code>emailAddress</code> – if the value specified is the email address of an
|
||
* Amazon Web Services account</p>
|
||
* <note>
|
||
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
||
* <ul>
|
||
* <li>
|
||
* <p>US East (N. Virginia)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>US West (N. California)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p> US West (Oregon)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p> Asia Pacific (Singapore)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>Asia Pacific (Sydney)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>Asia Pacific (Tokyo)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>Europe (Ireland)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>South America (São Paulo)</p>
|
||
* </li>
|
||
* </ul>
|
||
* <p>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.</p>
|
||
* </note>
|
||
* </li>
|
||
* </ul>
|
||
* <p>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.</p>
|
||
* <p>
|
||
* <code>x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
|
||
* id="111122223333", id="555566667777" </code>
|
||
* </p>
|
||
* </li>
|
||
* </ul>
|
||
* <p>You can use either a canned ACL or specify access permissions explicitly. You cannot do
|
||
* both.</p>
|
||
* </dd>
|
||
* <dt>Grantee Values</dt>
|
||
* <dd>
|
||
* <p>You can specify the person (grantee) to whom you're assigning access rights (using request
|
||
* elements) in the following ways. For examples of how to specify these grantee values in JSON
|
||
* format, see the Amazon Web Services CLI example in <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-server-access-logging.html"> Enabling Amazon S3 server
|
||
* access logging</a> in the <i>Amazon S3 User Guide</i>.</p>
|
||
* <ul>
|
||
* <li>
|
||
* <p>By the person's ID:</p>
|
||
* <p>
|
||
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||
* xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName>
|
||
* </Grantee></code>
|
||
* </p>
|
||
* <p>DisplayName is optional and ignored in the request</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>By URI:</p>
|
||
* <p>
|
||
* <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>
|
||
* </p>
|
||
* </li>
|
||
* <li>
|
||
* <p>By Email address:</p>
|
||
* <p>
|
||
* <code><Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||
* xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress>&</Grantee></code>
|
||
* </p>
|
||
* <p>The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl
|
||
* request, appears as the CanonicalUser. </p>
|
||
* <note>
|
||
* <p>Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions: </p>
|
||
* <ul>
|
||
* <li>
|
||
* <p>US East (N. Virginia)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>US West (N. California)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p> US West (Oregon)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p> Asia Pacific (Singapore)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>Asia Pacific (Sydney)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>Asia Pacific (Tokyo)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>Europe (Ireland)</p>
|
||
* </li>
|
||
* <li>
|
||
* <p>South America (São Paulo)</p>
|
||
* </li>
|
||
* </ul>
|
||
* <p>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.</p>
|
||
* </note>
|
||
* </li>
|
||
* </ul>
|
||
* </dd>
|
||
* </dl>
|
||
* <p>The following operations are related to <code>PutBucketAcl</code>:</p>
|
||
* <ul>
|
||
* <li>
|
||
* <p>
|
||
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a>
|
||
* </p>
|
||
* </li>
|
||
* <li>
|
||
* <p>
|
||
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html">DeleteBucket</a>
|
||
* </p>
|
||
* </li>
|
||
* <li>
|
||
* <p>
|
||
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html">GetObjectAcl</a>
|
||
* </p>
|
||
* </li>
|
||
* </ul>
|
||
* <important>
|
||
* <p>You must URL encode any signed header values that contain spaces. For example, if your header value is <code>my file.txt</code>, containing two spaces after <code>my</code>, you must URL encode this value to <code>my%20%20file.txt</code>.</p>
|
||
* </important>
|
||
* @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
|
||
* // import type { S3ClientConfig } from "@aws-sdk/client-s3";
|
||
* const config = {}; // type is S3ClientConfig
|
||
* 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}
|
||
* <p>Base exception class for all service exceptions from S3 service.</p>
|
||
*
|
||
*
|
||
* @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;
|
||
};
|
||
};
|
||
}
|