Struct aws_sdk_s3::input::HeadObjectInput
source · [−]#[non_exhaustive]pub struct HeadObjectInput { /* private fields */ }Implementations
sourceimpl HeadObjectInput
impl HeadObjectInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<HeadObject, AwsResponseRetryClassifier>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<HeadObject, AwsResponseRetryClassifier>, BuildError>
Consumes the builder and constructs an Operation<HeadObject>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture HeadObjectInput.
sourceimpl HeadObjectInput
impl HeadObjectInput
sourcepub fn bucket(&self) -> Option<&str>
pub fn bucket(&self) -> Option<&str>
The name of the bucket containing the object.
When using this action 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 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.
When using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.
sourcepub fn if_match(&self) -> Option<&str>
pub fn if_match(&self) -> Option<&str>
Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
sourcepub fn if_modified_since(&self) -> Option<&DateTime>
pub fn if_modified_since(&self) -> Option<&DateTime>
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
sourcepub fn if_none_match(&self) -> Option<&str>
pub fn if_none_match(&self) -> Option<&str>
Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
sourcepub fn if_unmodified_since(&self) -> Option<&DateTime>
pub fn if_unmodified_since(&self) -> Option<&DateTime>
Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
sourcepub fn range(&self) -> Option<&str>
pub fn range(&self) -> Option<&str>
Because HeadObject returns only the metadata for an object, this parameter has no effect.
sourcepub fn version_id(&self) -> Option<&str>
pub fn version_id(&self) -> Option<&str>
VersionId used to reference a specific version of the object.
sourcepub fn sse_customer_algorithm(&self) -> Option<&str>
pub fn sse_customer_algorithm(&self) -> Option<&str>
Specifies the algorithm to use to when encrypting the object (for example, AES256).
sourcepub fn sse_customer_key(&self) -> Option<&str>
pub fn sse_customer_key(&self) -> Option<&str>
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.
sourcepub fn sse_customer_key_md5(&self) -> Option<&str>
pub fn sse_customer_key_md5(&self) -> Option<&str>
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.
sourcepub fn request_payer(&self) -> Option<&RequestPayer>
pub fn request_payer(&self) -> Option<&RequestPayer>
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 Requester Pays Buckets in the Amazon S3 User Guide.
sourcepub fn part_number(&self) -> i32
pub fn part_number(&self) -> i32
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.
sourcepub fn expected_bucket_owner(&self) -> Option<&str>
pub fn expected_bucket_owner(&self) -> Option<&str>
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
sourcepub fn checksum_mode(&self) -> Option<&ChecksumMode>
pub fn checksum_mode(&self) -> Option<&ChecksumMode>
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.
Trait Implementations
sourceimpl Clone for HeadObjectInput
impl Clone for HeadObjectInput
sourcefn clone(&self) -> HeadObjectInput
fn clone(&self) -> HeadObjectInput
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read more