Amazonka.S3.PutObjectLegalHold

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.

Creating a Request

data PutObjectLegalHold

See: newPutObjectLegalHold smart constructor.

Constructors

PutObjectLegalHold'

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.

• 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 fails with the HTTP status code 403 Forbidden (access denied).

• legalHold :: Maybe ObjectLockLegalHold

  Container element for the legal hold configuration you want to apply to the specified object.

• requestPayer :: Maybe RequestPayer
• versionId :: Maybe ObjectVersionId

  The version ID of the object that you want to place a legal hold on.

• 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

ToHeaders PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Methods

toHeaders :: PutObjectLegalHold -> [Header]

ToPath PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Methods

toPath :: PutObjectLegalHold -> ByteString

ToQuery PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Methods

toQuery :: PutObjectLegalHold -> QueryString

ToElement PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Methods

toElement :: PutObjectLegalHold -> Element

AWSRequest PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Associated Types

type AWSResponse PutObjectLegalHold

Methods

request :: (Service -> Service) -> PutObjectLegalHold -> Request PutObjectLegalHold

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutObjectLegalHold -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutObjectLegalHold)))

Generic PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Associated Types

type Rep PutObjectLegalHold :: Type -> Type

Methods

from :: PutObjectLegalHold -> Rep PutObjectLegalHold x

to :: Rep PutObjectLegalHold x -> PutObjectLegalHold

Read PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Methods

readsPrec :: Int -> ReadS PutObjectLegalHold

readList :: ReadS [PutObjectLegalHold]

readPrec :: ReadPrec PutObjectLegalHold

readListPrec :: ReadPrec [PutObjectLegalHold]

Show PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Methods

showsPrec :: Int -> PutObjectLegalHold -> ShowS

show :: PutObjectLegalHold -> String

showList :: [PutObjectLegalHold] -> ShowS

NFData PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Methods

rnf :: PutObjectLegalHold -> ()

Eq PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Methods

(==) :: PutObjectLegalHold -> PutObjectLegalHold -> Bool

(/=) :: PutObjectLegalHold -> PutObjectLegalHold -> Bool

Hashable PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

Methods

hashWithSalt :: Int -> PutObjectLegalHold -> Int

hash :: PutObjectLegalHold -> Int

type AWSResponse PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

type AWSResponse PutObjectLegalHold = PutObjectLegalHoldResponse

type Rep PutObjectLegalHold

Defined in Amazonka.S3.PutObjectLegalHold

type Rep PutObjectLegalHold = D1 ('MetaData "PutObjectLegalHold" "Amazonka.S3.PutObjectLegalHold" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "PutObjectLegalHold'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "checksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChecksumAlgorithm)) :*: S1 ('MetaSel ('Just "contentMD5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "legalHold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectLockLegalHold)))) :*: ((S1 ('MetaSel ('Just "requestPayer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestPayer)) :*: S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectVersionId))) :*: (S1 ('MetaSel ('Just "bucket") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BucketName) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectKey)))))

newPutObjectLegalHold

Arguments

:: BucketName

PutObjectLegalHold

-> ObjectKey

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:

PutObjectLegalHold, putObjectLegalHold_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: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 fails with the HTTP status code 403 Forbidden (access denied).

$sel:legalHold:PutObjectLegalHold', putObjectLegalHold_legalHold - Container element for the legal hold configuration you want to apply to the specified object.

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

PutObjectLegalHold, putObjectLegalHold_versionId - The version ID of the object that you want to place a legal hold on.

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.

PutObjectLegalHold, putObjectLegalHold_key - The key name for the object that you want to place a legal hold on.

Request Lenses

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

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

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

putObjectLegalHold_legalHold :: Lens' PutObjectLegalHold (Maybe ObjectLockLegalHold)

Container element for the legal hold configuration you want to apply to the specified object.

putObjectLegalHold_requestPayer :: Lens' PutObjectLegalHold (Maybe RequestPayer)

Undocumented member.

putObjectLegalHold_versionId :: Lens' PutObjectLegalHold (Maybe ObjectVersionId)

The version ID of the object that you want to place a legal hold on.

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

putObjectLegalHold_key :: Lens' PutObjectLegalHold ObjectKey

The key name for the object that you want to place a legal hold on.

Destructuring the Response

data PutObjectLegalHoldResponse

See: newPutObjectLegalHoldResponse smart constructor.

Constructors

PutObjectLegalHoldResponse'

Fields

• requestCharged :: Maybe RequestCharged
• httpStatus :: Int

  The response's http status code.

Instances

Generic PutObjectLegalHoldResponse

Defined in Amazonka.S3.PutObjectLegalHold

Associated Types

type Rep PutObjectLegalHoldResponse :: Type -> Type

Methods

from :: PutObjectLegalHoldResponse -> Rep PutObjectLegalHoldResponse x

to :: Rep PutObjectLegalHoldResponse x -> PutObjectLegalHoldResponse

Read PutObjectLegalHoldResponse

Defined in Amazonka.S3.PutObjectLegalHold

Methods

readsPrec :: Int -> ReadS PutObjectLegalHoldResponse

readList :: ReadS [PutObjectLegalHoldResponse]

readPrec :: ReadPrec PutObjectLegalHoldResponse

readListPrec :: ReadPrec [PutObjectLegalHoldResponse]

Show PutObjectLegalHoldResponse

Defined in Amazonka.S3.PutObjectLegalHold

Methods

showsPrec :: Int -> PutObjectLegalHoldResponse -> ShowS

show :: PutObjectLegalHoldResponse -> String

showList :: [PutObjectLegalHoldResponse] -> ShowS

NFData PutObjectLegalHoldResponse

Defined in Amazonka.S3.PutObjectLegalHold

Methods

rnf :: PutObjectLegalHoldResponse -> ()

Eq PutObjectLegalHoldResponse

Defined in Amazonka.S3.PutObjectLegalHold

Methods

(==) :: PutObjectLegalHoldResponse -> PutObjectLegalHoldResponse -> Bool

(/=) :: PutObjectLegalHoldResponse -> PutObjectLegalHoldResponse -> Bool

type Rep PutObjectLegalHoldResponse

Defined in Amazonka.S3.PutObjectLegalHold

type Rep PutObjectLegalHoldResponse = D1 ('MetaData "PutObjectLegalHoldResponse" "Amazonka.S3.PutObjectLegalHold" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" '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

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)

Undocumented member.

putObjectLegalHoldResponse_httpStatus :: Lens' PutObjectLegalHoldResponse Int

The response's http status code.