class Aws::S3::Types::WriteGetObjectResponseRequest
@note When making an API call, you may pass WriteGetObjectResponseRequest
data as a hash: { request_route: "RequestRoute", # required request_token: "RequestToken", # required body: source_file, status_code: 1, error_code: "ErrorCode", error_message: "ErrorMessage", accept_ranges: "AcceptRanges", cache_control: "CacheControl", content_disposition: "ContentDisposition", content_encoding: "ContentEncoding", content_language: "ContentLanguage", content_length: 1, content_range: "ContentRange", content_type: "ContentType", delete_marker: false, etag: "ETag", expires: Time.now, expiration: "Expiration", last_modified: Time.now, missing_meta: 1, metadata: { "MetadataKey" => "MetadataValue", }, object_lock_mode: "GOVERNANCE", # accepts GOVERNANCE, COMPLIANCE object_lock_legal_hold_status: "ON", # accepts ON, OFF object_lock_retain_until_date: Time.now, parts_count: 1, replication_status: "COMPLETE", # accepts COMPLETE, PENDING, FAILED, REPLICA request_charged: "requester", # accepts requester restore: "Restore", server_side_encryption: "AES256", # accepts AES256, aws:kms sse_customer_algorithm: "SSECustomerAlgorithm", ssekms_key_id: "SSEKMSKeyId", sse_customer_key_md5: "SSECustomerKeyMD5", storage_class: "STANDARD", # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER, DEEP_ARCHIVE, OUTPOSTS tag_count: 1, version_id: "ObjectVersionId", bucket_key_enabled: false, }
@!attribute [rw] request_route
Route prefix to the HTTP URL generated. @return [String]
@!attribute [rw] request_token
A single use encrypted token that maps `WriteGetObjectResponse` to the end user `GetObject` request. @return [String]
@!attribute [rw] body
The object data. @return [IO]
@!attribute [rw] status_code
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* @return [Integer]
@!attribute [rw] error_code
A string that uniquely identifies an error condition. Returned in the <Code> 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\]+$". @return [String]
@!attribute [rw] error_message
Contains a generic description of the error condition. Returned in the <Message> 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. @return [String]
@!attribute [rw] accept_ranges
Indicates that a range of bytes was specified. @return [String]
@!attribute [rw] cache_control
Specifies caching behavior along the request/reply chain. @return [String]
@!attribute [rw] content_disposition
Specifies presentational information for the object. @return [String]
@!attribute [rw] content_encoding
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. @return [String]
@!attribute [rw] content_language
The language the content is in. @return [String]
@!attribute [rw] content_length
The size of the content body in bytes. @return [Integer]
@!attribute [rw] content_range
The portion of the object returned in the response. @return [String]
@!attribute [rw] content_type
A standard MIME type describing the format of the object data. @return [String]
@!attribute [rw] delete_marker
Specifies whether an object stored in Amazon S3 is (`true`) or is not (`false`) a delete marker. @return [Boolean]
@!attribute [rw] etag
An opaque identifier assigned by a web server to a specific version of a resource found at a URL. @return [String]
@!attribute [rw] expires
The date and time at which the object is no longer cacheable. @return [Time]
@!attribute [rw] 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. @return [String]
@!attribute [rw] last_modified
The date and time that the object was last modified. @return [Time]
@!attribute [rw] missing_meta
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. @return [Integer]
@!attribute [rw] metadata
A map of metadata to store with the object in S3. @return [Hash<String,String>]
@!attribute [rw] object_lock_mode
Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see [Object Lock][1]. [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock.html @return [String]
@!attribute [rw] object_lock_legal_hold_status
Indicates whether an object stored in Amazon S3 has an active legal hold. @return [String]
@!attribute [rw] object_lock_retain_until_date
The date and time when Object Lock is configured to expire. @return [Time]
@!attribute [rw] parts_count
The count of parts this object has. @return [Integer]
@!attribute [rw] replication_status
Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see [Replication][1]. [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication.html @return [String]
@!attribute [rw] request_charged
If present, indicates that the requester was successfully charged for the request. @return [String]
@!attribute [rw] restore
Provides information about object restoration operation and expiration time of the restored object copy. @return [String]
@!attribute [rw] server_side_encryption
The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms). @return [String]
@!attribute [rw] sse_customer_algorithm
Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3. @return [String]
@!attribute [rw] ssekms_key_id
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed customer master key (CMK) that was used for stored in Amazon S3 object. @return [String]
@!attribute [rw] sse_customer_key_md5
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)][1]. [1]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/ServerSideEncryptionCustomerKeys.html @return [String]
@!attribute [rw] storage_class
The class of storage used to store object in Amazon S3. @return [String]
@!attribute [rw] tag_count
The number of tags, if any, on the object. @return [Integer]
@!attribute [rw] version_id
An ID used to reference a specific version of the object. @return [String]
@!attribute [rw] bucket_key_enabled
Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS). @return [Boolean]
@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/WriteGetObjectResponseRequest AWS API Documentation
Constants
- SENSITIVE