/AWS1/CL_S3=>WRITEGETOBJECTRESPONSE()
¶
About WriteGetObjectResponse¶
This operation is not supported by 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.
Method Signature¶
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 userGetObject
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 successfulStatusCode
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 successfulStatusCode
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_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 SHA-1 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 SHA-256 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.
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
andrule-id
key-value pairs that provide the object expiration information. The value of therule-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 (for example, AES256,
aws:kms
).
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).