Struct rusoto_s3::HeadObjectRequest

pub struct HeadObjectRequest {
    pub bucket: String,
    pub expected_bucket_owner: Option<String>,
    pub if_match: Option<String>,
    pub if_modified_since: Option<String>,
    pub if_none_match: Option<String>,
    pub if_unmodified_since: Option<String>,
    pub key: String,
    pub part_number: Option<i64>,
    pub range: Option<String>,
    pub request_payer: Option<String>,
    pub sse_customer_algorithm: Option<String>,
    pub sse_customer_key: Option<String>,
    pub sse_customer_key_md5: Option<String>,
    pub version_id: Option<String>,
}

Fields

bucket: String

The name of the bucket 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.

expected_bucket_owner: Option<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.

if_match: Option<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: Option<String>

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

if_none_match: Option<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: Option<String>

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: Option<i64>

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.

range: Option<String>

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

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

request_payer: Option<String>

sse_customer_algorithm: Option<String>

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

sse_customer_key: Option<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.

sse_customer_key_md5: Option<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.

version_id: Option<String>

VersionId used to reference a specific version of the object.

Trait Implementations

impl Clone for HeadObjectRequest

pub fn clone(&self) -> HeadObjectRequest

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HeadObjectRequest

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for HeadObjectRequest

pub fn default() -> HeadObjectRequest

Returns the "default value" for a type.

impl PartialEq<HeadObjectRequest> for HeadObjectRequest

pub fn eq(&self, other: &HeadObjectRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &HeadObjectRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for HeadObjectRequest