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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Applies a Legal Hold configuration to the specified object. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

Synopsis

data PutObjectLegalHold = PutObjectLegalHold' {
- legalHold :: Maybe ObjectLockLegalHold
- versionId :: Maybe ObjectVersionId
- requestPayer :: Maybe RequestPayer
- contentMD5 :: Maybe Text
- expectedBucketOwner :: Maybe Text
- bucket :: BucketName
- key :: ObjectKey
}
newPutObjectLegalHold :: BucketName -> ObjectKey -> PutObjectLegalHold
putObjectLegalHold_legalHold :: Lens' PutObjectLegalHold (Maybe ObjectLockLegalHold)
putObjectLegalHold_versionId :: Lens' PutObjectLegalHold (Maybe ObjectVersionId)
putObjectLegalHold_requestPayer :: Lens' PutObjectLegalHold (Maybe RequestPayer)
putObjectLegalHold_contentMD5 :: Lens' PutObjectLegalHold (Maybe Text)
putObjectLegalHold_expectedBucketOwner :: Lens' PutObjectLegalHold (Maybe Text)
putObjectLegalHold_bucket :: Lens' PutObjectLegalHold BucketName
putObjectLegalHold_key :: Lens' PutObjectLegalHold ObjectKey
data PutObjectLegalHoldResponse = PutObjectLegalHoldResponse' {
- requestCharged :: Maybe RequestCharged
- httpStatus :: Int
}
newPutObjectLegalHoldResponse :: Int -> PutObjectLegalHoldResponse
putObjectLegalHoldResponse_requestCharged :: Lens' PutObjectLegalHoldResponse (Maybe RequestCharged)
putObjectLegalHoldResponse_httpStatus :: Lens' PutObjectLegalHoldResponse Int

Creating a Request

data PutObjectLegalHold Source #

See: newPutObjectLegalHold smart constructor.

Constructors

PutObjectLegalHold'

Fields

legalHold :: Maybe ObjectLockLegalHold
Container element for the Legal Hold configuration you want to apply to the specified object.
versionId :: Maybe ObjectVersionId
The version ID of the object that you want to place a Legal Hold on.
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 name containing the object that you want to place a Legal Hold on.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
key :: ObjectKey
The key name for the object that you want to place a Legal Hold on.

Instances

Instances details

Eq PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Methods (==) :: PutObjectLegalHold -> PutObjectLegalHold -> Bool # (/=) :: PutObjectLegalHold -> PutObjectLegalHold -> Bool #
Read PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Methods readsPrec :: Int -> ReadS PutObjectLegalHold # readList :: ReadS [PutObjectLegalHold] # readPrec :: ReadPrec PutObjectLegalHold # readListPrec :: ReadPrec [PutObjectLegalHold] #
Show PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Methods showsPrec :: Int -> PutObjectLegalHold -> ShowS # show :: PutObjectLegalHold -> String # showList :: [PutObjectLegalHold] -> ShowS #
Generic PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Associated Types type Rep PutObjectLegalHold :: Type -> Type # Methods from :: PutObjectLegalHold -> Rep PutObjectLegalHold x # to :: Rep PutObjectLegalHold x -> PutObjectLegalHold #
NFData PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Methods rnf :: PutObjectLegalHold -> () #
Hashable PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Methods hashWithSalt :: Int -> PutObjectLegalHold -> Int # hash :: PutObjectLegalHold -> Int #
AWSRequest PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Associated Types type AWSResponse PutObjectLegalHold # Methods request :: PutObjectLegalHold -> Request PutObjectLegalHold # response :: MonadResource m => Logger -> Service -> Proxy PutObjectLegalHold -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutObjectLegalHold))) #
ToHeaders PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Methods toHeaders :: PutObjectLegalHold -> [Header] #
ToPath PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Methods toPath :: PutObjectLegalHold -> ByteString #
ToQuery PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Methods toQuery :: PutObjectLegalHold -> QueryString #
ToElement PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold Methods toElement :: PutObjectLegalHold -> Element #
type Rep PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold type Rep PutObjectLegalHold = D1 ('MetaData "PutObjectLegalHold" "Amazonka.S3.PutObjectLegalHold" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "PutObjectLegalHold'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "legalHold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLockLegalHold)) :: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectVersionId)) :: 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) :: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectKey)))))
type AWSResponse PutObjectLegalHold Source #
Instance details Defined in Amazonka.S3.PutObjectLegalHold type AWSResponse PutObjectLegalHold = PutObjectLegalHoldResponse

newPutObjectLegalHold Source #

Arguments

:: BucketName	`$sel:bucket:PutObjectLegalHold'`
-> ObjectKey	`$sel:key:PutObjectLegalHold'`
-> PutObjectLegalHold

Create a value of PutObjectLegalHold 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:legalHold:PutObjectLegalHold', putObjectLegalHold_legalHold - Container element for the Legal Hold configuration you want to apply to the specified object.

$sel:versionId:PutObjectLegalHold', putObjectLegalHold_versionId - The version ID of the object that you want to place a Legal Hold on.

$sel:requestPayer:PutObjectLegalHold', putObjectLegalHold_requestPayer - Undocumented member.

$sel:contentMD5:PutObjectLegalHold', putObjectLegalHold_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:PutObjectLegalHold', putObjectLegalHold_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:PutObjectLegalHold', putObjectLegalHold_bucket - The bucket name containing the object that you want to place a Legal Hold on.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

$sel:key:PutObjectLegalHold', putObjectLegalHold_key - The key name for the object that you want to place a Legal Hold on.

Request Lenses

putObjectLegalHold_legalHold :: Lens' PutObjectLegalHold (Maybe ObjectLockLegalHold) Source #

Container element for the Legal Hold configuration you want to apply to the specified object.

putObjectLegalHold_versionId :: Lens' PutObjectLegalHold (Maybe ObjectVersionId) Source #

The version ID of the object that you want to place a Legal Hold on.

putObjectLegalHold_requestPayer :: Lens' PutObjectLegalHold (Maybe RequestPayer) Source #

Undocumented member.

putObjectLegalHold_contentMD5 :: Lens' PutObjectLegalHold (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.

putObjectLegalHold_expectedBucketOwner :: Lens' PutObjectLegalHold (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.

putObjectLegalHold_bucket :: Lens' PutObjectLegalHold BucketName Source #

The bucket name containing the object that you want to place a Legal Hold on.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

putObjectLegalHold_key :: Lens' PutObjectLegalHold ObjectKey Source #

The key name for the object that you want to place a Legal Hold on.

Destructuring the Response

data PutObjectLegalHoldResponse Source #

See: newPutObjectLegalHoldResponse smart constructor.

Constructors

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

Instances

Instances details

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

newPutObjectLegalHoldResponse Source #

Arguments

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

Create a value of PutObjectLegalHoldResponse 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:PutObjectLegalHoldResponse', putObjectLegalHoldResponse_requestCharged - Undocumented member.

$sel:httpStatus:PutObjectLegalHoldResponse', putObjectLegalHoldResponse_httpStatus - The response's http status code.

Response Lenses

putObjectLegalHoldResponse_requestCharged :: Lens' PutObjectLegalHoldResponse (Maybe RequestCharged) Source #

Undocumented member.

putObjectLegalHoldResponse_httpStatus :: Lens' PutObjectLegalHoldResponse Int Source #

The response's http status code.