Skip to content

/AWS1/IF_S3=>WRITEGETOBJECTRESPONSE()

About WriteGetObjectResponse

This operation is not supported for directory buckets.

Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide.

This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return.

You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata.

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

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~WRITEGETOBJECTRESPONSE
  IMPORTING
    !IV_REQUESTROUTE TYPE /AWS1/S3_REQUESTROUTE OPTIONAL
    !IV_REQUESTTOKEN TYPE /AWS1/S3_REQUESTTOKEN OPTIONAL
    !IV_BODY TYPE /AWS1/S3_STREAMINGBLOB OPTIONAL
    !IV_STATUSCODE TYPE /AWS1/S3_GETOBJRSPSTATUSCODE OPTIONAL
    !IV_ERRORCODE TYPE /AWS1/S3_ERRORCODE OPTIONAL
    !IV_ERRORMESSAGE TYPE /AWS1/S3_ERRORMESSAGE OPTIONAL
    !IV_ACCEPTRANGES TYPE /AWS1/S3_ACCEPTRANGES OPTIONAL
    !IV_CACHECONTROL TYPE /AWS1/S3_CACHECONTROL OPTIONAL
    !IV_CONTENTDISPOSITION TYPE /AWS1/S3_CONTENTDISPOSITION OPTIONAL
    !IV_CONTENTENCODING TYPE /AWS1/S3_CONTENTENCODING OPTIONAL
    !IV_CONTENTLANGUAGE TYPE /AWS1/S3_CONTENTLANGUAGE OPTIONAL
    !IV_CONTENTLENGTH TYPE /AWS1/S3_CONTENTLENGTH OPTIONAL
    !IV_CONTENTRANGE TYPE /AWS1/S3_CONTENTRANGE OPTIONAL
    !IV_CONTENTTYPE TYPE /AWS1/S3_CONTENTTYPE OPTIONAL
    !IV_CHECKSUMCRC32 TYPE /AWS1/S3_CHECKSUMCRC32 OPTIONAL
    !IV_CHECKSUMCRC32C TYPE /AWS1/S3_CHECKSUMCRC32C OPTIONAL
    !IV_CHECKSUMCRC64NVME TYPE /AWS1/S3_CHECKSUMCRC64NVME OPTIONAL
    !IV_CHECKSUMSHA1 TYPE /AWS1/S3_CHECKSUMSHA1 OPTIONAL
    !IV_CHECKSUMSHA256 TYPE /AWS1/S3_CHECKSUMSHA256 OPTIONAL
    !IV_DELETEMARKER TYPE /AWS1/S3_DELETEMARKER OPTIONAL
    !IV_ETAG TYPE /AWS1/S3_ETAG OPTIONAL
    !IV_EXPIRES TYPE /AWS1/S3_EXPIRES OPTIONAL
    !IV_EXPIRATION TYPE /AWS1/S3_EXPIRATION OPTIONAL
    !IV_LASTMODIFIED TYPE /AWS1/S3_LASTMODIFIED OPTIONAL
    !IV_MISSINGMETA TYPE /AWS1/S3_MISSINGMETA OPTIONAL
    !IT_METADATA TYPE /AWS1/CL_S3_METADATA_W=>TT_METADATA OPTIONAL
    !IV_OBJECTLOCKMODE TYPE /AWS1/S3_OBJECTLOCKMODE OPTIONAL
    !IV_OBJECTLOCKLEGALHOLDSTATUS TYPE /AWS1/S3_OBJLOCKLEGALHOLDSTAT OPTIONAL
    !IV_OBJECTLOCKRETAINUNTILDATE TYPE /AWS1/S3_OBJLOCKRTNUNTILDATE OPTIONAL
    !IV_PARTSCOUNT TYPE /AWS1/S3_PARTSCOUNT OPTIONAL
    !IV_REPLICATIONSTATUS TYPE /AWS1/S3_REPLICATIONSTATUS OPTIONAL
    !IV_REQUESTCHARGED TYPE /AWS1/S3_REQUESTCHARGED OPTIONAL
    !IV_RESTORE TYPE /AWS1/S3_RESTORE OPTIONAL
    !IV_SERVERSIDEENCRYPTION TYPE /AWS1/S3_SERVERSIDEENCRYPTION OPTIONAL
    !IV_SSECUSTOMERALGORITHM TYPE /AWS1/S3_SSECUSTOMERALGORITHM OPTIONAL
    !IV_SSEKMSKEYID TYPE /AWS1/S3_SSEKMSKEYID OPTIONAL
    !IV_SSECUSTOMERKEYMD5 TYPE /AWS1/S3_SSECUSTOMERKEYMD5 OPTIONAL
    !IV_STORAGECLASS TYPE /AWS1/S3_STORAGECLASS OPTIONAL
    !IV_TAGCOUNT TYPE /AWS1/S3_TAGCOUNT OPTIONAL
    !IV_VERSIONID TYPE /AWS1/S3_OBJECTVERSIONID OPTIONAL
    !IV_BUCKETKEYENABLED TYPE /AWS1/S3_BUCKETKEYENABLED OPTIONAL
  RAISING
    /AWS1/CX_S3_CLIENTEXC
    /AWS1/CX_S3_SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_requestroute TYPE /AWS1/S3_REQUESTROUTE /AWS1/S3_REQUESTROUTE

Route prefix to the HTTP URL generated.

iv_requesttoken TYPE /AWS1/S3_REQUESTTOKEN /AWS1/S3_REQUESTTOKEN

A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

Optional arguments:

iv_body TYPE /AWS1/S3_STREAMINGBLOB /AWS1/S3_STREAMINGBLOB

The object data.

iv_statuscode TYPE /AWS1/S3_GETOBJRSPSTATUSCODE /AWS1/S3_GETOBJRSPSTATUSCODE

The integer status code for an HTTP response of a corresponding GetObject request. The following is a list of status codes.

  • 200 - OK

  • 206 - Partial Content

  • 304 - Not Modified

  • 400 - Bad Request

  • 401 - Unauthorized

  • 403 - Forbidden

  • 404 - Not Found

  • 405 - Method Not Allowed

  • 409 - Conflict

  • 411 - Length Required

  • 412 - Precondition Failed

  • 416 - Range Not Satisfiable

  • 500 - Internal Server Error

  • 503 - Service Unavailable

iv_errorcode TYPE /AWS1/S3_ERRORCODE /AWS1/S3_ERRORCODE

A string that uniquely identifies an error condition. Returned in the tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$".

iv_errormessage TYPE /AWS1/S3_ERRORMESSAGE /AWS1/S3_ERRORMESSAGE

Contains a generic description of the error condition. Returned in the tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.

iv_acceptranges TYPE /AWS1/S3_ACCEPTRANGES /AWS1/S3_ACCEPTRANGES

Indicates that a range of bytes was specified.

iv_cachecontrol TYPE /AWS1/S3_CACHECONTROL /AWS1/S3_CACHECONTROL

Specifies caching behavior along the request/reply chain.

iv_contentdisposition TYPE /AWS1/S3_CONTENTDISPOSITION /AWS1/S3_CONTENTDISPOSITION

Specifies presentational information for the object.

iv_contentencoding TYPE /AWS1/S3_CONTENTENCODING /AWS1/S3_CONTENTENCODING

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

iv_contentlanguage TYPE /AWS1/S3_CONTENTLANGUAGE /AWS1/S3_CONTENTLANGUAGE

The language the content is in.

iv_contentlength TYPE /AWS1/S3_CONTENTLENGTH /AWS1/S3_CONTENTLENGTH

The size of the content body in bytes.

iv_contentrange TYPE /AWS1/S3_CONTENTRANGE /AWS1/S3_CONTENTRANGE

The portion of the object returned in the response.

iv_contenttype TYPE /AWS1/S3_CONTENTTYPE /AWS1/S3_CONTENTTYPE

A standard MIME type describing the format of the object data.

iv_checksumcrc32 TYPE /AWS1/S3_CHECKSUMCRC32 /AWS1/S3_CHECKSUMCRC32

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit CRC32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

iv_checksumcrc32c TYPE /AWS1/S3_CHECKSUMCRC32C /AWS1/S3_CHECKSUMCRC32C

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 32-bit CRC32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

iv_checksumcrc64nvme TYPE /AWS1/S3_CHECKSUMCRC64NVME /AWS1/S3_CHECKSUMCRC64NVME

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit CRC64NVME checksum of the part. For more information, see Checking object integrity in the Amazon S3 User Guide.

iv_checksumsha1 TYPE /AWS1/S3_CHECKSUMSHA1 /AWS1/S3_CHECKSUMSHA1

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 160-bit SHA1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

iv_checksumsha256 TYPE /AWS1/S3_CHECKSUMSHA256 /AWS1/S3_CHECKSUMSHA256

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the Base64 encoded, 256-bit SHA256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

iv_deletemarker TYPE /AWS1/S3_DELETEMARKER /AWS1/S3_DELETEMARKER

Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker. To learn more about delete markers, see Working with delete markers.

iv_etag TYPE /AWS1/S3_ETAG /AWS1/S3_ETAG

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

iv_expires TYPE /AWS1/S3_EXPIRES /AWS1/S3_EXPIRES

The date and time at which the object is no longer cacheable.

iv_expiration TYPE /AWS1/S3_EXPIRATION /AWS1/S3_EXPIRATION

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide the object expiration information. The value of the rule-id is URL-encoded.

iv_lastmodified TYPE /AWS1/S3_LASTMODIFIED /AWS1/S3_LASTMODIFIED

The date and time that the object was last modified.

iv_missingmeta TYPE /AWS1/S3_MISSINGMETA /AWS1/S3_MISSINGMETA

Set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

it_metadata TYPE /AWS1/CL_S3_METADATA_W=>TT_METADATA TT_METADATA

A map of metadata to store with the object in S3.

iv_objectlockmode TYPE /AWS1/S3_OBJECTLOCKMODE /AWS1/S3_OBJECTLOCKMODE

Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.

iv_objectlocklegalholdstatus TYPE /AWS1/S3_OBJLOCKLEGALHOLDSTAT /AWS1/S3_OBJLOCKLEGALHOLDSTAT

Indicates whether an object stored in Amazon S3 has an active legal hold.

iv_objectlockretainuntildate TYPE /AWS1/S3_OBJLOCKRTNUNTILDATE /AWS1/S3_OBJLOCKRTNUNTILDATE

The date and time when Object Lock is configured to expire.

iv_partscount TYPE /AWS1/S3_PARTSCOUNT /AWS1/S3_PARTSCOUNT

The count of parts this object has.

iv_replicationstatus TYPE /AWS1/S3_REPLICATIONSTATUS /AWS1/S3_REPLICATIONSTATUS

Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.

iv_requestcharged TYPE /AWS1/S3_REQUESTCHARGED /AWS1/S3_REQUESTCHARGED

RequestCharged

iv_restore TYPE /AWS1/S3_RESTORE /AWS1/S3_RESTORE

Provides information about object restoration operation and expiration time of the restored object copy.

iv_serversideencryption TYPE /AWS1/S3_SERVERSIDEENCRYPTION /AWS1/S3_SERVERSIDEENCRYPTION

The server-side encryption algorithm used when storing requested object in Amazon S3 or Amazon FSx.

When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.

iv_ssecustomeralgorithm TYPE /AWS1/S3_SSECUSTOMERALGORITHM /AWS1/S3_SSECUSTOMERALGORITHM

Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

iv_ssekmskeyid TYPE /AWS1/S3_SSEKMSKEYID /AWS1/S3_SSEKMSKEYID

If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.

iv_ssecustomerkeymd5 TYPE /AWS1/S3_SSECUSTOMERKEYMD5 /AWS1/S3_SSECUSTOMERKEYMD5

128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).

iv_storageclass TYPE /AWS1/S3_STORAGECLASS /AWS1/S3_STORAGECLASS

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

iv_tagcount TYPE /AWS1/S3_TAGCOUNT /AWS1/S3_TAGCOUNT

The number of tags, if any, on the object.

iv_versionid TYPE /AWS1/S3_OBJECTVERSIONID /AWS1/S3_OBJECTVERSIONID

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

iv_bucketkeyenabled TYPE /AWS1/S3_BUCKETKEYENABLED /AWS1/S3_BUCKETKEYENABLED

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

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.

lo_client->writegetobjectresponse(
  it_metadata = VALUE /aws1/cl_s3_metadata_w=>tt_metadata(
    (
      VALUE /aws1/cl_s3_metadata_w=>ts_metadata_maprow(
        key = |string|
        value = new /aws1/cl_s3_metadata_w( |string| )
      )
    )
  )
  iv_acceptranges = |string|
  iv_body = '5347567362473873563239796247513D'
  iv_bucketkeyenabled = ABAP_TRUE
  iv_cachecontrol = |string|
  iv_checksumcrc32 = |string|
  iv_checksumcrc32c = |string|
  iv_checksumcrc64nvme = |string|
  iv_checksumsha1 = |string|
  iv_checksumsha256 = |string|
  iv_contentdisposition = |string|
  iv_contentencoding = |string|
  iv_contentlanguage = |string|
  iv_contentlength = 123
  iv_contentrange = |string|
  iv_contenttype = |string|
  iv_deletemarker = ABAP_TRUE
  iv_errorcode = |string|
  iv_errormessage = |string|
  iv_etag = |string|
  iv_expiration = |string|
  iv_expires = |string|
  iv_lastmodified = '20150101000000.0000000'
  iv_missingmeta = 123
  iv_objectlocklegalholdstatus = |string|
  iv_objectlockmode = |string|
  iv_objectlockretainuntildate = '20150101000000.0000000'
  iv_partscount = 123
  iv_replicationstatus = |string|
  iv_requestcharged = |string|
  iv_requestroute = |string|
  iv_requesttoken = |string|
  iv_restore = |string|
  iv_serversideencryption = |string|
  iv_ssecustomeralgorithm = |string|
  iv_ssecustomerkeymd5 = |string|
  iv_ssekmskeyid = |string|
  iv_statuscode = 123
  iv_storageclass = |string|
  iv_tagcount = 123
  iv_versionid = |string|
).