Class: Aws::S3::Types::HeadObjectRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::S3::Types::HeadObjectRequest
- Defined in:
- gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[:sse_customer_key]
Instance Attribute Summary collapse
-
#bucket ⇒ String
The name of the bucket that contains the object.
-
#checksum_mode ⇒ String
To retrieve the checksum, this parameter must be enabled.
-
#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) error.
-
#if_modified_since ⇒ Time
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
-
#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) error.
-
#if_unmodified_since ⇒ Time
Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
-
#key ⇒ String
The object key.
-
#part_number ⇒ Integer
Part number of the object being read.
-
#range ⇒ String
HeadObject returns only the metadata for 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 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
Version ID used to reference a specific version of the object.
Instance Attribute Details
#bucket ⇒ String
The name of the bucket that contains the object.
Directory buckets - When you use this operation with a directory
bucket, you must use virtual-hosted-style requests in the format
Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style
requests are not supported. Directory bucket names must be unique in
the chosen Availability Zone. Bucket names must follow the format
bucket_base_name--az-id--x-s3
(for example,
DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket
naming restrictions, see Directory bucket naming rules in the
Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 in the Amazon S3 User Guide.
S3 on Outposts - When you use 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 you use this action with S3 on Outposts through the Amazon Web
Services SDKs, you provide the Outposts access point ARN in place of
the bucket name. For more information about S3 on Outposts ARNs, see
What is S3 on Outposts? in the Amazon S3 User Guide.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#checksum_mode ⇒ String
To retrieve the checksum, this parameter must be enabled.
In addition, if you enable ChecksumMode
and the object is
encrypted with Amazon Web Services Key Management Service (Amazon
Web Services KMS), you must have permission to use the kms:Decrypt
action for the request to succeed.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#expected_bucket_owner ⇒ String
The account ID of the expected bucket owner. If the account ID that
you provide does not match the actual owner of the bucket, the
request fails with the HTTP status code 403 Forbidden
(access
denied).
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) 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) error.
If both of the If-Match
and If-Unmodified-Since
headers are
present in the request as follows:
If-Match
condition evaluates totrue
, and;If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) 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) error.
If both of the If-None-Match
and If-Modified-Since
headers are
present in the request as follows:
If-None-Match
condition evaluates tofalse
, and;If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) 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) error.
If both of the If-None-Match
and If-Modified-Since
headers are
present in the request as follows:
If-None-Match
condition evaluates tofalse
, and;If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) 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) error.
If both of the If-Match
and If-Unmodified-Since
headers are
present in the request as follows:
If-Match
condition evaluates totrue
, and;If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns 200 OK
and the data requested.
For more information about conditional requests, see RFC 7232.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#key ⇒ String
The object key.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) 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' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#range ⇒ String
HeadObject returns only the metadata for an object. If the Range is
satisfiable, only the ContentLength
is affected in the response.
If the Range is not satisfiable, S3 returns a 416 - Requested Range
Not Satisfiable
error.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) 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. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#sse_customer_algorithm ⇒ String
Specifies the algorithm to use when encrypting the object (for example, AES256).
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) SENSITIVE = [:sse_customer_key] 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.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) 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.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) SENSITIVE = [:sse_customer_key] include Aws::Structure end |
#version_id ⇒ String
Version ID used to reference a specific version of the object.
null
value
of the version ID is supported.
8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 |
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8538 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, :expected_bucket_owner, :checksum_mode) SENSITIVE = [:sse_customer_key] include Aws::Structure end |