Struct aws_sdk_s3::client::fluent_builders::WriteGetObjectResponse

pub struct WriteGetObjectResponse<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to WriteGetObjectResponse.

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.

Implementations

impl<C, M, R> WriteGetObjectResponse<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<WriteGetObjectResponseOutput, SdkError<WriteGetObjectResponseError>> where
    R::Policy: SmithyRetryPolicy<WriteGetObjectResponseInputOperationOutputAlias, WriteGetObjectResponseOutput, WriteGetObjectResponseError, WriteGetObjectResponseInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn request_route(self, inp: impl Into<String>) -> Self

Route prefix to the HTTP URL generated.

pub fn set_request_route(self, input: Option<String>) -> Self

Route prefix to the HTTP URL generated.

pub fn request_token(self, inp: impl Into<String>) -> Self

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

pub fn set_request_token(self, input: Option<String>) -> Self

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

pub fn body(self, inp: ByteStream) -> Self

The object data.

pub fn set_body(self, input: Option<ByteStream>) -> Self

The object data.

pub fn status_code(self, inp: i32) -> Self

The integer status code for an HTTP response of a corresponding GetObject request.

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

pub fn set_status_code(self, input: Option<i32>) -> Self

The integer status code for an HTTP response of a corresponding GetObject request.

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

pub fn error_code(self, inp: impl Into<String>) -> Self

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. Regex value is "^[A-Z][a-zA-Z]+$".

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. Regex value is "^[A-Z][a-zA-Z]+$".

pub fn error_message(self, inp: impl Into<String>) -> Self

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.

pub fn set_error_message(self, input: Option<String>) -> Self

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.

pub fn accept_ranges(self, inp: impl Into<String>) -> Self

Indicates that a range of bytes was specified.

pub fn set_accept_ranges(self, input: Option<String>) -> Self

Indicates that a range of bytes was specified.

pub fn cache_control(self, inp: impl Into<String>) -> Self

Specifies caching behavior along the request/reply chain.

pub fn set_cache_control(self, input: Option<String>) -> Self

Specifies caching behavior along the request/reply chain.

pub fn content_disposition(self, inp: impl Into<String>) -> Self

Specifies presentational information for the object.

pub fn set_content_disposition(self, input: Option<String>) -> Self

Specifies presentational information for the object.

pub fn content_encoding(self, inp: impl Into<String>) -> Self

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.

pub fn set_content_encoding(self, input: Option<String>) -> Self

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.

pub fn content_language(self, inp: impl Into<String>) -> Self

The language the content is in.

pub fn set_content_language(self, input: Option<String>) -> Self

The language the content is in.

pub fn content_length(self, inp: i64) -> Self

The size of the content body in bytes.

pub fn set_content_length(self, input: Option<i64>) -> Self

The size of the content body in bytes.

pub fn content_range(self, inp: impl Into<String>) -> Self

The portion of the object returned in the response.

pub fn set_content_range(self, input: Option<String>) -> Self

The portion of the object returned in the response.

pub fn content_type(self, inp: impl Into<String>) -> Self

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

pub fn set_content_type(self, input: Option<String>) -> Self

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

pub fn delete_marker(self, inp: bool) -> Self

Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.

pub fn set_delete_marker(self, input: Option<bool>) -> Self

Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.

pub fn e_tag(self, inp: impl Into<String>) -> Self

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

pub fn set_e_tag(self, input: Option<String>) -> Self

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

pub fn expires(self, inp: Instant) -> Self

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

pub fn set_expires(self, input: Option<Instant>) -> Self

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

pub fn expiration(self, inp: impl Into<String>) -> Self

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.

pub fn set_expiration(self, input: Option<String>) -> Self

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.

pub fn last_modified(self, inp: Instant) -> Self

The date and time that the object was last modified.

pub fn set_last_modified(self, input: Option<Instant>) -> Self

The date and time that the object was last modified.

pub fn missing_meta(self, inp: i32) -> Self

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.

pub fn set_missing_meta(self, input: Option<i32>) -> Self

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.

pub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to Metadata.

To override the contents of this collection use set_metadata.

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

pub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self

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

pub fn object_lock_mode(self, inp: ObjectLockMode) -> Self

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

pub fn set_object_lock_mode(self, input: Option<ObjectLockMode>) -> Self

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

pub fn object_lock_legal_hold_status(
    self,
    inp: ObjectLockLegalHoldStatus
) -> Self

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

pub fn set_object_lock_legal_hold_status(
    self,
    input: Option<ObjectLockLegalHoldStatus>
) -> Self

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

pub fn object_lock_retain_until_date(self, inp: Instant) -> Self

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

pub fn set_object_lock_retain_until_date(self, input: Option<Instant>) -> Self

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

pub fn parts_count(self, inp: i32) -> Self

The count of parts this object has.

pub fn set_parts_count(self, input: Option<i32>) -> Self

The count of parts this object has.

pub fn replication_status(self, inp: ReplicationStatus) -> Self

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

pub fn set_replication_status(self, input: Option<ReplicationStatus>) -> Self

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

pub fn request_charged(self, inp: RequestCharged) -> Self

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

pub fn set_request_charged(self, input: Option<RequestCharged>) -> Self

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

pub fn restore(self, inp: impl Into<String>) -> Self

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

pub fn set_restore(self, input: Option<String>) -> Self

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

pub fn server_side_encryption(self, inp: ServerSideEncryption) -> Self

The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

pub fn set_server_side_encryption(
    self,
    input: Option<ServerSideEncryption>
) -> Self

The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

pub fn sse_customer_algorithm(self, inp: impl Into<String>) -> Self

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

pub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self

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

pub fn ssekms_key_id(self, inp: impl Into<String>) -> Self

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

pub fn set_ssekms_key_id(self, input: Option<String>) -> Self

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

pub fn sse_customer_key_md5(self, inp: impl Into<String>) -> Self

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

pub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self

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

pub fn storage_class(self, inp: StorageClass) -> Self

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

pub fn set_storage_class(self, input: Option<StorageClass>) -> Self

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

pub fn tag_count(self, inp: i32) -> Self

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

pub fn set_tag_count(self, input: Option<i32>) -> Self

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

pub fn version_id(self, inp: impl Into<String>) -> Self

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

pub fn set_version_id(self, input: Option<String>) -> Self

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

pub fn bucket_key_enabled(self, inp: bool) -> Self

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

pub fn set_bucket_key_enabled(self, input: Option<bool>) -> Self

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

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for WriteGetObjectResponse<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.