AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the WriteGetObjectResponse operation.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.S3.Model.WriteGetObjectResponseRequest

Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z

Syntax

C# 
public class WriteGetObjectResponseRequest : AmazonWebServiceRequest
         IAmazonWebServiceRequest

The WriteGetObjectResponseRequest type exposes the following members

Constructors

NameDescription
Public Method WriteGetObjectResponseRequest()

Properties

NameTypeDescription
Public Property AcceptRanges System.String

Gets and sets the property AcceptRanges.

Indicates that a range of bytes was specified.

Public Property Body System.IO.Stream

Gets and sets the property Body.

The object data.

Public Property BucketKeyEnabled System.Nullable<System.Boolean>

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 Property CacheControl System.String

Gets and sets the property CacheControl.

Specifies caching behavior along the request/reply chain.

Public Property ChecksumCRC32 System.String

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

Public Property ChecksumCRC32C System.String

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

Public Property ChecksumCRC64NVME System.String

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

Public Property ChecksumSHA1 System.String

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

Public Property ChecksumSHA256 System.String

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

Public Property ContentDisposition System.String

Gets and sets the property ContentDisposition.

Specifies presentational information for the object.

Public Property ContentEncoding System.String

Gets and sets the property 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 Property ContentLanguage System.String

Gets and sets the property ContentLanguage.

The language the content is in.

Public Property ContentLength System.Nullable<System.Int64>

Gets and sets the property ContentLength.

The size of the content body in bytes.

Public Property ContentRange System.String

Gets and sets the property ContentRange.

The portion of the object returned in the response.

Public Property ContentType System.String

Gets and sets the property ContentType.

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

Public Property DeleteMarker System.Nullable<System.Boolean>

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

Public Property ErrorCode System.String

Gets and sets the property 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]+$".

Public Property ErrorMessage System.String

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

Public Property ETag System.String

Gets and sets the property ETag.

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

Public Property Expiration System.String

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

Public Property Expires System.Nullable<System.DateTime>

Gets and sets the property Expires.

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

Public Property LastModified System.Nullable<System.DateTime>

Gets and sets the property LastModified.

The date and time that the object was last modified.

Public Property Metadata Amazon.S3.Model.MetadataCollection

Gets and sets the property Metadata.

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

Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Public Property MissingMeta System.Nullable<System.Int32>

Gets and sets the property 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 Property ObjectLockLegalHoldStatus Amazon.S3.ObjectLockLegalHoldStatus

Gets and sets the property ObjectLockLegalHoldStatus.

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

Public Property ObjectLockMode Amazon.S3.ObjectLockMode

Gets and sets the property ObjectLockMode.

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

Public Property ObjectLockRetainUntilDate System.Nullable<System.DateTime>

Gets and sets the property ObjectLockRetainUntilDate.

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

Public Property PartsCount System.Nullable<System.Int32>

Gets and sets the property PartsCount.

The count of parts this object has.

Public Property ReplicationStatus Amazon.S3.ReplicationStatus

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

Public Property RequestCharged Amazon.S3.RequestCharged

Gets and sets the property RequestCharged.

Public Property RequestRoute System.String

Gets and sets the property RequestRoute.

Route prefix to the HTTP URL generated.

Public Property RequestToken System.String

Gets and sets the property RequestToken.

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

Public Property Restore System.String

Gets and sets the property Restore.

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

Public Property ServerSideEncryptionMethod Amazon.S3.ServerSideEncryptionMethod

Gets and sets the property ServerSideEncryptionMethod.

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.

Public Property SSECustomerAlgorithm Amazon.S3.ServerSideEncryptionCustomerMethod

Gets and sets the property SSECustomerAlgorithm.

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

Public Property SSECustomerKeyMD5 System.String

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

Public Property SSEKMSKeyId System.String

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

Public Property StatusCode System.Nullable<System.Int32>

Gets and sets the property StatusCode.

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
Public Property StorageClass Amazon.S3.S3StorageClass

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

Public Property TagCount System.Nullable<System.Int32>

Gets and sets the property TagCount.

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

Public Property VersionId System.String

Gets and sets the property VersionId.

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

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer