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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetObjectRequest as input to an Aws::Client method, you can use a vanilla 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",
  use_accelerate_endpoint: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#bucket ⇒ String

The bucket name containing the object.

When using this API 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 operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

When using this API 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 operation using S3 on Outposts through the AWS 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 in the Amazon Simple Storage Service Developer Guide.

Returns:

  • (String) —

    The bucket name containing the object.

#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) —

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

Returns:

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

Returns:

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

Returns:

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

Returns:

  • (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.

Returns:

  • (String) —

    Key of the object to get.

#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) —

    Part number of the object being read.

#range ⇒ String

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

Amazon S3 doesn\'t support retrieving multiple ranges of data per GET request.

Returns:

  • (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. 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 Developer Guide.

Possible values:

  • requester

Returns:

  • (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.

Returns:

  • (String) —

    Sets the Cache-Control header of the response.

#response_content_disposition ⇒ String

Sets the Content-Disposition header of the response

Returns:

  • (String) —

    Sets the Content-Disposition header of the response.

#response_content_encoding ⇒ String

Sets the Content-Encoding header of the response.

Returns:

  • (String) —

    Sets the Content-Encoding header of the response.

#response_content_language ⇒ String

Sets the Content-Language header of the response.

Returns:

  • (String) —

    Sets the Content-Language header of the response.

#response_content_type ⇒ String

Sets the Content-Type header of the response.

Returns:

  • (String) —

    Sets the Content-Type header of the response.

#response_expires ⇒ Time

Sets the Expires header of the response.

Returns:

  • (Time) —

    Sets the Expires header of the response.

#sse_customer_algorithm ⇒ String

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

Returns:

  • (String) —

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

#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 S3 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) —

    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. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Returns:

  • (String) —

    Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.

#use_accelerate_endpoint ⇒ Boolean

When true, the "https://BUCKETNAME.s3-accelerate.amazonaws.com" endpoint will be used.

Returns:

#version_id ⇒ String

VersionId used to reference a specific version of the object.

Returns:

  • (String) —

    VersionId used to reference a specific version of the object.