class Aws::S3::Types::GetObjectOutput

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/GetObjectOutput AWS API Documentation
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
hold status.
is only returned if you have permission to view an object’s legal
Indicates whether this object has an active legal hold. This field
@!attribute [rw] object_lock_legal_hold_status
@return [Time]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
The date and time when this object’s Object Lock will expire.
@!attribute [rw] object_lock_retain_until_date
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
The Object Lock mode that’s currently in place for this object.
@!attribute [rw] object_lock_mode
@return [Integer] : docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html </note>
<note markdown=“1”> This functionality is not supported for directory buckets.
with an object.
You can use [GetObjectTagging] to retrieve the tag set associated
relevant permission to read object tags.
The number of tags, if any, on the object, when you have the
@!attribute [rw] tag_count
@return [Integer]
as a multipart upload.
you specify ‘partNumber` in your request and the object was uploaded
The count of parts this object has. This value is only returned if
@!attribute [rw] parts_count
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
either a source or destination in a replication rule.
Amazon S3 can return this if your request involves a bucket that is
@!attribute [rw] replication_status
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/RequesterPaysBuckets.html </note>
<note markdown=“1”> This functionality is not supported for directory buckets.
Storage Service user guide*.
buckets for storage transfers and usage] in the *Amazon Simple
for the request. For more information, see [Using Requester Pays
If present, indicates that the requester was successfully charged
@!attribute [rw] request_charged
@return [String]
</note>
Access storage class) in Dedicated Local Zones.
Availability Zones and `ONEZONE_IA` (the S3 One Zone-Infrequent
`EXPRESS_ONEZONE` (the S3 Express One Zone storage class) in
<note markdown=“1”> Directory buckets - Directory buckets only support
objects.
this header for all objects except for S3 Standard storage class
Provides storage class information of the object. Amazon S3 returns
@!attribute [rw] storage_class
@return [Boolean]
encryption with Key Management Service (KMS) keys (SSE-KMS).
Indicates whether the object uses an S3 Bucket Key for server-side
@!attribute [rw] bucket_key_enabled
@return [String]
encryption.
If present, indicates the ID of the KMS key that was used for object
@!attribute [rw] ssekms_key_id
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
encryption key.
round-trip message integrity verification of the customer-provided
was requested, the response will include this header to provide the
If server-side encryption with a customer-provided encryption key
@!attribute [rw] sse_customer_key_md5
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
encryption algorithm that’s used.
was requested, the response will include this header to confirm the
If server-side encryption with a customer-provided encryption key
@!attribute [rw] sse_customer_algorithm
@return [Hash<String,String>]
A map of metadata to store with the object in S3.
@!attribute [rw] metadata
@return [String]
</note>
‘aws:fsx`.
access points, the only valid server side encryption option is
<note markdown=“1”> When accessing data stored in Amazon FSx file systems using S3
in Amazon S3 or Amazon FSx.
The server-side encryption algorithm used when you store this object
@!attribute [rw] server_side_encryption
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
metadata.
URL. Amazon S3 stores the value of this header in the object
this object to another object in the same bucket or to an external
If the bucket is configured as a website, redirects requests for
@!attribute [rw] website_redirect_location
@return [String]
@!attribute [rw] expires_string
@return [Time]
The date and time at which the object is no longer cacheable.
@!attribute [rw] expires
@return [String]
A standard MIME type describing the format of the object data.
@!attribute [rw] content_type
@return [String]
The portion of the object returned in the response.
@!attribute [rw] content_range
@return [String]
The language the content is in.
@!attribute [rw] content_language
@return [String]
media-type referenced by the Content-Type header field.
thus what decoding mechanisms must be applied to obtain the
Indicates what content encodings have been applied to the object and
@!attribute [rw] content_encoding
@return [String]
Specifies presentational information for the object.
@!attribute [rw] content_disposition
@return [String]
Specifies caching behavior along the request/reply chain.
@!attribute [rw] cache_control
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
Version ID of the object.
@!attribute [rw] version_id
@return [Integer]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
metadata whose values are not legal HTTP headers.
metadata than the REST API. For example, using SOAP, you can create
create metadata using an API like SOAP that supports more flexible
headers that are prefixed with `x-amz-meta-`. This can happen if you
This is set to the number of metadata entries not returned in the
@!attribute [rw] missing_meta
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html object integrity] in the *Amazon S3 User Guide*.
`CreateMultipartUpload` request. For more information, see [Checking
that is received is the same checksum type that was specified in the
You can use this header response to verify that the checksum type
combined to create an object-level checksum for multipart objects.
The checksum type, which determines how part-level checksums are
@!attribute [rw] checksum_type
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html User Guide*.
information, see [ Checking object integrity] in the *Amazon S3
only be present if the object was uploaded with the object. For more
The Base64 encoded, 256-bit `SHA256` digest of the object. This will
@!attribute [rw] checksum_sha256
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html User Guide*.
information, see [ Checking object integrity] in the *Amazon S3
only be present if the object was uploaded with the object. For more
The Base64 encoded, 160-bit `SHA1` digest of the object. This will
@!attribute [rw] checksum_sha1
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html User Guide].
more information, see [Checking object integrity in the Amazon S3
The Base64 encoded, 64-bit `CRC64NVME` checksum of the object. For
@!attribute [rw] checksum_crc64nvme
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html S3 User Guide*.
more information, see [ Checking object integrity] in the *Amazon
will only be present if the object was uploaded with the object. For
The Base64 encoded, 32-bit `CRC32C` checksum of the object. This
@!attribute [rw] checksum_crc32c
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html *Amazon S3 User Guide*.
For more information, see [ Checking object integrity] in the
checksum is only present if the object was uploaded with the object.
The Base64 encoded, 32-bit `CRC32` checksum of the object. This
@!attribute [rw] checksum_crc32
@return [String]
server to a specific version of a resource found at a URL.
An entity tag (ETag) is an opaque identifier assigned by a web
@!attribute [rw] etag
@return [Integer]
Size of the body in bytes.
@!attribute [rw] content_length
@return [Time]
error and the `Last-Modified: timestamp` response header.
is a delete marker, the response returns a `405 Method Not Allowed`
the object in your request, if the specified version in the request
General purpose buckets - When you specify a `versionId` of
Date and time when the object was last modified.
@!attribute [rw] last_modified
@return [String]
</note>
Zone-Infrequent Access storage class) in Dedicated Local Zones.
storage class) in Availability Zones and `ONEZONE_IA` (the S3 One
buckets only support `EXPRESS_ONEZONE` (the S3 Express One Zone
<note markdown=“1”> This functionality is not supported for directory buckets. Directory
time of the restored object copy.
Provides information about object restoration action and expiration
@!attribute [rw] restore
@return [String] : docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html </note>
responses for directory buckets.
and this header returns the value “`NotImplemented`” in all
<note markdown=“1”> Object expiration information is not returned in directory buckets
is URL-encoded.
providing object expiration information. The value of the `rule-id`
header. It includes the `expiry-date` and `rule-id` key-value pairs
`PutBucketLifecycleConfiguration` ][1]), the response includes this
If the object expiration is configured (see [
@!attribute [rw] expiration
@return [String]
Indicates that a range of bytes was specified in the request.
@!attribute [rw] accept_ranges
@return [Boolean]
</note>
`Last-Modified: timestamp` response header.
response returns a `405 Method Not Allowed` error and the
* If the specified version in the request is a delete marker, the
`x-amz-delete-marker: true` in the response.
behaves as if the object was deleted and includes
<note markdown=“1”> * If the current version of the object is a delete marker, Amazon S3
the response.
a Delete Marker. If false, this response header does not appear in
Indicates whether the object retrieved was (true) or was not (false)
@!attribute [rw] delete_marker
@return [IO]
Object data.
@!attribute [rw] body

class Aws::S3::Types::GetObjectOutput

Namespace

Included Modules

Defined in