@aws-sdk/client-s3

import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint"; import { Command as $Command } from "@aws-sdk/smithy-client"; import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types"; import { PutBucketLifecycleConfigurationRequest } from "../models/models_0"; import { S3ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../S3Client"; export interface PutBucketLifecycleConfigurationCommandInput extends PutBucketLifecycleConfigurationRequest { } export interface PutBucketLifecycleConfigurationCommandOutput extends __MetadataBearer { } /** * 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>. * * <note> * Bucket lifecycle configuration now supports specifying a lifecycle rule using an * object key name prefix, one or more object tags, or a combination of both. 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>. * </note> * * * * * 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: * * <ul> * <li> * Filter identifying a subset of objects to which the rule applies. The filter can * be based on a key name prefix, object tags, or a combination of both. * </li> * <li> * Status whether the rule is in effect. * </li> * <li> * 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. * </li> * </ul> * * 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>. * * * * 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 <code>s3:PutLifecycleConfiguration</code> * permission. * * You can also explicitly deny permissions. 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: * * <ul> * <li> * * <code>s3:DeleteObject</code> * * </li> * <li> * * <code>s3:DeleteObjectVersion</code> * * </li> * <li> * * <code>s3:PutLifecycleConfiguration</code> * * </li> * </ul> * * * 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>. * * The following are related to <code>PutBucketLifecycleConfiguration</code>: * <ul> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html">Examples of * Lifecycle Configuration</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html">GetBucketLifecycleConfiguration</a> * * </li> * <li> * * <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html">DeleteBucketLifecycle</a> * * </li> * </ul> * @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 command = new PutBucketLifecycleConfigurationCommand(input); * const response = await client.send(command); * ``` * * @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. * */ export declare class PutBucketLifecycleConfigurationCommand extends $Command<PutBucketLifecycleConfigurationCommandInput, PutBucketLifecycleConfigurationCommandOutput, S3ClientResolvedConfig> { readonly input: PutBucketLifecycleConfigurationCommandInput; static getEndpointParameterInstructions(): EndpointParameterInstructions; constructor(input: PutBucketLifecycleConfigurationCommandInput); /** * @internal */ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: S3ClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PutBucketLifecycleConfigurationCommandInput, PutBucketLifecycleConfigurationCommandOutput>; private serialize; private deserialize; }