@aws-sdk/client-s3
Version:
AWS SDK for JavaScript S3 Client for Node.js, Browser and React Native
293 lines (292 loc) • 16 kB
TypeScript
import { Command as $Command } from "@smithy/smithy-client";
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { PutBucketLifecycleConfigurationOutput, PutBucketLifecycleConfigurationRequest } from "../models/models_0";
import type { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client";
/**
* @public
*/
export type { __MetadataBearer };
export { $Command };
/**
* @public
*
* The input for {@link PutBucketLifecycleConfigurationCommand}.
*/
export interface PutBucketLifecycleConfigurationCommandInput extends PutBucketLifecycleConfigurationRequest {
}
/**
* @public
*
* The output of {@link PutBucketLifecycleConfigurationCommand}.
*/
export interface PutBucketLifecycleConfigurationCommandOutput extends PutBucketLifecycleConfigurationOutput, __MetadataBearer {
}
declare const PutBucketLifecycleConfigurationCommand_base: {
new (input: PutBucketLifecycleConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<PutBucketLifecycleConfigurationCommandInput, PutBucketLifecycleConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
new (input: PutBucketLifecycleConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl<PutBucketLifecycleConfigurationCommandInput, PutBucketLifecycleConfigurationCommandOutput, S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
};
/**
* <p>Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle
* configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want
* to retain any configuration details, they must be included in the new lifecycle configuration. For
* information about lifecycle configuration, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html">Managing your storage
* lifecycle</a>.</p>
* <note>
* <p>Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name
* prefix, one or more object tags, object size, or any combination of these. Accordingly, this section
* describes the latest API. The previous version of the API supported filtering based only on an object
* key name prefix, which is supported for backward compatibility. For the related API description, see
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>.</p>
* </note>
* <dl>
* <dt>Rules</dt>
* <dd>
* <p>You specify the lifecycle configuration in your request body. The lifecycle configuration is
* specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to
* 1,000 rules. This limit is not adjustable.</p>
* <p>Bucket lifecycle configuration supports specifying a lifecycle rule using an object key name
* prefix, one or more object tags, object size, or any combination of these. Accordingly, this
* section describes the latest API. The previous version of the API supported filtering based only
* on an object key name prefix, which is supported for backward compatibility for general purpose
* buckets. For the related API description, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html">PutBucketLifecycle</a>. </p>
* <note>
* <p>Lifecyle configurations for directory buckets only support expiring objects and cancelling
* multipart uploads. Expiring of versioned objects,transitions and tag filters are not
* supported.</p>
* </note>
* <p>A lifecycle rule consists of the following:</p>
* <ul>
* <li>
* <p>A filter identifying a subset of objects to which the rule applies. The filter can be
* based on a key name prefix, object tags, object size, or any combination of these.</p>
* </li>
* <li>
* <p>A status indicating whether the rule is in effect.</p>
* </li>
* <li>
* <p>One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on
* the objects identified by the filter. If the state of your bucket is versioning-enabled or
* versioning-suspended, you can have many versions of the same object (one current version and
* zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for
* current and noncurrent object versions.</p>
* </li>
* </ul>
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html">Object Lifecycle Management</a> and
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html">Lifecycle
* Configuration Elements</a>.</p>
* </dd>
* <dt>Permissions</dt>
* <dd>
* <ul>
* <li>
* <p>
* <b>General purpose bucket permissions</b> - By default, all Amazon S3
* resources are private, including buckets, objects, and related subresources (for example,
* lifecycle configuration and website configuration). Only the resource owner (that is, the
* Amazon Web Services account that created it) can access the resource. The resource owner can optionally
* grant access permissions to others by writing an access policy. For this operation, a user
* must have the <code>s3:PutLifecycleConfiguration</code> permission.</p>
* <p>You can also explicitly deny permissions. An explicit deny also supersedes any other
* permissions. If you want to block users or accounts from removing or deleting objects from
* your bucket, you must deny them permissions for the following actions:</p>
* <ul>
* <li>
* <p>
* <code>s3:DeleteObject</code>
* </p>
* </li>
* <li>
* <p>
* <code>s3:DeleteObjectVersion</code>
* </p>
* </li>
* <li>
* <p>
* <code>s3:PutLifecycleConfiguration</code>
* </p>
* <p>For more information about permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html">Managing Access Permissions to
* Your Amazon S3 Resources</a>.</p>
* </li>
* </ul>
* </li>
* </ul>
* <ul>
* <li>
* <p>
* <b>Directory bucket permissions</b> - You must have the
* <code>s3express:PutLifecycleConfiguration</code> permission in an IAM identity-based policy
* to use this operation. Cross-account access to this API operation isn't supported. The
* resource owner can optionally grant access permissions to others by creating a role or user
* for them as long as they are within the same account as the owner and resource.</p>
* <p>For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Authorizing Regional endpoint APIs with IAM</a> in the <i>Amazon S3 User
* Guide</i>.</p>
* <note>
* <p>
* <b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i>
* </code>. Virtual-hosted-style requests aren't supported.
* For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the
* <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the
* <i>Amazon S3 User Guide</i>.</p>
* </note>
* </li>
* </ul>
* </dd>
* <dt>HTTP Host header syntax</dt>
* <dd>
* <p>
* <b>Directory buckets </b> - The HTTP Host header syntax is
* <code>s3express-control.<i>region</i>.amazonaws.com</code>.</p>
* <p>The following operations are related to <code>PutBucketLifecycleConfiguration</code>:</p>
* <ul>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a>
* </p>
* </li>
* <li>
* <p>
* <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a>
* </p>
* </li>
* </ul>
* </dd>
* </dl>
* <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, PutBucketLifecycleConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
* // const { S3Client, PutBucketLifecycleConfigurationCommand } = 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 = { // PutBucketLifecycleConfigurationRequest
* Bucket: "STRING_VALUE", // required
* ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256" || "CRC64NVME",
* LifecycleConfiguration: { // BucketLifecycleConfiguration
* Rules: [ // LifecycleRules // required
* { // LifecycleRule
* Expiration: { // LifecycleExpiration
* Date: new Date("TIMESTAMP"),
* Days: Number("int"),
* ExpiredObjectDeleteMarker: true || false,
* },
* ID: "STRING_VALUE",
* Prefix: "STRING_VALUE",
* Filter: { // LifecycleRuleFilter
* Prefix: "STRING_VALUE",
* Tag: { // Tag
* Key: "STRING_VALUE", // required
* Value: "STRING_VALUE", // required
* },
* ObjectSizeGreaterThan: Number("long"),
* ObjectSizeLessThan: Number("long"),
* And: { // LifecycleRuleAndOperator
* Prefix: "STRING_VALUE",
* Tags: [ // TagSet
* {
* Key: "STRING_VALUE", // required
* Value: "STRING_VALUE", // required
* },
* ],
* ObjectSizeGreaterThan: Number("long"),
* ObjectSizeLessThan: Number("long"),
* },
* },
* Status: "Enabled" || "Disabled", // required
* Transitions: [ // TransitionList
* { // Transition
* Date: new Date("TIMESTAMP"),
* Days: Number("int"),
* StorageClass: "GLACIER" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "GLACIER_IR",
* },
* ],
* NoncurrentVersionTransitions: [ // NoncurrentVersionTransitionList
* { // NoncurrentVersionTransition
* NoncurrentDays: Number("int"),
* StorageClass: "GLACIER" || "STANDARD_IA" || "ONEZONE_IA" || "INTELLIGENT_TIERING" || "DEEP_ARCHIVE" || "GLACIER_IR",
* NewerNoncurrentVersions: Number("int"),
* },
* ],
* NoncurrentVersionExpiration: { // NoncurrentVersionExpiration
* NoncurrentDays: Number("int"),
* NewerNoncurrentVersions: Number("int"),
* },
* AbortIncompleteMultipartUpload: { // AbortIncompleteMultipartUpload
* DaysAfterInitiation: Number("int"),
* },
* },
* ],
* },
* ExpectedBucketOwner: "STRING_VALUE",
* TransitionDefaultMinimumObjectSize: "varies_by_storage_class" || "all_storage_classes_128K",
* };
* const command = new PutBucketLifecycleConfigurationCommand(input);
* const response = await client.send(command);
* // { // PutBucketLifecycleConfigurationOutput
* // TransitionDefaultMinimumObjectSize: "varies_by_storage_class" || "all_storage_classes_128K",
* // };
*
* ```
*
* @param PutBucketLifecycleConfigurationCommandInput - {@link PutBucketLifecycleConfigurationCommandInput}
* @returns {@link PutBucketLifecycleConfigurationCommandOutput}
* @see {@link PutBucketLifecycleConfigurationCommandInput} for command's `input` shape.
* @see {@link PutBucketLifecycleConfigurationCommandOutput} 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 lifecycle
* ```javascript
* // The following example replaces existing lifecycle configuration, if any, on the specified bucket.
* const input = {
* Bucket: "examplebucket",
* LifecycleConfiguration: {
* Rules: [
* {
* Expiration: {
* Days: 3650
* },
* Filter: {
* Prefix: "documents/"
* },
* ID: "TestOnly",
* Status: "Enabled",
* Transitions: [
* {
* Days: 365,
* StorageClass: "GLACIER"
* }
* ]
* }
* ]
* }
* };
* const command = new PutBucketLifecycleConfigurationCommand(input);
* const response = await client.send(command);
* /* response is
* { /* metadata only *\/ }
* *\/
* ```
*
* @public
*/
export declare class PutBucketLifecycleConfigurationCommand extends PutBucketLifecycleConfigurationCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: PutBucketLifecycleConfigurationRequest;
output: PutBucketLifecycleConfigurationOutput;
};
sdk: {
input: PutBucketLifecycleConfigurationCommandInput;
output: PutBucketLifecycleConfigurationCommandOutput;
};
};
}