You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:

Struct

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

show all

Defined in:: gems/aws-sdk-s3/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,
}

Instance Attribute Summary collapse

#bucket ⇒ String
#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
#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 she or he 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 encrypting the object (e.g., AES256).
#sse_customer_key ⇒ String
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting 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`

Returns:

(String)

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

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)
  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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3109

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)
  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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3109

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)
  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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3109

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)
  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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3109

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)
  include Aws::Structure
end

#key ⇒ `String`

Returns:

(String)

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

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)
  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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 3109

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)
  include Aws::Structure
end

#range ⇒ `String`

Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Returns:

(String)

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

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)
  include Aws::Structure
end

#request_payer ⇒ `String`

Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html

Returns:

(String)

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

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)
  include Aws::Structure
end

#response_cache_control ⇒ `String`

Sets the Cache-Control header of the response.

Returns:

(String)

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

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)
  include Aws::Structure
end

#response_content_disposition ⇒ `String`

Sets the Content-Disposition header of the response

Returns:

(String)

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

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)
  include Aws::Structure
end

#response_content_encoding ⇒ `String`

Sets the Content-Encoding header of the response.

Returns:

(String)

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

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)
  include Aws::Structure
end

#response_content_language ⇒ `String`

Sets the Content-Language header of the response.

Returns:

(String)

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

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)
  include Aws::Structure
end

#response_content_type ⇒ `String`

Sets the Content-Type header of the response.

Returns:

(String)

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

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)
  include Aws::Structure
end

#response_expires ⇒ `Time`

Sets the Expires header of the response.

Returns:

(Time)

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

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)
  include Aws::Structure
end

#sse_customer_algorithm ⇒ `String`

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Returns:

(String)

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

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)
  include Aws::Structure
end

#sse_customer_key ⇒ `String`

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

Returns:

(String)

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

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)
  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 the encryption key was transmitted without error.

Returns:

(String)

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

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)
  include Aws::Structure
end

#version_id ⇒ `String`

VersionId used to reference a specific version of the object.

Returns:

(String)

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

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)
  include Aws::Structure
end

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

Overview

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ 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`

#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`