Class: Aws::S3::Types::HeadObjectRequest

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::HeadObjectRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

Note:

When making an API call, you may pass HeadObjectRequest 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",
  version_id: "ObjectVersionId",
  sse_customer_algorithm: "SSECustomerAlgorithm",
  sse_customer_key: "SSECustomerKey",
  sse_customer_key_md5: "SSECustomerKeyMD5",
  request_payer: "requester", # accepts requester
  part_number: 1,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #bucket ⇒ String

  The name of the bucket containing the object.

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

  The object key.

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

• #sse_customer_algorithm ⇒ 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.

• #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 name of the bucket containing the object.

Returns:

• (String)

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

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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 'lib/aws-sdk-s3/types.rb', line 5494

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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 'lib/aws-sdk-s3/types.rb', line 5494

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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 'lib/aws-sdk-s3/types.rb', line 5494

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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 'lib/aws-sdk-s3/types.rb', line 5494

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number)
  include Aws::Structure
end

#key ⇒ String

The object key.

Returns:

• (String)

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

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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’ HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

Returns:

• (Integer)

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

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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, see [www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35]().

Returns:

• (String)

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

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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 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*.

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

Returns:

• (String)

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

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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 (for example, AES256).

Returns:

• (String)

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

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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 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)

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

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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 that the encryption key was transmitted without error.

Returns:

• (String)

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

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :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 'lib/aws-sdk-s3/types.rb', line 5494

class HeadObjectRequest < Struct.new(
  :bucket,
  :if_match,
  :if_modified_since,
  :if_none_match,
  :if_unmodified_since,
  :key,
  :range,
  :version_id,
  :sse_customer_algorithm,
  :sse_customer_key,
  :sse_customer_key_md5,
  :request_payer,
  :part_number)
  include Aws::Structure
end