Skip to content

/AWS1/IF_S3=>GETOBJECT()

About GetObject

Retrieves an object from Amazon S3.

In the GetObject request, specify the full key name for the object.

General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the object key name as /photos/2006/February/sample.jpg. For a path-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket, specify the object key name as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification in the Amazon S3 User Guide.

Directory buckets - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named amzn-s3-demo-bucket--usw2-az1--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket-name.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 - You must have the required permissions in a policy. To use GetObject, you must have the READ access to the object (or version). If you grant READ access to the anonymous user, the GetObject operation returns the object without using an authorization header. For more information, see Specifying permissions in a policy in the Amazon S3 User Guide.

    If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

    If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

    If the object that you request doesn’t exist, the error that 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 error.

    • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 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 using 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.

Storage classes

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones. Unsupported storage class values won't write a destination object and will respond with the HTTP status code 400 Bad Request.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for the GetObject requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject requests for the object that uses these types of keys, you’ll get an HTTP 400 Bad Request error.

Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn't supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

Overriding response header values through the request

There are times when you want to override certain response header values of a GetObject response. For example, you might override the Content-Disposition response header value through your GetObject request.

You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code 200 OK is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object.

The response headers that you can override for the GetObject response are Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, and Expires.

To override values for a set of response headers in the GetObject response, you can use the following query parameters in the request.

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

  • response-content-language

  • response-content-type

  • response-expires

When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.
HTTP Host header syntax

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

The following operations are related to GetObject:

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~GETOBJECT
  IMPORTING
    !IV_BUCKET TYPE /AWS1/S3_BUCKETNAME OPTIONAL
    !IV_IFMATCH TYPE /AWS1/S3_IFMATCH OPTIONAL
    !IV_IFMODIFIEDSINCE TYPE /AWS1/S3_IFMODIFIEDSINCE OPTIONAL
    !IV_IFNONEMATCH TYPE /AWS1/S3_IFNONEMATCH OPTIONAL
    !IV_IFUNMODIFIEDSINCE TYPE /AWS1/S3_IFUNMODIFIEDSINCE OPTIONAL
    !IV_KEY TYPE /AWS1/S3_OBJECTKEY OPTIONAL
    !IV_RANGE TYPE /AWS1/S3_RANGE OPTIONAL
    !IV_RESPONSECACHECONTROL TYPE /AWS1/S3_RESPONSECACHECONTROL OPTIONAL
    !IV_RSPCONTENTDISPOSITION TYPE /AWS1/S3_RSPCONTENTDISPOSITION OPTIONAL
    !IV_RESPONSECONTENTENCODING TYPE /AWS1/S3_RSPCONTENTENCODING OPTIONAL
    !IV_RESPONSECONTENTLANGUAGE TYPE /AWS1/S3_RSPCONTENTLANGUAGE OPTIONAL
    !IV_RESPONSECONTENTTYPE TYPE /AWS1/S3_RESPONSECONTENTTYPE OPTIONAL
    !IV_RESPONSEEXPIRES TYPE /AWS1/S3_RESPONSEEXPIRES OPTIONAL
    !IV_VERSIONID TYPE /AWS1/S3_OBJECTVERSIONID 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_PARTNUMBER TYPE /AWS1/S3_PARTNUMBER OPTIONAL
    !IV_EXPECTEDBUCKETOWNER TYPE /AWS1/S3_ACCOUNTID OPTIONAL
    !IV_CHECKSUMMODE TYPE /AWS1/S3_CHECKSUMMODE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_s3_getobjectoutput
  RAISING
    /AWS1/CX_S3_INVALIDOBJECTSTATE
    /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 bucket name containing 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 - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

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

Key of the object to get.

Optional arguments:

iv_ifmatch TYPE /AWS1/S3_IFMATCH /AWS1/S3_IFMATCH

Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

iv_ifmodifiedsince TYPE /AWS1/S3_IFMODIFIEDSINCE /AWS1/S3_IFMODIFIEDSINCE

Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error.

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

For more information about conditional requests, see RFC 7232.

iv_ifnonematch TYPE /AWS1/S3_IFNONEMATCH /AWS1/S3_IFNONEMATCH

Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error.

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

For more information about conditional requests, see RFC 7232.

iv_ifunmodifiedsince TYPE /AWS1/S3_IFUNMODIFIEDSINCE /AWS1/S3_IFUNMODIFIEDSINCE

Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows: If-Match condition evaluates to true, and; If-Unmodified-Since condition evaluates to false; then, S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

iv_range TYPE /AWS1/S3_RANGE /AWS1/S3_RANGE

Downloads the specified byte range of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

iv_responsecachecontrol TYPE /AWS1/S3_RESPONSECACHECONTROL /AWS1/S3_RESPONSECACHECONTROL

Sets the Cache-Control header of the response.

iv_rspcontentdisposition TYPE /AWS1/S3_RSPCONTENTDISPOSITION /AWS1/S3_RSPCONTENTDISPOSITION

Sets the Content-Disposition header of the response.

iv_responsecontentencoding TYPE /AWS1/S3_RSPCONTENTENCODING /AWS1/S3_RSPCONTENTENCODING

Sets the Content-Encoding header of the response.

iv_responsecontentlanguage TYPE /AWS1/S3_RSPCONTENTLANGUAGE /AWS1/S3_RSPCONTENTLANGUAGE

Sets the Content-Language header of the response.

iv_responsecontenttype TYPE /AWS1/S3_RESPONSECONTENTTYPE /AWS1/S3_RESPONSECONTENTTYPE

Sets the Content-Type header of the response.

iv_responseexpires TYPE /AWS1/S3_RESPONSEEXPIRES /AWS1/S3_RESPONSEEXPIRES

Sets the Expires header of the response.

iv_versionid TYPE /AWS1/S3_OBJECTVERSIONID /AWS1/S3_OBJECTVERSIONID

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

By default, the GetObject operation returns the current version of an object. To return a different version, use the versionId subresource.

  • If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

  • If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

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

For more information about versioning, see PutBucketVersioning.

iv_ssecustomeralgorithm TYPE /AWS1/S3_SSECUSTOMERALGORITHM /AWS1/S3_SSECUSTOMERALGORITHM

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

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

This functionality is not supported for directory buckets.

iv_ssecustomerkey TYPE /AWS1/S3_SSECUSTOMERKEY /AWS1/S3_SSECUSTOMERKEY

Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

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

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 customer-provided 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.

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

This functionality is not supported for directory buckets.

iv_requestpayer TYPE /AWS1/S3_REQUESTPAYER /AWS1/S3_REQUESTPAYER

RequestPayer

iv_partnumber TYPE /AWS1/S3_PARTNUMBER /AWS1/S3_PARTNUMBER

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

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

iv_checksummode TYPE /AWS1/S3_CHECKSUMMODE /AWS1/S3_CHECKSUMMODE

To retrieve the checksum, this mode must be enabled.

RETURNING

oo_output TYPE REF TO /aws1/cl_s3_getobjectoutput /AWS1/CL_S3_GETOBJECTOUTPUT

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->getobject(
  iv_bucket = |string|
  iv_checksummode = |string|
  iv_expectedbucketowner = |string|
  iv_ifmatch = |string|
  iv_ifmodifiedsince = '20150101000000.0000000'
  iv_ifnonematch = |string|
  iv_ifunmodifiedsince = '20150101000000.0000000'
  iv_key = |string|
  iv_partnumber = 123
  iv_range = |string|
  iv_requestpayer = |string|
  iv_responsecachecontrol = |string|
  iv_responsecontentencoding = |string|
  iv_responsecontentlanguage = |string|
  iv_responsecontenttype = |string|
  iv_responseexpires = '20150101000000.0000000'
  iv_rspcontentdisposition = |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_streamingblob = lo_result->get_body( ).
  lv_deletemarker = lo_result->get_deletemarker( ).
  lv_acceptranges = lo_result->get_acceptranges( ).
  lv_expiration = lo_result->get_expiration( ).
  lv_restore = lo_result->get_restore( ).
  lv_lastmodified = lo_result->get_lastmodified( ).
  lv_contentlength = lo_result->get_contentlength( ).
  lv_etag = lo_result->get_etag( ).
  lv_checksumcrc32 = lo_result->get_checksumcrc32( ).
  lv_checksumcrc32c = lo_result->get_checksumcrc32c( ).
  lv_checksumcrc64nvme = lo_result->get_checksumcrc64nvme( ).
  lv_checksumsha1 = lo_result->get_checksumsha1( ).
  lv_checksumsha256 = lo_result->get_checksumsha256( ).
  lv_checksumtype = lo_result->get_checksumtype( ).
  lv_missingmeta = lo_result->get_missingmeta( ).
  lv_objectversionid = lo_result->get_versionid( ).
  lv_cachecontrol = lo_result->get_cachecontrol( ).
  lv_contentdisposition = lo_result->get_contentdisposition( ).
  lv_contentencoding = lo_result->get_contentencoding( ).
  lv_contentlanguage = lo_result->get_contentlanguage( ).
  lv_contentrange = lo_result->get_contentrange( ).
  lv_contenttype = lo_result->get_contenttype( ).
  lv_expires = lo_result->get_expires( ).
  lv_websiteredirectlocation = lo_result->get_websiteredirectlocation( ).
  lv_serversideencryption = lo_result->get_serversideencryption( ).
  LOOP AT lo_result->get_metadata( ) into ls_row.
    lv_key = ls_row-key.
    lo_value = ls_row-value.
    IF lo_value IS NOT INITIAL.
      lv_metadatavalue = lo_value->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_ssecustomeralgorithm = lo_result->get_ssecustomeralgorithm( ).
  lv_ssecustomerkeymd5 = lo_result->get_ssecustomerkeymd5( ).
  lv_ssekmskeyid = lo_result->get_ssekmskeyid( ).
  lv_bucketkeyenabled = lo_result->get_bucketkeyenabled( ).
  lv_storageclass = lo_result->get_storageclass( ).
  lv_requestcharged = lo_result->get_requestcharged( ).
  lv_replicationstatus = lo_result->get_replicationstatus( ).
  lv_partscount = lo_result->get_partscount( ).
  lv_tagcount = lo_result->get_tagcount( ).
  lv_objectlockmode = lo_result->get_objectlockmode( ).
  lv_objectlockretainuntilda = lo_result->get_objlockretainuntildate( ).
  lv_objectlocklegalholdstat = lo_result->get_objlocklegalholdstatus( ).
ENDIF.

To retrieve a byte range of an object

The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.

DATA(lo_result) = lo_client->getobject(
  iv_bucket = |examplebucket|
  iv_key = |SampleFile.txt|
  iv_range = |bytes=0-9|
).

To retrieve an object

The following example retrieves an object for an S3 bucket.

DATA(lo_result) = lo_client->getobject(
  iv_bucket = |examplebucket|
  iv_key = |HappyFace.jpg|
).