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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets an object's current Legal Hold status. For more information, see Locking Objects.

This action is not supported by Amazon S3 on Outposts.

Synopsis

data GetObjectLegalHold = GetObjectLegalHold' {
- versionId :: Maybe ObjectVersionId
- requestPayer :: Maybe RequestPayer
- expectedBucketOwner :: Maybe Text
- bucket :: BucketName
- key :: ObjectKey
}
newGetObjectLegalHold :: BucketName -> ObjectKey -> GetObjectLegalHold
getObjectLegalHold_versionId :: Lens' GetObjectLegalHold (Maybe ObjectVersionId)
getObjectLegalHold_requestPayer :: Lens' GetObjectLegalHold (Maybe RequestPayer)
getObjectLegalHold_expectedBucketOwner :: Lens' GetObjectLegalHold (Maybe Text)
getObjectLegalHold_bucket :: Lens' GetObjectLegalHold BucketName
getObjectLegalHold_key :: Lens' GetObjectLegalHold ObjectKey
data GetObjectLegalHoldResponse = GetObjectLegalHoldResponse' {
- legalHold :: Maybe ObjectLockLegalHold
- httpStatus :: Int
}
newGetObjectLegalHoldResponse :: Int -> GetObjectLegalHoldResponse
getObjectLegalHoldResponse_legalHold :: Lens' GetObjectLegalHoldResponse (Maybe ObjectLockLegalHold)
getObjectLegalHoldResponse_httpStatus :: Lens' GetObjectLegalHoldResponse Int

Creating a Request

data GetObjectLegalHold Source #

See: newGetObjectLegalHold smart constructor.

Constructors

GetObjectLegalHold'

Fields

versionId :: Maybe ObjectVersionId
The version ID of the object whose Legal Hold status you want to retrieve.
requestPayer :: Maybe RequestPayer
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 whose Legal Hold status you want to retrieve.
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 whose Legal Hold status you want to retrieve.

Instances

Instances details

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

newGetObjectLegalHold Source #

Arguments

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

Create a value of GetObjectLegalHold 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:versionId:GetObjectLegalHold', getObjectLegalHold_versionId - The version ID of the object whose Legal Hold status you want to retrieve.

$sel:requestPayer:GetObjectLegalHold', getObjectLegalHold_requestPayer - Undocumented member.

$sel:expectedBucketOwner:GetObjectLegalHold', getObjectLegalHold_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:GetObjectLegalHold', getObjectLegalHold_bucket - The bucket name containing the object whose Legal Hold status you want to retrieve.

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:GetObjectLegalHold', getObjectLegalHold_key - The key name for the object whose Legal Hold status you want to retrieve.

Request Lenses

getObjectLegalHold_versionId :: Lens' GetObjectLegalHold (Maybe ObjectVersionId) Source #

The version ID of the object whose Legal Hold status you want to retrieve.

getObjectLegalHold_requestPayer :: Lens' GetObjectLegalHold (Maybe RequestPayer) Source #

Undocumented member.

getObjectLegalHold_expectedBucketOwner :: Lens' GetObjectLegalHold (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.

getObjectLegalHold_bucket :: Lens' GetObjectLegalHold BucketName Source #

The bucket name containing the object whose Legal Hold status you want to retrieve.

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.

getObjectLegalHold_key :: Lens' GetObjectLegalHold ObjectKey Source #

The key name for the object whose Legal Hold status you want to retrieve.

Destructuring the Response

data GetObjectLegalHoldResponse Source #

See: newGetObjectLegalHoldResponse smart constructor.

Constructors

GetObjectLegalHoldResponse'
Fields legalHold :: Maybe ObjectLockLegalHold The current Legal Hold status for the specified object. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newGetObjectLegalHoldResponse Source #

Arguments

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

Create a value of GetObjectLegalHoldResponse 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:GetObjectLegalHoldResponse', getObjectLegalHoldResponse_legalHold - The current Legal Hold status for the specified object.

$sel:httpStatus:GetObjectLegalHoldResponse', getObjectLegalHoldResponse_httpStatus - The response's http status code.

Response Lenses

getObjectLegalHoldResponse_legalHold :: Lens' GetObjectLegalHoldResponse (Maybe ObjectLockLegalHold) Source #

The current Legal Hold status for the specified object.

getObjectLegalHoldResponse_httpStatus :: Lens' GetObjectLegalHoldResponse Int Source #

The response's http status code.