Container for the parameters to the WriteGetObjectResponse operation.
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.
Inheritance Hierarchy
Namespace: Amazon.S3.Model
Assembly: AWSSDK.S3.dll
Version: 3.x.y.z
Syntax
public class WriteGetObjectResponseRequest : AmazonWebServiceRequest IAmazonWebServiceRequest
The WriteGetObjectResponseRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
WriteGetObjectResponseRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AcceptRanges | System.String |
Indicates that a range of bytes was specified. |
|
|
Body | System.IO.Stream |
The object data . |
|
|
BucketKeyEnabled | 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). |
|
|
CacheControl | System.String |
Specifies caching behavior along the request/reply chain. |
|
|
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. For more information, see Checking object integrity in the Amazon S3 User Guide. |
|
|
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. For more information, see Checking object integrity in the Amazon S3 User Guide. |
|
|
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 SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide. |
|
|
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 SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide. |
|
|
ContentDisposition | System.String |
Specifies presentational information for the object. |
|
|
ContentEncoding | System.String |
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. |
|
|
ContentLanguage | System.String |
The language the content is in. |
|
|
ContentLength | System.Nullable<System.Int64> |
The size of the body in bytes. |
|
|
ContentRange | System.String |
The portion of the object returned in the response. |
|
|
ContentType | System.String |
A standard MIME type describing the format of the object data. |
|
|
DeleteMarker | System.Boolean |
Specifies whether an object stored in Amazon S3 is ( |
|
|
ErrorCode | System.String |
A string that uniquely identifies an error condition. Returned in |
|
|
ErrorMessage | System.String |
Contains a generic description of the error condition. Returned in |
|
|
ETag | System.String |
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL. |
|
|
Expiration | System.String |
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. |
|
|
Expires | System.DateTime |
The date and time at which the object is no longer cacheable. |
|
|
LastModified | System.DateTime |
Date and time the object was last modified. |
|
|
Metadata | Amazon.S3.Model.MetadataCollection |
A map of metadata to store with the object in S3. |
|
|
MissingMeta | System.Nullable<System.Int32> |
Set to the number of metadata entries not returned in |
|
|
ObjectLockLegalHoldStatus | Amazon.S3.ObjectLockLegalHoldStatus |
Indicates whether object stored in Amazon S3 has an active legal hold. |
|
|
ObjectLockMode | Amazon.S3.ObjectLockMode | |
|
|
ObjectLockRetainUntilDate | System.DateTime |
Date and time when Object Lock is configured to expire. |
|
|
PartsCount | System.Nullable<System.Int32> |
The count of parts this object has. |
|
|
ReplicationStatus | Amazon.S3.ReplicationStatus | |
|
|
RequestCharged | Amazon.S3.RequestCharged |
If present, indicates that the requester was successfully charged for the request. |
|
|
RequestRoute | System.String |
Route prefix to the HTTP URL generated. |
|
|
RequestToken | System.String |
A single use encrypted token that maps |
|
|
Restore | System.String |
Provides information about object restoration operation and expiration time of the restored object copy. |
|
|
ServerSideEncryptionMethod | Amazon.S3.ServerSideEncryptionMethod |
The server-side encryption algorithm used when storing requested object in Amazon
S3 (for example, AES256, |
|
|
SSECustomerAlgorithm | Amazon.S3.ServerSideEncryptionCustomerMethod |
Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3. |
|
|
SSECustomerKeyMD5 | System.String | |
|
|
SSEKMSKeyId | System.String |
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. |
|
|
StatusCode | System.Nullable<System.Int32> |
The integer status code for an HTTP response of a corresponding
|
|
|
StorageClass | Amazon.S3.S3StorageClass |
The class of storage used to store object in Amazon S3. |
|
|
TagCount | System.Nullable<System.Int32> |
The number of tags, if any, on the object. |
|
|
VersionId | System.String |
VersionId used to reference a specific version of the object. |
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5