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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves all the metadata from an object without returning the object itself. This action is useful if you're interested only in an object's metadata. To use GetObjectAttributes, you must have READ access to the object.

GetObjectAttributes combines the functionality of GetObjectAcl, GetObjectLegalHold, GetObjectLockConfiguration, GetObjectRetention, GetObjectTagging, HeadObject, and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes.

If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:

x-amz-server-side-encryption-customer-algorithm

x-amz-server-side-encryption-customer-key

x-amz-server-side-encryption-customer-key-MD5

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

Encryption request headers, such as x-amz-server-side-encryption, should not be sent for GET requests if your object uses server-side encryption with Amazon Web Services KMS keys stored in Amazon Web Services Key Management Service (SSE-KMS) or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). If your object does use these types of keys, you'll get an HTTP 400 Bad Request error.
The last modified property in this case is the creation date of the object.

Consider the following when using request headers:

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:
- If-Match condition evaluates to true.
- If-Unmodified-Since condition evaluates to false.
If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:
- If-None-Match condition evaluates to false.
- If-Modified-Since condition evaluates to true.

For more information about conditional requests, see RFC 7232.

Permissions

The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.

If you have the s3:ListBucket permission on the bucket, Amazon S3 returns an HTTP status code 404 Not Found ("no such key") error.
If you don't have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error.

The following actions are related to GetObjectAttributes:

Synopsis

Creating a Request

data GetObjectAttributes Source #

See: newGetObjectAttributes smart constructor.

Constructors

GetObjectAttributes'

Fields

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).
maxParts :: Maybe Int
Sets the maximum number of parts to return.
partNumberMarker :: Maybe Int
Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
requestPayer :: Maybe RequestPayer
sSECustomerAlgorithm :: Maybe Text
Specifies the algorithm to use when encrypting the object (for example, AES256).
sSECustomerKey :: Maybe (Sensitive Text)
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
sSECustomerKeyMD5 :: Maybe Text
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
versionId :: Maybe ObjectVersionId
The version ID used to reference a specific version of the object.
bucket :: BucketName
The name of the bucket that contains the object.
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.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
key :: ObjectKey
The object key.
objectAttributes :: [ObjectAttributes]
An XML header that specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Instances

Instances details

ToHeaders GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods toHeaders :: GetObjectAttributes -> [Header] #
ToPath GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods toPath :: GetObjectAttributes -> ByteString #
ToQuery GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods toQuery :: GetObjectAttributes -> QueryString #
AWSRequest GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Associated Types type AWSResponse GetObjectAttributes # Methods request :: (Service -> Service) -> GetObjectAttributes -> Request GetObjectAttributes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetObjectAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetObjectAttributes))) #
Generic GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Associated Types type Rep GetObjectAttributes :: Type -> Type # Methods from :: GetObjectAttributes -> Rep GetObjectAttributes x # to :: Rep GetObjectAttributes x -> GetObjectAttributes #
Show GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods showsPrec :: Int -> GetObjectAttributes -> ShowS # show :: GetObjectAttributes -> String # showList :: [GetObjectAttributes] -> ShowS #
NFData GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods rnf :: GetObjectAttributes -> () #
Eq GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods (==) :: GetObjectAttributes -> GetObjectAttributes -> Bool # (/=) :: GetObjectAttributes -> GetObjectAttributes -> Bool #
Hashable GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods hashWithSalt :: Int -> GetObjectAttributes -> Int # hash :: GetObjectAttributes -> Int #
type AWSResponse GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes type AWSResponse GetObjectAttributes = GetObjectAttributesResponse
type Rep GetObjectAttributes Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes type Rep GetObjectAttributes = D1 ('MetaData "GetObjectAttributes" "Amazonka.S3.GetObjectAttributes" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetObjectAttributes'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "expectedBucketOwner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxParts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "partNumberMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "requestPayer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestPayer)) :: S1 ('MetaSel ('Just "sSECustomerAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "sSECustomerKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: (S1 ('MetaSel ('Just "sSECustomerKeyMD5") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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) :: S1 ('MetaSel ('Just "objectAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [ObjectAttributes]))))))

newGetObjectAttributes Source #

Arguments

:: BucketName	`GetObjectAttributes`
-> ObjectKey	`GetObjectAttributes`
-> GetObjectAttributes

Create a value of GetObjectAttributes 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:expectedBucketOwner:GetObjectAttributes', getObjectAttributes_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).

GetObjectAttributes, getObjectAttributes_maxParts - Sets the maximum number of parts to return.

GetObjectAttributes, getObjectAttributes_partNumberMarker - Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

$sel:requestPayer:GetObjectAttributes', getObjectAttributes_requestPayer - Undocumented member.

$sel:sSECustomerAlgorithm:GetObjectAttributes', getObjectAttributes_sSECustomerAlgorithm - Specifies the algorithm to use when encrypting the object (for example, AES256).

$sel:sSECustomerKey:GetObjectAttributes', getObjectAttributes_sSECustomerKey - Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

$sel:sSECustomerKeyMD5:GetObjectAttributes', getObjectAttributes_sSECustomerKeyMD5 - Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

GetObjectAttributes, getObjectAttributes_versionId - The version ID used to reference a specific version of the object.

GetObjectAttributes, getObjectAttributes_bucket - The name of the bucket that contains the object.

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.

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

GetObjectAttributes, getObjectAttributes_key - The object key.

$sel:objectAttributes:GetObjectAttributes', getObjectAttributes_objectAttributes - An XML header that specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Request Lenses

getObjectAttributes_expectedBucketOwner :: Lens' GetObjectAttributes (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).

getObjectAttributes_maxParts :: Lens' GetObjectAttributes (Maybe Int) Source #

Sets the maximum number of parts to return.

getObjectAttributes_partNumberMarker :: Lens' GetObjectAttributes (Maybe Int) Source #

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

getObjectAttributes_requestPayer :: Lens' GetObjectAttributes (Maybe RequestPayer) Source #

Undocumented member.

getObjectAttributes_sSECustomerAlgorithm :: Lens' GetObjectAttributes (Maybe Text) Source #

Specifies the algorithm to use when encrypting the object (for example, AES256).

getObjectAttributes_sSECustomerKey :: Lens' GetObjectAttributes (Maybe Text) Source #

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

getObjectAttributes_sSECustomerKeyMD5 :: Lens' GetObjectAttributes (Maybe Text) Source #

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

getObjectAttributes_versionId :: Lens' GetObjectAttributes (Maybe ObjectVersionId) Source #

The version ID used to reference a specific version of the object.

getObjectAttributes_bucket :: Lens' GetObjectAttributes BucketName Source #

The name of the bucket that contains the object.

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.

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

getObjectAttributes_key :: Lens' GetObjectAttributes ObjectKey Source #

The object key.

getObjectAttributes_objectAttributes :: Lens' GetObjectAttributes [ObjectAttributes] Source #

An XML header that specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Destructuring the Response

data GetObjectAttributesResponse Source #

See: newGetObjectAttributesResponse smart constructor.

Constructors

GetObjectAttributesResponse'

Fields

checksum :: Maybe Checksum
The checksum or digest of the object.
deleteMarker :: Maybe Bool
Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.
eTag :: Maybe ETag
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
lastModified :: Maybe RFC822
The creation date of the object.
objectParts :: Maybe GetObjectAttributesParts
A collection of parts associated with a multipart upload.
objectSize :: Maybe Integer
The size of the object in bytes.
requestCharged :: Maybe RequestCharged
storageClass :: Maybe StorageClass
Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
versionId :: Maybe ObjectVersionId
The version ID of the object.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetObjectAttributesResponse Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Associated Types type Rep GetObjectAttributesResponse :: Type -> Type # Methods from :: GetObjectAttributesResponse -> Rep GetObjectAttributesResponse x # to :: Rep GetObjectAttributesResponse x -> GetObjectAttributesResponse #
Read GetObjectAttributesResponse Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods readsPrec :: Int -> ReadS GetObjectAttributesResponse # readList :: ReadS [GetObjectAttributesResponse] # readPrec :: ReadPrec GetObjectAttributesResponse # readListPrec :: ReadPrec [GetObjectAttributesResponse] #
Show GetObjectAttributesResponse Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods showsPrec :: Int -> GetObjectAttributesResponse -> ShowS # show :: GetObjectAttributesResponse -> String # showList :: [GetObjectAttributesResponse] -> ShowS #
NFData GetObjectAttributesResponse Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods rnf :: GetObjectAttributesResponse -> () #
Eq GetObjectAttributesResponse Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes Methods (==) :: GetObjectAttributesResponse -> GetObjectAttributesResponse -> Bool # (/=) :: GetObjectAttributesResponse -> GetObjectAttributesResponse -> Bool #
type Rep GetObjectAttributesResponse Source #
Instance details Defined in Amazonka.S3.GetObjectAttributes type Rep GetObjectAttributesResponse = D1 ('MetaData "GetObjectAttributesResponse" "Amazonka.S3.GetObjectAttributes" "amazonka-s3-2.0-CNZtv1UmVzj28JXsFvwNoj" 'False) (C1 ('MetaCons "GetObjectAttributesResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "checksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Checksum)) :: S1 ('MetaSel ('Just "deleteMarker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "eTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ETag)) :: (S1 ('MetaSel ('Just "lastModified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RFC822)) :: S1 ('MetaSel ('Just "objectParts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GetObjectAttributesParts))))) :: ((S1 ('MetaSel ('Just "objectSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: S1 ('MetaSel ('Just "requestCharged") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RequestCharged))) :: (S1 ('MetaSel ('Just "storageClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageClass)) :: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectVersionId)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newGetObjectAttributesResponse Source #

Arguments

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

Create a value of GetObjectAttributesResponse 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:checksum:GetObjectAttributesResponse', getObjectAttributesResponse_checksum - The checksum or digest of the object.

GetObjectAttributesResponse, getObjectAttributesResponse_deleteMarker - Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.

GetObjectAttributesResponse, getObjectAttributesResponse_eTag - An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

GetObjectAttributesResponse, getObjectAttributesResponse_lastModified - The creation date of the object.

$sel:objectParts:GetObjectAttributesResponse', getObjectAttributesResponse_objectParts - A collection of parts associated with a multipart upload.

$sel:objectSize:GetObjectAttributesResponse', getObjectAttributesResponse_objectSize - The size of the object in bytes.

$sel:requestCharged:GetObjectAttributesResponse', getObjectAttributesResponse_requestCharged - Undocumented member.

GetObjectAttributesResponse, getObjectAttributesResponse_storageClass - Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

GetObjectAttributes, getObjectAttributesResponse_versionId - The version ID of the object.

$sel:httpStatus:GetObjectAttributesResponse', getObjectAttributesResponse_httpStatus - The response's http status code.

Response Lenses

getObjectAttributesResponse_checksum :: Lens' GetObjectAttributesResponse (Maybe Checksum) Source #

The checksum or digest of the object.

getObjectAttributesResponse_deleteMarker :: Lens' GetObjectAttributesResponse (Maybe Bool) Source #

Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.

getObjectAttributesResponse_eTag :: Lens' GetObjectAttributesResponse (Maybe ETag) Source #

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

getObjectAttributesResponse_lastModified :: Lens' GetObjectAttributesResponse (Maybe UTCTime) Source #

The creation date of the object.

getObjectAttributesResponse_objectParts :: Lens' GetObjectAttributesResponse (Maybe GetObjectAttributesParts) Source #

A collection of parts associated with a multipart upload.

getObjectAttributesResponse_objectSize :: Lens' GetObjectAttributesResponse (Maybe Integer) Source #

The size of the object in bytes.

getObjectAttributesResponse_requestCharged :: Lens' GetObjectAttributesResponse (Maybe RequestCharged) Source #

Undocumented member.

getObjectAttributesResponse_storageClass :: Lens' GetObjectAttributesResponse (Maybe StorageClass) Source #

Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

getObjectAttributesResponse_versionId :: Lens' GetObjectAttributesResponse (Maybe ObjectVersionId) Source #

The version ID of the object.

getObjectAttributesResponse_httpStatus :: Lens' GetObjectAttributesResponse Int Source #

The response's http status code.