Table of Contents

Class WriteGetObjectResponseRequest

Namespace
Amazon.S3.Model
Assembly
AWSSDK.S3.dll

Container for the parameters to the WriteGetObjectResponse operation. 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. 

public class WriteGetObjectResponseRequest : AmazonWebServiceRequest
Inheritance
WriteGetObjectResponseRequest

Constructors

WriteGetObjectResponseRequest() 

public WriteGetObjectResponseRequest()

Properties

AcceptRanges

Indicates that a range of bytes was specified.

public string AcceptRanges { get; set; }

Property Value

string

Body

The object data

. 
public Stream Body { get; set; }

Property Value

Stream

BucketKeyEnabled

Gets and sets the property 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). 

public bool BucketKeyEnabled { get; set; }

Property Value

bool

CacheControl

Specifies caching behavior along the request/reply chain.

public string CacheControl { get; set; }

Property Value

string

ChecksumCRC32

Gets and sets the property 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. For more information, see Checking object integrity in the Amazon S3 User Guide. 

public string ChecksumCRC32 { get; set; }

Property Value

string

ChecksumCRC32C

Gets and sets the property 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. For more information, see Checking object integrity in the Amazon S3 User Guide. 

public string ChecksumCRC32C { get; set; }

Property Value

string

ChecksumSHA1

Gets and sets the property 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. For more information, see Checking object integrity in the Amazon S3 User Guide. 

public string ChecksumSHA1 { get; set; }

Property Value

string

ChecksumSHA256

Gets and sets the property 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. For more information, see Checking object integrity in the Amazon S3 User Guide. 

public string ChecksumSHA256 { get; set; }

Property Value

string

ContentDisposition

Specifies presentational information for the object.

public string ContentDisposition { get; set; }

Property Value

string

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.

public string ContentEncoding { get; set; }

Property Value

string

ContentLanguage

The language the content is in.

public string ContentLanguage { get; set; }

Property Value

string

ContentLength

The size of the body in bytes.

public long? ContentLength { get; set; }

Property Value

long?

ContentRange

The portion of the object returned in the response.

public string ContentRange { get; set; }

Property Value

string

ContentType

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

public string ContentType { get; set; }

Property Value

string

DeleteMarker

Specifies whether an object stored in Amazon S3 is (

true
) or is not (
false
) a delete marker. 
public bool DeleteMarker { get; set; }

Property Value

bool

ETag

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

public string ETag { get; set; }

Property Value

string

ErrorCode

A string that uniquely identifies an error condition. Returned in <Code> tag of error XML response for corresponding GetObject call. Cannot be used with successful 

StatusCode
header or when transformed object is provided in body. 
public string ErrorCode { get; set; }

Property Value

string

ErrorMessage

Contains a generic description of the error condition. Returned in <Message> tag of error XML response for corresponding GetObject call. Cannot be used with successful 

StatusCode
header or when transformed object is provided in body. 
public string ErrorMessage { get; set; }

Property Value

string

Expiration

If object stored in Amazon S3 expiration is configured (see PUT Bucket lifecycle) it includes expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

public string Expiration { get; set; }

Property Value

string

Expires

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

public DateTime Expires { get; set; }

Property Value

DateTime

LastModified

Date and time the object was last modified.

public DateTime LastModified { get; set; }

Property Value

DateTime

Metadata

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

public MetadataCollection Metadata { get; }

Property Value

MetadataCollection

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. 
public int? MissingMeta { get; set; }

Property Value

int?

ObjectLockLegalHoldStatus

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

public ObjectLockLegalHoldStatus ObjectLockLegalHoldStatus { get; set; }

Property Value

ObjectLockLegalHoldStatus

ObjectLockMode 

public ObjectLockMode ObjectLockMode { get; set; }

Property Value

ObjectLockMode

ObjectLockRetainUntilDate

Date and time when Object Lock is configured to expire.

public DateTime ObjectLockRetainUntilDate { get; set; }

Property Value

DateTime

PartsCount

The count of parts this object has.

public int? PartsCount { get; set; }

Property Value

int?

ReplicationStatus 

public ReplicationStatus ReplicationStatus { get; set; }

Property Value

ReplicationStatus

RequestCharged

If present, indicates that the requester was successfully charged for the request.

public RequestCharged RequestCharged { get; set; }

Property Value

RequestCharged

RequestRoute

Route prefix to the HTTP URL generated.

public string RequestRoute { get; set; }

Property Value

string

RequestToken

A single use encrypted token that maps 

WriteGetObjectResponse
to the end user 
GetObject
request. 
public string RequestToken { get; set; }

Property Value

string

Restore

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

public string Restore { get; set; }

Property Value

string

SSECustomerAlgorithm

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

public ServerSideEncryptionCustomerMethod SSECustomerAlgorithm { get; set; }

Property Value

ServerSideEncryptionCustomerMethod

SSECustomerKeyMD5 

public string SSECustomerKeyMD5 { get; set; }

Property Value

string

SSEKMSKeyId

Gets and sets the property SSEKMSKeyId.

If present, specifies the ID 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. 

public string SSEKMSKeyId { get; set; }

Property Value

string

ServerSideEncryptionMethod

The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, 

aws:kms
). 
public ServerSideEncryptionMethod ServerSideEncryptionMethod { get; set; }

Property Value

ServerSideEncryptionMethod

StatusCode 

public int? StatusCode { get; set; }

Property Value

int?

StorageClass

The class of storage used to store object in Amazon S3.

public S3StorageClass StorageClass { get; set; }

Property Value

S3StorageClass

TagCount

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

public int? TagCount { get; set; }

Property Value

int?

VersionId

VersionId used to reference a specific version of the object.

public string VersionId { get; set; }

Property Value

string