class Aws::S3::Types::HeadObjectRequest

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObjectRequest AWS API Documentation
@return [String] : docs.aws.amazon.com/AmazonS3/latest/API/API_Checksum.html policies for the KMS key to retrieve the checksum of the object.
‘kms:Decrypt` permissions in IAM identity-based policies and KMS key
Web Services KMS), you must also have the `kms:GenerateDataKey` and
is encrypted with Amazon Web Services Key Management Service (Amazon
**Directory buckets** - If you enable `ChecksumMode` and the object
`kms:Decrypt` action to retrieve the checksum.
Management Service (KMS) key, you must have permission to use the
object is uploaded with a [checksum] and encrypted with an Key
**General purpose buckets** - If you enable checksum mode and the
To retrieve the checksum, this parameter must be enabled.
@!attribute [rw] checksum_mode
@return [String]
denied).
request fails with the HTTP status code `403 Forbidden` (access
you provide does not match the actual owner of the bucket, the
The account ID of the expected bucket owner. If the account ID that
@!attribute [rw] expected_bucket_owner
@return [Integer]
and the number of parts in this object.
for the part specified. Useful querying about the size of the part
between 1 and 10,000. Effectively performs a ’ranged’ HEAD request
Part number of the object being read. This is a positive integer
@!attribute [rw] part_number
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html </note>
<note markdown=“1”> This functionality is not supported for directory buckets.
Requester Pays Buckets] in the *Amazon S3 User Guide*.
objects from Requester Pays buckets, see [Downloading Objects in
charges to copy the object. For information about downloading
Requester Pays enabled, the requester will pay for corresponding
requests. If either the source or destination S3 bucket has
request. Bucket owners need not specify this parameter in their
Confirms that the requester knows that they will be charged for the
@!attribute [rw] request_payer
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
to ensure that the encryption key was transmitted without error.
RFC 1321. Amazon S3 uses this header for a message integrity check
Specifies the 128-bit MD5 digest of the encryption key according to
@!attribute [rw] sse_customer_key_md5
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
‘x-amz-server-side-encryption-customer-algorithm` header.
key must be appropriate for use with the algorithm specified in the
it is discarded; Amazon S3 does not store the encryption key. The
in encrypting data. This value is used to store the object and then
Specifies the customer-provided encryption key for Amazon S3 to use
@!attribute [rw] sse_customer_key
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
example, AES256).
Specifies the algorithm to use when encrypting the object (for
@!attribute [rw] sse_customer_algorithm
@return [String]
</note>
of the version ID is supported.
<note markdown=“1”> For directory buckets in this API operation, only the `null` value
Version ID used to reference a specific version of the object.
@!attribute [rw] version_id
@return [Time]
Sets the `Expires` header of the response.
@!attribute [rw] response_expires
@return [String]
Sets the `Content-Type` header of the response.
@!attribute [rw] response_content_type
@return [String]
Sets the `Content-Language` header of the response.
@!attribute [rw] response_content_language
@return [String]
Sets the `Content-Encoding` header of the response.
@!attribute [rw] response_content_encoding
@return [String]
Sets the `Content-Disposition` header of the response.
@!attribute [rw] response_content_disposition
@return [String]
Sets the `Cache-Control` header of the response.
@!attribute [rw] response_cache_control
@return [String]
Not Satisfiable` error.
If the Range is not satisfiable, S3 returns a `416 - Requested Range
satisfiable, only the `ContentLength` is affected in the response.
HeadObject returns only the metadata for an object. If the Range is
@!attribute [rw] range
@return [String]
The object key.
@!attribute [rw] key
@return [Time] : tools.ietf.org/html/rfc7232 For more information about conditional requests, see [RFC 7232].
Then Amazon S3 returns `200 OK` and the data requested.
* `If-Unmodified-Since` condition evaluates to `false`;
* `If-Match` condition evaluates to `true`, and;
present in the request as follows:
If both of the `If-Match` and `If-Unmodified-Since` headers are
specified time; otherwise, return a 412 (precondition failed) error.
Return the object only if it has not been modified since the
@!attribute [rw] if_unmodified_since
@return [String] : tools.ietf.org/html/rfc7232 For more information about conditional requests, see [RFC 7232].
Then Amazon S3 returns the `304 Not Modified` response code.
* `If-Modified-Since` condition evaluates to `true`;
* `If-None-Match` condition evaluates to `false`, and;
present in the request as follows:
If both of the `If-None-Match` and `If-Modified-Since` headers are
the one specified; otherwise, return a 304 (not modified) error.
Return the object only if its entity tag (ETag) is different from
@!attribute [rw] if_none_match
@return [Time] : tools.ietf.org/html/rfc7232 For more information about conditional requests, see [RFC 7232].
Then Amazon S3 returns the `304 Not Modified` response code.
* `If-Modified-Since` condition evaluates to `true`;
* `If-None-Match` condition evaluates to `false`, and;
present in the request as follows:
If both of the `If-None-Match` and `If-Modified-Since` headers are
time; otherwise, return a 304 (not modified) error.
Return the object only if it has been modified since the specified
@!attribute [rw] if_modified_since
@return [String] : tools.ietf.org/html/rfc7232 For more information about conditional requests, see [RFC 7232].
Then Amazon S3 returns `200 OK` and the data requested.
* `If-Unmodified-Since` condition evaluates to `false`;
* `If-Match` condition evaluates to `true`, and;
present in the request as follows:
If both of the `If-Match` and `If-Unmodified-Since` headers are
one specified; otherwise, return a 412 (precondition failed) error.
Return the object only if its entity tag (ETag) is the same as the
@!attribute [rw] if_match
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html [2]: docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html [1]: docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html Outposts?][3] in the *Amazon S3 User Guide*.
more information about S3 on Outposts, see [What is S3 on
must be the Outposts access point ARN or the access point alias. For
When you use this action with S3 on Outposts, the destination bucket
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com`.
Outposts hostname takes the form `
you must direct requests to the S3 on Outposts hostname. The S3 on
**S3 on Outposts** - When you use this action with S3 on Outposts,
</note>
<note markdown=“1”> Object Lambda access points are not supported by directory buckets.
[Using access points] in the *Amazon S3 User Guide*.
bucket name. For more information about access point ARNs, see
Services SDKs, you provide the access point ARN in place of the
When using this action with an access point through the Amazon Web
AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.
takes the form
requests to the access point hostname. The access point hostname
bucket name. When using the access point ARN, you must direct
buckets, you must provide the access point name in place of the
ARN. When you use this action with an access point for directory
access point in place of the bucket name or specify the access point
for general purpose buckets, you must provide the alias of the
**Access points** - When you use this action with an access point
*Amazon S3 User Guide*.
naming restrictions, see [Directory bucket naming rules] in the
amzn-s3-demo-bucket–usw2-az1–x-s3`). For information about bucket
follow the format ` bucket-base-name–zone-id–x-s3` (for example, `
the chosen Zone (Availability Zone or Local Zone). Bucket names must
requests are not supported. Directory bucket names must be unique in
Bucket-name.s3express-zone-id.region-code.amazonaws.com`. Path-style
bucket, you must use virtual-hosted-style requests in the format `
**Directory buckets** - When you use this operation with a directory
The name of the bucket that contains the object.
@!attribute [rw] bucket

class Aws::S3::Types::HeadObjectRequest

Namespace

Included Modules

Defined in