import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { PutBucketLifecycleConfigurationRequest } from "../models/models_0"; import { 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 __MetadataBearer { } declare const PutBucketLifecycleConfigurationCommand_base: { new (input: PutBucketLifecycleConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl; new (__0_0: PutBucketLifecycleConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** * *

This operation is not supported by directory buckets.

*
*

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 Managing * your storage lifecycle.

* *

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 PutBucketLifecycle.

*
*
*
Rules
*
*

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. * Each rule consists of the following:

*
    *
  • *

    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.

    *
  • *
  • *

    A status indicating whether the rule is in effect.

    *
  • *
  • *

    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.

    *
  • *
*

For more information, see Object Lifecycle * Management and Lifecycle Configuration * Elements.

*
*
Permissions
*
*

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 * get the s3:PutLifecycleConfiguration permission.

*

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:

*
    *
  • *

    * s3:DeleteObject *

    *
  • *
  • *

    * s3:DeleteObjectVersion *

    *
  • *
  • *

    * s3:PutLifecycleConfiguration *

    *
  • *
*

For more information about permissions, see Managing Access * Permissions to Your Amazon S3 Resources.

*
*
*

The following operations are related to * PutBucketLifecycleConfiguration:

* * @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 * const client = new S3Client(config); * const input = { // PutBucketLifecycleConfigurationRequest * Bucket: "STRING_VALUE", // required * ChecksumAlgorithm: "CRC32" || "CRC32C" || "SHA1" || "SHA256", * 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 Union: only one key present * 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", * }; * const command = new PutBucketLifecycleConfigurationCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @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} *

Base exception class for all service exceptions from S3 service.

* * @public * @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); * await client.send(command); * // example id: put-bucket-lifecycle-1482264533092 * ``` * */ export declare class PutBucketLifecycleConfigurationCommand extends PutBucketLifecycleConfigurationCommand_base { }