/AWS1/IF_S3=>GETOBJECTATTRIBUTES()

About GetObjectAttributes

Retrieves all of the metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.

GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with both of those individual calls can be returned with a single call to GetObjectAttributes.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://amzn-s3-demo-bucket.s3express-zone-id.region-code.amazonaws.com/key-name . Path-style requests are not supported. For more information about endpoints in Availability Zones, see Regional and Zonal endpoints for directory buckets in Availability Zones in the Amazon S3 User Guide. For more information about endpoints in Local Zones, see Concepts for directory buckets in Local Zones in the Amazon S3 User Guide.

Permissions

• General purpose bucket permissions - To use GetObjectAttributes, you must have READ access to the object.

  The other permissions that you need to use this operation depend on whether the bucket is versioned and if a version ID is passed in the GetObjectAttributes request.

  • If you pass a version ID in your request, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions.

  • If you do not pass a version ID in your request, 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.

• Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

  If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a GET request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It's because the encryption method can't be changed when you retrieve the object.

If you encrypted an object when you stored the object in Amazon S3 by using server-side encryption with customer-provided encryption keys (SSE-C), then when you retrieve the metadata from the object, you must use the following headers. These headers provide the server with the encryption key required to retrieve the object's metadata. The headers are:

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

Directory bucket permissions - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses the desired encryption configuration and you don't override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

Versioning

Directory buckets - S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

Conditional request headers

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.

  For more information about conditional requests, see RFC 7232.

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

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket-name.s3express-zone-id.region-code.amazonaws.com.

The following actions are related to GetObjectAttributes:

• GetObject

• GetObjectAcl

• GetObjectLegalHold

• GetObjectLockConfiguration

• GetObjectRetention

• GetObjectTagging

• HeadObject

• ListParts

You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.

Method Signature

METHODS /AWS1/IF_S3~GETOBJECTATTRIBUTES
  IMPORTING
    !IV_BUCKET TYPE /AWS1/S3_BUCKETNAME OPTIONAL
    !IV_KEY TYPE /AWS1/S3_OBJECTKEY OPTIONAL
    !IV_VERSIONID TYPE /AWS1/S3_OBJECTVERSIONID OPTIONAL
    !IV_MAXPARTS TYPE /AWS1/S3_MAXPARTS OPTIONAL
    !IV_PARTNUMBERMARKER TYPE /AWS1/S3_PARTNUMBERMARKER OPTIONAL
    !IV_SSECUSTOMERALGORITHM TYPE /AWS1/S3_SSECUSTOMERALGORITHM OPTIONAL
    !IV_SSECUSTOMERKEY TYPE /AWS1/S3_SSECUSTOMERKEY OPTIONAL
    !IV_SSECUSTOMERKEYMD5 TYPE /AWS1/S3_SSECUSTOMERKEYMD5 OPTIONAL
    !IV_REQUESTPAYER TYPE /AWS1/S3_REQUESTPAYER OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
    !IT_OBJECTATTRIBUTES TYPE /AWS1/CL_S3_OBJECTATTRSLIST_W=>TT_OBJECTATTRIBUTESLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3_getobjattrsoutput
  RAISING
    /AWS1/CX_S3_NOSUCHKEY
    /AWS1/CX_S3_CLIENTEXC
    /AWS1/CX_S3_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_bucket TYPE /AWS1/S3_BUCKETNAME /AWS1/S3_BUCKETNAME

The name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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 you use this action with S3 on Outposts, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

iv_key TYPE /AWS1/S3_OBJECTKEY /AWS1/S3_OBJECTKEY

The object key.

it_objectattributes TYPE /AWS1/CL_S3_OBJECTATTRSLIST_W=>TT_OBJECTATTRIBUTESLIST TT_OBJECTATTRIBUTESLIST

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

Optional arguments:

iv_versionid TYPE /AWS1/S3_OBJECTVERSIONID /AWS1/S3_OBJECTVERSIONID

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

S3 Versioning isn't enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

iv_maxparts TYPE /AWS1/S3_MAXPARTS /AWS1/S3_MAXPARTS

Sets the maximum number of parts to return. For more information, see Uploading and copying objects using multipart upload in Amazon S3 in the Amazon Simple Storage Service user guide.

iv_partnumbermarker TYPE /AWS1/S3_PARTNUMBERMARKER /AWS1/S3_PARTNUMBERMARKER

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed. For more information, see Uploading and copying objects using multipart upload in Amazon S3 in the Amazon Simple Storage Service user guide.

iv_ssecustomeralgorithm TYPE /AWS1/S3_SSECUSTOMERALGORITHM /AWS1/S3_SSECUSTOMERALGORITHM

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

This functionality is not supported for directory buckets.

iv_ssecustomerkey TYPE /AWS1/S3_SSECUSTOMERKEY /AWS1/S3_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.

This functionality is not supported for directory buckets.

iv_ssecustomerkeymd5 TYPE /AWS1/S3_SSECUSTOMERKEYMD5 /AWS1/S3_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.

This functionality is not supported for directory buckets.

iv_requestpayer TYPE /AWS1/S3_REQUESTPAYER /AWS1/S3_REQUESTPAYER

RequestPayer

iv_expectedbucketowner TYPE /AWS1/S3_ACCOUNTID /AWS1/S3_ACCOUNTID

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

RETURNING

oo_output TYPE REF TO /aws1/cl_s3_getobjattrsoutput /AWS1/CL_S3_GETOBJATTRSOUTPUT

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->getobjectattributes(
  it_objectattributes = VALUE /aws1/cl_s3_objectattrslist_w=>tt_objectattributeslist(
    ( new /aws1/cl_s3_objectattrslist_w( |string| ) )
  )
  iv_bucket = |string|
  iv_expectedbucketowner = |string|
  iv_key = |string|
  iv_maxparts = 123
  iv_partnumbermarker = |string|
  iv_requestpayer = |string|
  iv_ssecustomeralgorithm = |string|
  iv_ssecustomerkey = |string|
  iv_ssecustomerkeymd5 = |string|
  iv_versionid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_deletemarker = lo_result->get_deletemarker( ).
  lv_lastmodified = lo_result->get_lastmodified( ).
  lv_objectversionid = lo_result->get_versionid( ).
  lv_requestcharged = lo_result->get_requestcharged( ).
  lv_etag = lo_result->get_etag( ).
  lo_checksum = lo_result->get_checksum( ).
  IF lo_checksum IS NOT INITIAL.
    lv_checksumcrc32 = lo_checksum->get_checksumcrc32( ).
    lv_checksumcrc32c = lo_checksum->get_checksumcrc32c( ).
    lv_checksumcrc64nvme = lo_checksum->get_checksumcrc64nvme( ).
    lv_checksumsha1 = lo_checksum->get_checksumsha1( ).
    lv_checksumsha256 = lo_checksum->get_checksumsha256( ).
    lv_checksumtype = lo_checksum->get_checksumtype( ).
  ENDIF.
  lo_getobjectattributespart = lo_result->get_objectparts( ).
  IF lo_getobjectattributespart IS NOT INITIAL.
    lv_partscount = lo_getobjectattributespart->get_totalpartscount( ).
    lv_partnumbermarker = lo_getobjectattributespart->get_partnumbermarker( ).
    lv_nextpartnumbermarker = lo_getobjectattributespart->get_nextpartnumbermarker( ).
    lv_maxparts = lo_getobjectattributespart->get_maxparts( ).
    lv_istruncated = lo_getobjectattributespart->get_istruncated( ).
    LOOP AT lo_getobjectattributespart->get_parts( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_partnumber = lo_row_1->get_partnumber( ).
        lv_size = lo_row_1->get_size( ).
        lv_checksumcrc32 = lo_row_1->get_checksumcrc32( ).
        lv_checksumcrc32c = lo_row_1->get_checksumcrc32c( ).
        lv_checksumcrc64nvme = lo_row_1->get_checksumcrc64nvme( ).
        lv_checksumsha1 = lo_row_1->get_checksumsha1( ).
        lv_checksumsha256 = lo_row_1->get_checksumsha256( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
  lv_storageclass = lo_result->get_storageclass( ).
  lv_objectsize = lo_result->get_objectsize( ).
ENDIF.