Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.S3.PutBucketLifecycleConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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, 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 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:

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.
Status 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. 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 are related to PutBucketLifecycleConfiguration:

Synopsis

Creating a Request

data PutBucketLifecycleConfiguration Source #

See: newPutBucketLifecycleConfiguration smart constructor.

Constructors

PutBucketLifecycleConfiguration'

Fields

checksumAlgorithm :: Maybe ChecksumAlgorithm
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.
expectedBucketOwner :: Maybe Text
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
lifecycleConfiguration :: Maybe BucketLifecycleConfiguration
Container for lifecycle rules. You can add as many as 1,000 rules.
bucket :: BucketName
The name of the bucket for which to set the configuration.

Instances

Instances details

ToHeaders PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods toHeaders :: PutBucketLifecycleConfiguration -> [Header] #
ToPath PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods toPath :: PutBucketLifecycleConfiguration -> ByteString #
ToQuery PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods toQuery :: PutBucketLifecycleConfiguration -> QueryString #
ToElement PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods toElement :: PutBucketLifecycleConfiguration -> Element #
AWSRequest PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Associated Types type AWSResponse PutBucketLifecycleConfiguration # Methods request :: (Service -> Service) -> PutBucketLifecycleConfiguration -> Request PutBucketLifecycleConfiguration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutBucketLifecycleConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutBucketLifecycleConfiguration))) #
Generic PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Associated Types type Rep PutBucketLifecycleConfiguration :: Type -> Type # Methods from :: PutBucketLifecycleConfiguration -> Rep PutBucketLifecycleConfiguration x # to :: Rep PutBucketLifecycleConfiguration x -> PutBucketLifecycleConfiguration #
Read PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods readsPrec :: Int -> ReadS PutBucketLifecycleConfiguration # readList :: ReadS [PutBucketLifecycleConfiguration] # readPrec :: ReadPrec PutBucketLifecycleConfiguration # readListPrec :: ReadPrec [PutBucketLifecycleConfiguration] #
Show PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods showsPrec :: Int -> PutBucketLifecycleConfiguration -> ShowS # show :: PutBucketLifecycleConfiguration -> String # showList :: [PutBucketLifecycleConfiguration] -> ShowS #
NFData PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods rnf :: PutBucketLifecycleConfiguration -> () #
Eq PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods (==) :: PutBucketLifecycleConfiguration -> PutBucketLifecycleConfiguration -> Bool # (/=) :: PutBucketLifecycleConfiguration -> PutBucketLifecycleConfiguration -> Bool #
Hashable PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods hashWithSalt :: Int -> PutBucketLifecycleConfiguration -> Int # hash :: PutBucketLifecycleConfiguration -> Int #
type AWSResponse PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration type AWSResponse PutBucketLifecycleConfiguration = PutBucketLifecycleConfigurationResponse
type Rep PutBucketLifecycleConfiguration Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration type Rep PutBucketLifecycleConfiguration = D1 ('MetaData "PutBucketLifecycleConfiguration" "Amazonka.S3.PutBucketLifecycleConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutBucketLifecycleConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAlgorithm)) :: S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lifecycleConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BucketLifecycleConfiguration)) :*: S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName))))

newPutBucketLifecycleConfiguration Source #

Arguments

:: BucketName	`PutBucketLifecycleConfiguration`
-> PutBucketLifecycleConfiguration

Create a value of PutBucketLifecycleConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutBucketLifecycleConfiguration, putBucketLifecycleConfiguration_checksumAlgorithm - Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

$sel:expectedBucketOwner:PutBucketLifecycleConfiguration', putBucketLifecycleConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

$sel:lifecycleConfiguration:PutBucketLifecycleConfiguration', putBucketLifecycleConfiguration_lifecycleConfiguration - Container for lifecycle rules. You can add as many as 1,000 rules.

PutBucketLifecycleConfiguration, putBucketLifecycleConfiguration_bucket - The name of the bucket for which to set the configuration.

Request Lenses

putBucketLifecycleConfiguration_checksumAlgorithm :: Lens' PutBucketLifecycleConfiguration (Maybe ChecksumAlgorithm) Source #

Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not provide any additional functionality if not using the SDK. When sending this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

putBucketLifecycleConfiguration_expectedBucketOwner :: Lens' PutBucketLifecycleConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

putBucketLifecycleConfiguration_lifecycleConfiguration :: Lens' PutBucketLifecycleConfiguration (Maybe BucketLifecycleConfiguration) Source #

Container for lifecycle rules. You can add as many as 1,000 rules.

putBucketLifecycleConfiguration_bucket :: Lens' PutBucketLifecycleConfiguration BucketName Source #

The name of the bucket for which to set the configuration.

Destructuring the Response

data PutBucketLifecycleConfigurationResponse Source #

See: newPutBucketLifecycleConfigurationResponse smart constructor.

Constructors

PutBucketLifecycleConfigurationResponse'

Instances

Instances details

Generic PutBucketLifecycleConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Associated Types type Rep PutBucketLifecycleConfigurationResponse :: Type -> Type # Methods from :: PutBucketLifecycleConfigurationResponse -> Rep PutBucketLifecycleConfigurationResponse x # to :: Rep PutBucketLifecycleConfigurationResponse x -> PutBucketLifecycleConfigurationResponse #
Read PutBucketLifecycleConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods readsPrec :: Int -> ReadS PutBucketLifecycleConfigurationResponse # readList :: ReadS [PutBucketLifecycleConfigurationResponse] # readPrec :: ReadPrec PutBucketLifecycleConfigurationResponse # readListPrec :: ReadPrec [PutBucketLifecycleConfigurationResponse] #
Show PutBucketLifecycleConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods showsPrec :: Int -> PutBucketLifecycleConfigurationResponse -> ShowS # show :: PutBucketLifecycleConfigurationResponse -> String # showList :: [PutBucketLifecycleConfigurationResponse] -> ShowS #
NFData PutBucketLifecycleConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods rnf :: PutBucketLifecycleConfigurationResponse -> () #
Eq PutBucketLifecycleConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration Methods (==) :: PutBucketLifecycleConfigurationResponse -> PutBucketLifecycleConfigurationResponse -> Bool # (/=) :: PutBucketLifecycleConfigurationResponse -> PutBucketLifecycleConfigurationResponse -> Bool #
type Rep PutBucketLifecycleConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutBucketLifecycleConfiguration type Rep PutBucketLifecycleConfigurationResponse = D1 ('MetaData "PutBucketLifecycleConfigurationResponse" "Amazonka.S3.PutBucketLifecycleConfiguration" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutBucketLifecycleConfigurationResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newPutBucketLifecycleConfigurationResponse :: PutBucketLifecycleConfigurationResponse Source #

Create a value of PutBucketLifecycleConfigurationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.