Class: Aws::S3::Types::GetObjectRequest

Inherits:

Struct

Object
Struct
Aws::S3::Types::GetObjectRequest

show all

Includes:: Aws::Structure

Defined in:: lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass GetObjectRequest data as a hash:

{
  bucket: "BucketName", # required
  if_match: "IfMatch",
  if_modified_since: Time.now,
  if_none_match: "IfNoneMatch",
  if_unmodified_since: Time.now,
  key: "ObjectKey", # required
  range: "Range",
  response_cache_control: "ResponseCacheControl",
  response_content_disposition: "ResponseContentDisposition",
  response_content_encoding: "ResponseContentEncoding",
  response_content_language: "ResponseContentLanguage",
  response_content_type: "ResponseContentType",
  response_expires: Time.now,
  version_id: "ObjectVersionId",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  part_number: 1,
  expected_bucket_owner: "AccountId",
}

Constant Summary collapse

SENSITIVE =

[:sse_customer_key]

Instance Attribute Summary collapse

#bucket ⇒ String

The bucket name containing the object.
#expected_bucket_owner ⇒ String

The account ID of the expected bucket owner.
#if_match ⇒ String

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
#if_modified_since ⇒ Time

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
#if_none_match ⇒ String

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
#if_unmodified_since ⇒ Time

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
#key ⇒ String

Key of the object to get.
#part_number ⇒ Integer

Part number of the object being read.
#range ⇒ String

Downloads the specified range bytes of an object.
#request_payer ⇒ String

Confirms that the requester knows that they will be charged for the request.
#response_cache_control ⇒ String

Sets the Cache-Control header of the response.
#response_content_disposition ⇒ String

Sets the Content-Disposition header of the response.
#response_content_encoding ⇒ String

Sets the Content-Encoding header of the response.
#response_content_language ⇒ String

Sets the Content-Language header of the response.
#response_content_type ⇒ String

Sets the Content-Type header of the response.
#response_expires ⇒ Time

Sets the Expires header of the response.
#sse_customer_algorithm ⇒ String

Specifies the algorithm to use to when decrypting the object (for example, AES256).
#sse_customer_key ⇒ String

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data.
#sse_customer_key_md5 ⇒ String

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
#version_id ⇒ String

VersionId used to reference a specific version of the object.

Instance Attribute Details

#bucket ⇒ `String`

The bucket name containing the object.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see

Using access points][1: in the *Amazon S3 User Guide*.

When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see

Using S3 on Outposts][2: in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#expected_bucket_owner ⇒ `String`

The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP ‘403 (Access Denied)` error.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#if_match ⇒ `String`

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#if_modified_since ⇒ `Time`

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

Returns:

(Time)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#if_none_match ⇒ `String`

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#if_unmodified_since ⇒ `Time`

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

Returns:

(Time)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#key ⇒ `String`

Key of the object to get.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#part_number ⇒ `Integer`

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a ‘ranged’ GET request for the part specified. Useful for downloading just a part of an object.

Returns:

(Integer)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#range ⇒ `String`

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35][1].

<note markdown=“1”> Amazon S3 doesn’t support retrieving multiple ranges of data per GET request.

</note>

[1]: www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#request_payer ⇒ `String`

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from requester pays buckets, see [Downloading Objects in Requestor Pays Buckets] in the *Amazon S3 User Guide*.

[1]: docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#response_cache_control ⇒ `String`

Sets the Cache-Control header of the response.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#response_content_disposition ⇒ `String`

Sets the Content-Disposition header of the response

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#response_content_encoding ⇒ `String`

Sets the Content-Encoding header of the response.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#response_content_language ⇒ `String`

Sets the Content-Language header of the response.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#response_content_type ⇒ `String`

Sets the Content-Type header of the response.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#response_expires ⇒ `Time`

Sets the Expires header of the response.

Returns:

(Time)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_algorithm ⇒ `String`

Specifies the algorithm to use to when decrypting the object (for example, AES256).

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_key ⇒ `String`

Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#sse_customer_key_md5 ⇒ `String`

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

#version_id ⇒ `String`

VersionId used to reference a specific version of the object.

Returns:

(String)

# File 'lib/aws-sdk-s3/types.rb', line 5739

class GetObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :response_cache_control,
  :response_content_disposition,
  :response_content_encoding,
  :response_content_language,
  :response_content_type,
  :response_expires,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number,
  :expected_bucket_owner)
  SENSITIVE = [:sse_customer_key]
  include Aws::Structure
end

Class: Aws::S3::Types::GetObjectRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

#expected_bucket_owner ⇒ String

#if_match ⇒ String

#if_modified_since ⇒ Time

#if_none_match ⇒ String

#if_unmodified_since ⇒ Time

#key ⇒ String

#part_number ⇒ Integer

#range ⇒ String

#request_payer ⇒ String

#response_cache_control ⇒ String

#response_content_disposition ⇒ String

#response_content_encoding ⇒ String

#response_content_language ⇒ String

#response_content_type ⇒ String

#response_expires ⇒ Time

#sse_customer_algorithm ⇒ String

#sse_customer_key ⇒ String

#sse_customer_key_md5 ⇒ String

#version_id ⇒ String

#bucket ⇒ `String`

#expected_bucket_owner ⇒ `String`

#if_match ⇒ `String`

#if_modified_since ⇒ `Time`

#if_none_match ⇒ `String`

#if_unmodified_since ⇒ `Time`

#key ⇒ `String`

#part_number ⇒ `Integer`

#range ⇒ `String`

#request_payer ⇒ `String`

#response_cache_control ⇒ `String`

#response_content_disposition ⇒ `String`

#response_content_encoding ⇒ `String`

#response_content_language ⇒ `String`

#response_content_type ⇒ `String`

#response_expires ⇒ `Time`

#sse_customer_algorithm ⇒ `String`

#sse_customer_key ⇒ `String`

#sse_customer_key_md5 ⇒ `String`

#version_id ⇒ `String`