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; new (input: PutBucketLifecycleConfigurationCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

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
*
Permissions
*
HTTP Host header syntax
*
*

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.

*

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

* *

Lifecyle configurations for directory buckets only support expiring objects and cancelling * multipart uploads. Expiring of versioned objects,transitions and tag filters are not * supported.

*
*

A lifecycle 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.

*
*
*
    *
  • *

    * General purpose bucket 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 have 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:

    * *
  • *
*
    *
  • *

    * Directory bucket permissions - You must have the * s3express:PutLifecycleConfiguration 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.

    *

    For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User * Guide.

    * *

    * Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name * . Virtual-hosted-style requests aren't supported. * For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the * Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the * Amazon S3 User Guide.

    *
    *
  • *
*
*
*

* Directory buckets - The HTTP Host header syntax is * s3express-control.region.amazonaws.com.

*

The following operations are related to PutBucketLifecycleConfiguration:

* *
*
* *

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

*
* @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} *

Base exception class for all service exceptions from S3 service.

* * * @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; }; }; }