Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3.PutObjectLockConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

The DefaultRetention settings require both a mode and a period.
The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.
You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact Amazon Web Services Support.

Synopsis

Creating a Request

data PutObjectLockConfiguration Source #

See: newPutObjectLockConfiguration smart constructor.

Constructors

PutObjectLockConfiguration'

Fields

token :: Maybe Text
A token to allow Object Lock to be enabled for an existing bucket.
objectLockConfiguration :: Maybe ObjectLockConfiguration
The Object Lock configuration that you want to apply to the specified bucket.
requestPayer :: Maybe RequestPayer
contentMD5 :: Maybe Text
The MD5 hash for the request body.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
expectedBucketOwner :: Maybe Text
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.
bucket :: BucketName
The bucket whose Object Lock configuration you want to create or replace.

Instances

Instances details

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

newPutObjectLockConfiguration Source #

Arguments

:: BucketName	`$sel:bucket:PutObjectLockConfiguration'`
-> PutObjectLockConfiguration

Create a value of PutObjectLockConfiguration 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:

$sel:token:PutObjectLockConfiguration', putObjectLockConfiguration_token - A token to allow Object Lock to be enabled for an existing bucket.

$sel:objectLockConfiguration:PutObjectLockConfiguration', putObjectLockConfiguration_objectLockConfiguration - The Object Lock configuration that you want to apply to the specified bucket.

$sel:requestPayer:PutObjectLockConfiguration', putObjectLockConfiguration_requestPayer - Undocumented member.

$sel:contentMD5:PutObjectLockConfiguration', putObjectLockConfiguration_contentMD5 - The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

$sel:expectedBucketOwner:PutObjectLockConfiguration', putObjectLockConfiguration_expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

$sel:bucket:PutObjectLockConfiguration', putObjectLockConfiguration_bucket - The bucket whose Object Lock configuration you want to create or replace.

Request Lenses

putObjectLockConfiguration_token :: Lens' PutObjectLockConfiguration (Maybe Text) Source #

A token to allow Object Lock to be enabled for an existing bucket.

putObjectLockConfiguration_objectLockConfiguration :: Lens' PutObjectLockConfiguration (Maybe ObjectLockConfiguration) Source #

The Object Lock configuration that you want to apply to the specified bucket.

putObjectLockConfiguration_requestPayer :: Lens' PutObjectLockConfiguration (Maybe RequestPayer) Source #

Undocumented member.

putObjectLockConfiguration_contentMD5 :: Lens' PutObjectLockConfiguration (Maybe Text) Source #

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

putObjectLockConfiguration_expectedBucketOwner :: Lens' PutObjectLockConfiguration (Maybe Text) Source #

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

putObjectLockConfiguration_bucket :: Lens' PutObjectLockConfiguration BucketName Source #

The bucket whose Object Lock configuration you want to create or replace.

Destructuring the Response

data PutObjectLockConfigurationResponse Source #

See: newPutObjectLockConfigurationResponse smart constructor.

Constructors

PutObjectLockConfigurationResponse'
Fields requestCharged :: Maybe RequestCharged httpStatus :: Int The response's http status code.

Instances

Instances details

Eq PutObjectLockConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutObjectLockConfiguration Methods (==) :: PutObjectLockConfigurationResponse -> PutObjectLockConfigurationResponse -> Bool # (/=) :: PutObjectLockConfigurationResponse -> PutObjectLockConfigurationResponse -> Bool #
Read PutObjectLockConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutObjectLockConfiguration Methods readsPrec :: Int -> ReadS PutObjectLockConfigurationResponse # readList :: ReadS [PutObjectLockConfigurationResponse] # readPrec :: ReadPrec PutObjectLockConfigurationResponse # readListPrec :: ReadPrec [PutObjectLockConfigurationResponse] #
Show PutObjectLockConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutObjectLockConfiguration Methods showsPrec :: Int -> PutObjectLockConfigurationResponse -> ShowS # show :: PutObjectLockConfigurationResponse -> String # showList :: [PutObjectLockConfigurationResponse] -> ShowS #
Generic PutObjectLockConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutObjectLockConfiguration Associated Types type Rep PutObjectLockConfigurationResponse :: Type -> Type # Methods from :: PutObjectLockConfigurationResponse -> Rep PutObjectLockConfigurationResponse x # to :: Rep PutObjectLockConfigurationResponse x -> PutObjectLockConfigurationResponse #
NFData PutObjectLockConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutObjectLockConfiguration Methods rnf :: PutObjectLockConfigurationResponse -> () #
type Rep PutObjectLockConfigurationResponse Source #
Instance details Defined in Amazonka.S3.PutObjectLockConfiguration type Rep PutObjectLockConfigurationResponse = D1 ('MetaData "PutObjectLockConfigurationResponse" "Amazonka.S3.PutObjectLockConfiguration" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "PutObjectLockConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestCharged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestCharged)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newPutObjectLockConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutObjectLockConfigurationResponse'`
-> PutObjectLockConfigurationResponse

Create a value of PutObjectLockConfigurationResponse 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:

$sel:requestCharged:PutObjectLockConfigurationResponse', putObjectLockConfigurationResponse_requestCharged - Undocumented member.

$sel:httpStatus:PutObjectLockConfigurationResponse', putObjectLockConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

putObjectLockConfigurationResponse_requestCharged :: Lens' PutObjectLockConfigurationResponse (Maybe RequestCharged) Source #

Undocumented member.

putObjectLockConfigurationResponse_httpStatus :: Lens' PutObjectLockConfigurationResponse Int Source #

The response's http status code.