Aws::S3::Model::HeadObjectRequest Class Reference

#include <HeadObjectRequest.h>

Inheritance diagram for Aws::S3::Model::HeadObjectRequest:

Public Member Functions

AWS_S3_API HeadObjectRequest ()=default

 

virtual const char * GetServiceRequestName () const override

 

AWS_S3_API Aws::String SerializePayload () const override

 

AWS_S3_API void AddQueryStringParameters (Aws::Http::URI &uri) const override

 

AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override

 

AWS_S3_API bool HasEmbeddedError (IOStream &body, const Http::HeaderValueCollection &header) const override

 

AWS_S3_API EndpointParameters GetEndpointContextParams () const override

 

const Aws::String & GetBucket () const

 

bool BucketHasBeenSet () const

 

template<typename BucketT = Aws::String>

void SetBucket (BucketT &&value)

 

template<typename BucketT = Aws::String>

HeadObjectRequest & WithBucket (BucketT &&value)

 

const Aws::String & GetIfMatch () const

 

bool IfMatchHasBeenSet () const

 

template<typename IfMatchT = Aws::String>

void SetIfMatch (IfMatchT &&value)

 

template<typename IfMatchT = Aws::String>

HeadObjectRequest & WithIfMatch (IfMatchT &&value)

 

const Aws::Utils::DateTime & GetIfModifiedSince () const

 

bool IfModifiedSinceHasBeenSet () const

 

template<typename IfModifiedSinceT = Aws::Utils::DateTime>

void SetIfModifiedSince (IfModifiedSinceT &&value)

 

template<typename IfModifiedSinceT = Aws::Utils::DateTime>

HeadObjectRequest & WithIfModifiedSince (IfModifiedSinceT &&value)

 

const Aws::String & GetIfNoneMatch () const

 

bool IfNoneMatchHasBeenSet () const

 

template<typename IfNoneMatchT = Aws::String>

void SetIfNoneMatch (IfNoneMatchT &&value)

 

template<typename IfNoneMatchT = Aws::String>

HeadObjectRequest & WithIfNoneMatch (IfNoneMatchT &&value)

 

const Aws::Utils::DateTime & GetIfUnmodifiedSince () const

 

bool IfUnmodifiedSinceHasBeenSet () const

 

template<typename IfUnmodifiedSinceT = Aws::Utils::DateTime>

void SetIfUnmodifiedSince (IfUnmodifiedSinceT &&value)

 

template<typename IfUnmodifiedSinceT = Aws::Utils::DateTime>

HeadObjectRequest & WithIfUnmodifiedSince (IfUnmodifiedSinceT &&value)

 

const Aws::String & GetKey () const

 

bool KeyHasBeenSet () const

 

template<typename KeyT = Aws::String>

void SetKey (KeyT &&value)

 

template<typename KeyT = Aws::String>

HeadObjectRequest & WithKey (KeyT &&value)

 

const Aws::String & GetRange () const

 

bool RangeHasBeenSet () const

 

template<typename RangeT = Aws::String>

void SetRange (RangeT &&value)

 

template<typename RangeT = Aws::String>

HeadObjectRequest & WithRange (RangeT &&value)

 

const Aws::String & GetResponseCacheControl () const

 

bool ResponseCacheControlHasBeenSet () const

 

template<typename ResponseCacheControlT = Aws::String>

void SetResponseCacheControl (ResponseCacheControlT &&value)

 

template<typename ResponseCacheControlT = Aws::String>

HeadObjectRequest & WithResponseCacheControl (ResponseCacheControlT &&value)

 

const Aws::String & GetResponseContentDisposition () const

 

bool ResponseContentDispositionHasBeenSet () const

 

template<typename ResponseContentDispositionT = Aws::String>

void SetResponseContentDisposition (ResponseContentDispositionT &&value)

 

template<typename ResponseContentDispositionT = Aws::String>

HeadObjectRequest & WithResponseContentDisposition (ResponseContentDispositionT &&value)

 

const Aws::String & GetResponseContentEncoding () const

 

bool ResponseContentEncodingHasBeenSet () const

 

template<typename ResponseContentEncodingT = Aws::String>

void SetResponseContentEncoding (ResponseContentEncodingT &&value)

 

template<typename ResponseContentEncodingT = Aws::String>

HeadObjectRequest & WithResponseContentEncoding (ResponseContentEncodingT &&value)

 

const Aws::String & GetResponseContentLanguage () const

 

bool ResponseContentLanguageHasBeenSet () const

 

template<typename ResponseContentLanguageT = Aws::String>

void SetResponseContentLanguage (ResponseContentLanguageT &&value)

 

template<typename ResponseContentLanguageT = Aws::String>

HeadObjectRequest & WithResponseContentLanguage (ResponseContentLanguageT &&value)

 

const Aws::String & GetResponseContentType () const

 

bool ResponseContentTypeHasBeenSet () const

 

template<typename ResponseContentTypeT = Aws::String>

void SetResponseContentType (ResponseContentTypeT &&value)

 

template<typename ResponseContentTypeT = Aws::String>

HeadObjectRequest & WithResponseContentType (ResponseContentTypeT &&value)

 

const Aws::Utils::DateTime & GetResponseExpires () const

 

bool ResponseExpiresHasBeenSet () const

 

template<typename ResponseExpiresT = Aws::Utils::DateTime>

void SetResponseExpires (ResponseExpiresT &&value)

 

template<typename ResponseExpiresT = Aws::Utils::DateTime>

HeadObjectRequest & WithResponseExpires (ResponseExpiresT &&value)

 

const Aws::String & GetVersionId () const

 

bool VersionIdHasBeenSet () const

 

template<typename VersionIdT = Aws::String>

void SetVersionId (VersionIdT &&value)

 

template<typename VersionIdT = Aws::String>

HeadObjectRequest & WithVersionId (VersionIdT &&value)

 

const Aws::String & GetSSECustomerAlgorithm () const

 

bool SSECustomerAlgorithmHasBeenSet () const

 

template<typename SSECustomerAlgorithmT = Aws::String>

void SetSSECustomerAlgorithm (SSECustomerAlgorithmT &&value)

 

template<typename SSECustomerAlgorithmT = Aws::String>

HeadObjectRequest & WithSSECustomerAlgorithm (SSECustomerAlgorithmT &&value)

 

const Aws::String & GetSSECustomerKey () const

 

bool SSECustomerKeyHasBeenSet () const

 

template<typename SSECustomerKeyT = Aws::String>

void SetSSECustomerKey (SSECustomerKeyT &&value)

 

template<typename SSECustomerKeyT = Aws::String>

HeadObjectRequest & WithSSECustomerKey (SSECustomerKeyT &&value)

 

const Aws::String & GetSSECustomerKeyMD5 () const

 

bool SSECustomerKeyMD5HasBeenSet () const

 

template<typename SSECustomerKeyMD5T = Aws::String>

void SetSSECustomerKeyMD5 (SSECustomerKeyMD5T &&value)

 

template<typename SSECustomerKeyMD5T = Aws::String>

HeadObjectRequest & WithSSECustomerKeyMD5 (SSECustomerKeyMD5T &&value)

 

RequestPayer GetRequestPayer () const

 

bool RequestPayerHasBeenSet () const

 

void SetRequestPayer (RequestPayer value)

 

HeadObjectRequest & WithRequestPayer (RequestPayer value)

 

int GetPartNumber () const

 

bool PartNumberHasBeenSet () const

 

void SetPartNumber (int value)

 

HeadObjectRequest & WithPartNumber (int value)

 

const Aws::String & GetExpectedBucketOwner () const

 

bool ExpectedBucketOwnerHasBeenSet () const

 

template<typename ExpectedBucketOwnerT = Aws::String>

void SetExpectedBucketOwner (ExpectedBucketOwnerT &&value)

 

template<typename ExpectedBucketOwnerT = Aws::String>

HeadObjectRequest & WithExpectedBucketOwner (ExpectedBucketOwnerT &&value)

 

ChecksumMode GetChecksumMode () const

 

bool ChecksumModeHasBeenSet () const

 

void SetChecksumMode (ChecksumMode value)

 

HeadObjectRequest & WithChecksumMode (ChecksumMode value)

 

const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag () const

 

bool CustomizedAccessLogTagHasBeenSet () const

 

template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>

void SetCustomizedAccessLogTag (CustomizedAccessLogTagT &&value)

 

template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>

HeadObjectRequest & WithCustomizedAccessLogTag (CustomizedAccessLogTagT &&value)

 

template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>

HeadObjectRequest & AddCustomizedAccessLogTag (CustomizedAccessLogTagKeyT &&key, CustomizedAccessLogTagValueT &&value)

 

Public Member Functions inherited from Aws::S3::S3Request

virtual ~S3Request ()

 

void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const

 

Aws::Http::HeaderValueCollection GetHeaders () const override

 

Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest

 AmazonSerializableWebServiceRequest ()

 

virtual ~AmazonSerializableWebServiceRequest ()

 

std::shared_ptr< Aws::IOStream > GetBody () const override

 

Public Member Functions inherited from Aws::AmazonWebServiceRequest

 AmazonWebServiceRequest ()

 

virtual ~AmazonWebServiceRequest ()=default

 

virtual const Aws::Http::HeaderValueCollection & GetAdditionalCustomHeaders () const

 

virtual void SetAdditionalCustomHeaderValue (const Aws::String &headerName, const Aws::String &headerValue)

 

virtual void PutToPresignedUrl (Aws::Http::URI &uri) const

 

virtual bool IsStreaming () const

 

virtual bool IsEventStreamRequest () const

 

virtual bool HasEventStreamResponse () const

 

virtual bool SignBody () const

 

virtual bool IsChunked () const

 

virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)

 

virtual const RequestSignedHandler & GetRequestSignedHandler () const

 

const Aws::IOStreamFactory & GetResponseStreamFactory () const

 

void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)

 

virtual const Aws::Http::HeadersReceivedEventHandler & GetHeadersReceivedEventHandler () const

 

virtual const Aws::Http::DataReceivedEventHandler & GetDataReceivedEventHandler () const

 

virtual const Aws::Http::DataSentEventHandler & GetDataSentEventHandler () const

 

virtual const Aws::Http::ContinueRequestHandler & GetContinueRequestHandler () const

 

virtual const RequestRetryHandler & GetRequestRetryHandler () const

 

virtual bool ShouldComputeContentMd5 () const

 

virtual bool ShouldValidateResponseChecksum () const

 

virtual Aws::Vector< Aws::String > GetResponseChecksumAlgorithmNames () const

 

virtual Aws::String GetChecksumAlgorithmName () const

 

virtual void SetServiceSpecificParameters (const std::shared_ptr< Http::ServiceSpecificParameters > &serviceSpecificParameters) const

 

virtual std::shared_ptr< Http::ServiceSpecificParameters > GetServiceSpecificParameters () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) const

 

void AddUserAgentFeature (Aws::Client::UserAgentFeature feature) const

 

Aws::Set< Aws::Client::UserAgentFeature > GetUserAgentFeatures () const

 

virtual bool RequestChecksumRequired () const

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

virtual void SetHeadersReceivedEventHandler (const Aws::Http::HeadersReceivedEventHandler &headersReceivedEventHandler)

 

virtual void SetHeadersReceivedEventHandler (Aws::Http::HeadersReceivedEventHandler &&headersReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)

 

virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)

 

virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)

 

virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)

 

virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)

 

virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)

 

virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)

 

virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)

 

Additional Inherited Members

Public Types inherited from Aws::S3::S3Request

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

typedef Aws::Vector< Aws::Endpoint::EndpointParameter > EndpointParameters

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

virtual void DumpBodyToUrl (Aws::Http::URI &uri) const

 

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 29 of file HeadObjectRequest.h.

Constructor & Destructor Documentation

HeadObjectRequest()

AWS_S3_API Aws::S3::Model::HeadObjectRequest::HeadObjectRequest ( )

default

Member Function Documentation

AddCustomizedAccessLogTag()

template<typename CustomizedAccessLogTagKeyT = Aws::String, typename CustomizedAccessLogTagValueT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::AddCustomizedAccessLogTag ( CustomizedAccessLogTagKeyT &&  key,

CustomizedAccessLogTagValueT &&  value 

)

inline

Definition at line 399 of file HeadObjectRequest.h.

AddQueryStringParameters()

AWS_S3_API void Aws::S3::Model::HeadObjectRequest::AddQueryStringParameters ( Aws::Http::URI &  uri) const

overridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

BucketHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::BucketHasBeenSet ( ) const

inline

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-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name–zone-id–x-s3 (for example, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Definition at line 89 of file HeadObjectRequest.h.

ChecksumModeHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::ChecksumModeHasBeenSet ( ) const

inline

To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Definition at line 385 of file HeadObjectRequest.h.

CustomizedAccessLogTagHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::CustomizedAccessLogTagHasBeenSet ( ) const

inline

Definition at line 393 of file HeadObjectRequest.h.

ExpectedBucketOwnerHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::ExpectedBucketOwnerHasBeenSet ( ) const

inline

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).

Definition at line 363 of file HeadObjectRequest.h.

GetBucket()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetBucket ( ) const

inline

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-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name–zone-id–x-s3 (for example, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Definition at line 88 of file HeadObjectRequest.h.

GetChecksumMode()

ChecksumMode Aws::S3::Model::HeadObjectRequest::GetChecksumMode ( ) const

inline

To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Definition at line 384 of file HeadObjectRequest.h.

GetCustomizedAccessLogTag()

const Aws::Map< Aws::String, Aws::String > & Aws::S3::Model::HeadObjectRequest::GetCustomizedAccessLogTag ( ) const

inline

Definition at line 392 of file HeadObjectRequest.h.

GetEndpointContextParams()

AWS_S3_API EndpointParameters Aws::S3::Model::HeadObjectRequest::GetEndpointContextParams ( ) const

overridevirtual

Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation.

Reimplemented from Aws::AmazonWebServiceRequest.

GetExpectedBucketOwner()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetExpectedBucketOwner ( ) const

inline

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).

Definition at line 362 of file HeadObjectRequest.h.

GetIfMatch()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetIfMatch ( ) const

inline

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 to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Definition at line 108 of file HeadObjectRequest.h.

GetIfModifiedSince()

const Aws::Utils::DateTime & Aws::S3::Model::HeadObjectRequest::GetIfModifiedSince ( ) const

inline

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 to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Definition at line 128 of file HeadObjectRequest.h.

GetIfNoneMatch()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetIfNoneMatch ( ) const

inline

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 to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Definition at line 148 of file HeadObjectRequest.h.

GetIfUnmodifiedSince()

const Aws::Utils::DateTime & Aws::S3::Model::HeadObjectRequest::GetIfUnmodifiedSince ( ) const

inline

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 to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Definition at line 168 of file HeadObjectRequest.h.

GetKey()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetKey ( ) const

inline

The object key.

Definition at line 180 of file HeadObjectRequest.h.

GetPartNumber()

int Aws::S3::Model::HeadObjectRequest::GetPartNumber ( ) const

inline

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.

Definition at line 350 of file HeadObjectRequest.h.

GetRange()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetRange ( ) const

inline

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.

Definition at line 195 of file HeadObjectRequest.h.

GetRequestPayer()

RequestPayer Aws::S3::Model::HeadObjectRequest::GetRequestPayer ( ) const

inline

Definition at line 337 of file HeadObjectRequest.h.

GetRequestSpecificHeaders()

AWS_S3_API Aws::Http::HeaderValueCollection Aws::S3::Model::HeadObjectRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::S3::S3Request.

GetResponseCacheControl()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetResponseCacheControl ( ) const

inline

Sets the Cache-Control header of the response.

Definition at line 207 of file HeadObjectRequest.h.

GetResponseContentDisposition()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetResponseContentDisposition ( ) const

inline

Sets the Content-Disposition header of the response.

Definition at line 219 of file HeadObjectRequest.h.

GetResponseContentEncoding()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetResponseContentEncoding ( ) const

inline

Sets the Content-Encoding header of the response.

Definition at line 231 of file HeadObjectRequest.h.

GetResponseContentLanguage()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetResponseContentLanguage ( ) const

inline

Sets the Content-Language header of the response.

Definition at line 243 of file HeadObjectRequest.h.

GetResponseContentType()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetResponseContentType ( ) const

inline

Sets the Content-Type header of the response.

Definition at line 255 of file HeadObjectRequest.h.

GetResponseExpires()

const Aws::Utils::DateTime & Aws::S3::Model::HeadObjectRequest::GetResponseExpires ( ) const

inline

Sets the Expires header of the response.

Definition at line 267 of file HeadObjectRequest.h.

GetServiceRequestName()

virtual const char * Aws::S3::Model::HeadObjectRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 38 of file HeadObjectRequest.h.

GetSSECustomerAlgorithm()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetSSECustomerAlgorithm ( ) const

inline

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

This functionality is not supported for directory buckets.

Definition at line 295 of file HeadObjectRequest.h.

GetSSECustomerKey()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetSSECustomerKey ( ) const

inline

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.

This functionality is not supported for directory buckets.

Definition at line 312 of file HeadObjectRequest.h.

GetSSECustomerKeyMD5()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetSSECustomerKeyMD5 ( ) const

inline

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.

This functionality is not supported for directory buckets.

Definition at line 327 of file HeadObjectRequest.h.

GetVersionId()

const Aws::String & Aws::S3::Model::HeadObjectRequest::GetVersionId ( ) const

inline

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

Definition at line 281 of file HeadObjectRequest.h.

HasEmbeddedError()

AWS_S3_API bool Aws::S3::Model::HeadObjectRequest::HasEmbeddedError ( IOStream &  body,

const Http::HeaderValueCollection &  header 

) const

overridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

IfMatchHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::IfMatchHasBeenSet ( ) const

inline

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 to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Definition at line 109 of file HeadObjectRequest.h.

IfModifiedSinceHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::IfModifiedSinceHasBeenSet ( ) const

inline

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 to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Definition at line 129 of file HeadObjectRequest.h.

IfNoneMatchHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::IfNoneMatchHasBeenSet ( ) const

inline

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 to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Definition at line 149 of file HeadObjectRequest.h.

IfUnmodifiedSinceHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::IfUnmodifiedSinceHasBeenSet ( ) const

inline

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 to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Definition at line 169 of file HeadObjectRequest.h.

KeyHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::KeyHasBeenSet ( ) const

inline

The object key.

Definition at line 181 of file HeadObjectRequest.h.

PartNumberHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::PartNumberHasBeenSet ( ) const

inline

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.

Definition at line 351 of file HeadObjectRequest.h.

RangeHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::RangeHasBeenSet ( ) const

inline

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.

Definition at line 196 of file HeadObjectRequest.h.

RequestPayerHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::RequestPayerHasBeenSet ( ) const

inline

Definition at line 338 of file HeadObjectRequest.h.

ResponseCacheControlHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::ResponseCacheControlHasBeenSet ( ) const

inline

Sets the Cache-Control header of the response.

Definition at line 208 of file HeadObjectRequest.h.

ResponseContentDispositionHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::ResponseContentDispositionHasBeenSet ( ) const

inline

Sets the Content-Disposition header of the response.

Definition at line 220 of file HeadObjectRequest.h.

ResponseContentEncodingHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::ResponseContentEncodingHasBeenSet ( ) const

inline

Sets the Content-Encoding header of the response.

Definition at line 232 of file HeadObjectRequest.h.

ResponseContentLanguageHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::ResponseContentLanguageHasBeenSet ( ) const

inline

Sets the Content-Language header of the response.

Definition at line 244 of file HeadObjectRequest.h.

ResponseContentTypeHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::ResponseContentTypeHasBeenSet ( ) const

inline

Sets the Content-Type header of the response.

Definition at line 256 of file HeadObjectRequest.h.

ResponseExpiresHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::ResponseExpiresHasBeenSet ( ) const

inline

Sets the Expires header of the response.

Definition at line 268 of file HeadObjectRequest.h.

SerializePayload()

AWS_S3_API Aws::String Aws::S3::Model::HeadObjectRequest::SerializePayload ( ) const

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetBucket()

template<typename BucketT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetBucket ( BucketT &&  value)

inline

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-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name–zone-id–x-s3 (for example, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Definition at line 91 of file HeadObjectRequest.h.

SetChecksumMode()

void Aws::S3::Model::HeadObjectRequest::SetChecksumMode ( ChecksumMode  value)

inline

To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Definition at line 386 of file HeadObjectRequest.h.

SetCustomizedAccessLogTag()

template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>

void Aws::S3::Model::HeadObjectRequest::SetCustomizedAccessLogTag ( CustomizedAccessLogTagT &&  value)

inline

Definition at line 395 of file HeadObjectRequest.h.

SetExpectedBucketOwner()

template<typename ExpectedBucketOwnerT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetExpectedBucketOwner ( ExpectedBucketOwnerT &&  value)

inline

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).

Definition at line 365 of file HeadObjectRequest.h.

SetIfMatch()

template<typename IfMatchT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetIfMatch ( IfMatchT &&  value)

inline

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 to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Definition at line 111 of file HeadObjectRequest.h.

SetIfModifiedSince()

template<typename IfModifiedSinceT = Aws::Utils::DateTime>

void Aws::S3::Model::HeadObjectRequest::SetIfModifiedSince ( IfModifiedSinceT &&  value)

inline

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 to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Definition at line 131 of file HeadObjectRequest.h.

SetIfNoneMatch()

template<typename IfNoneMatchT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetIfNoneMatch ( IfNoneMatchT &&  value)

inline

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 to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Definition at line 151 of file HeadObjectRequest.h.

SetIfUnmodifiedSince()

template<typename IfUnmodifiedSinceT = Aws::Utils::DateTime>

void Aws::S3::Model::HeadObjectRequest::SetIfUnmodifiedSince ( IfUnmodifiedSinceT &&  value)

inline

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 to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Definition at line 171 of file HeadObjectRequest.h.

SetKey()

template<typename KeyT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetKey ( KeyT &&  value)

inline

The object key.

Definition at line 183 of file HeadObjectRequest.h.

SetPartNumber()

void Aws::S3::Model::HeadObjectRequest::SetPartNumber ( int  value)

inline

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.

Definition at line 352 of file HeadObjectRequest.h.

SetRange()

template<typename RangeT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetRange ( RangeT &&  value)

inline

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.

Definition at line 198 of file HeadObjectRequest.h.

SetRequestPayer()

void Aws::S3::Model::HeadObjectRequest::SetRequestPayer ( RequestPayer  value)

inline

Definition at line 339 of file HeadObjectRequest.h.

SetResponseCacheControl()

template<typename ResponseCacheControlT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetResponseCacheControl ( ResponseCacheControlT &&  value)

inline

Sets the Cache-Control header of the response.

Definition at line 210 of file HeadObjectRequest.h.

SetResponseContentDisposition()

template<typename ResponseContentDispositionT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetResponseContentDisposition ( ResponseContentDispositionT &&  value)

inline

Sets the Content-Disposition header of the response.

Definition at line 222 of file HeadObjectRequest.h.

SetResponseContentEncoding()

template<typename ResponseContentEncodingT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetResponseContentEncoding ( ResponseContentEncodingT &&  value)

inline

Sets the Content-Encoding header of the response.

Definition at line 234 of file HeadObjectRequest.h.

SetResponseContentLanguage()

template<typename ResponseContentLanguageT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetResponseContentLanguage ( ResponseContentLanguageT &&  value)

inline

Sets the Content-Language header of the response.

Definition at line 246 of file HeadObjectRequest.h.

SetResponseContentType()

template<typename ResponseContentTypeT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetResponseContentType ( ResponseContentTypeT &&  value)

inline

Sets the Content-Type header of the response.

Definition at line 258 of file HeadObjectRequest.h.

SetResponseExpires()

template<typename ResponseExpiresT = Aws::Utils::DateTime>

void Aws::S3::Model::HeadObjectRequest::SetResponseExpires ( ResponseExpiresT &&  value)

inline

Sets the Expires header of the response.

Definition at line 270 of file HeadObjectRequest.h.

SetSSECustomerAlgorithm()

template<typename SSECustomerAlgorithmT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetSSECustomerAlgorithm ( SSECustomerAlgorithmT &&  value)

inline

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

This functionality is not supported for directory buckets.

Definition at line 298 of file HeadObjectRequest.h.

SetSSECustomerKey()

template<typename SSECustomerKeyT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetSSECustomerKey ( SSECustomerKeyT &&  value)

inline

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.

This functionality is not supported for directory buckets.

Definition at line 315 of file HeadObjectRequest.h.

SetSSECustomerKeyMD5()

template<typename SSECustomerKeyMD5T = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetSSECustomerKeyMD5 ( SSECustomerKeyMD5T &&  value)

inline

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.

This functionality is not supported for directory buckets.

Definition at line 330 of file HeadObjectRequest.h.

SetVersionId()

template<typename VersionIdT = Aws::String>

void Aws::S3::Model::HeadObjectRequest::SetVersionId ( VersionIdT &&  value)

inline

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

Definition at line 284 of file HeadObjectRequest.h.

SSECustomerAlgorithmHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::SSECustomerAlgorithmHasBeenSet ( ) const

inline

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

This functionality is not supported for directory buckets.

Definition at line 296 of file HeadObjectRequest.h.

SSECustomerKeyHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::SSECustomerKeyHasBeenSet ( ) const

inline

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.

This functionality is not supported for directory buckets.

Definition at line 313 of file HeadObjectRequest.h.

SSECustomerKeyMD5HasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::SSECustomerKeyMD5HasBeenSet ( ) const

inline

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.

This functionality is not supported for directory buckets.

Definition at line 328 of file HeadObjectRequest.h.

VersionIdHasBeenSet()

bool Aws::S3::Model::HeadObjectRequest::VersionIdHasBeenSet ( ) const

inline

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

Definition at line 282 of file HeadObjectRequest.h.

WithBucket()

template<typename BucketT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithBucket ( BucketT &&  value)

inline

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-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name–zone-id–x-s3 (for example, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Definition at line 93 of file HeadObjectRequest.h.

WithChecksumMode()

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithChecksumMode ( ChecksumMode  value)

inline

To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Definition at line 387 of file HeadObjectRequest.h.

WithCustomizedAccessLogTag()

template<typename CustomizedAccessLogTagT = Aws::Map<Aws::String, Aws::String>>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithCustomizedAccessLogTag ( CustomizedAccessLogTagT &&  value)

inline

Definition at line 397 of file HeadObjectRequest.h.

WithExpectedBucketOwner()

template<typename ExpectedBucketOwnerT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithExpectedBucketOwner ( ExpectedBucketOwnerT &&  value)

inline

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).

Definition at line 367 of file HeadObjectRequest.h.

WithIfMatch()

template<typename IfMatchT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithIfMatch ( IfMatchT &&  value)

inline

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 to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Definition at line 113 of file HeadObjectRequest.h.

WithIfModifiedSince()

template<typename IfModifiedSinceT = Aws::Utils::DateTime>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithIfModifiedSince ( IfModifiedSinceT &&  value)

inline

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 to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Definition at line 133 of file HeadObjectRequest.h.

WithIfNoneMatch()

template<typename IfNoneMatchT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithIfNoneMatch ( IfNoneMatchT &&  value)

inline

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 to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Definition at line 153 of file HeadObjectRequest.h.

WithIfUnmodifiedSince()

template<typename IfUnmodifiedSinceT = Aws::Utils::DateTime>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithIfUnmodifiedSince ( IfUnmodifiedSinceT &&  value)

inline

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 to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Definition at line 173 of file HeadObjectRequest.h.

WithKey()

template<typename KeyT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithKey ( KeyT &&  value)

inline

The object key.

Definition at line 185 of file HeadObjectRequest.h.

WithPartNumber()

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithPartNumber ( int  value)

inline

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.

Definition at line 353 of file HeadObjectRequest.h.

WithRange()

template<typename RangeT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithRange ( RangeT &&  value)

inline

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.

Definition at line 200 of file HeadObjectRequest.h.

WithRequestPayer()

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithRequestPayer ( RequestPayer  value)

inline

Definition at line 340 of file HeadObjectRequest.h.

WithResponseCacheControl()

template<typename ResponseCacheControlT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithResponseCacheControl ( ResponseCacheControlT &&  value)

inline

Sets the Cache-Control header of the response.

Definition at line 212 of file HeadObjectRequest.h.

WithResponseContentDisposition()

template<typename ResponseContentDispositionT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithResponseContentDisposition ( ResponseContentDispositionT &&  value)

inline

Sets the Content-Disposition header of the response.

Definition at line 224 of file HeadObjectRequest.h.

WithResponseContentEncoding()

template<typename ResponseContentEncodingT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithResponseContentEncoding ( ResponseContentEncodingT &&  value)

inline

Sets the Content-Encoding header of the response.

Definition at line 236 of file HeadObjectRequest.h.

WithResponseContentLanguage()

template<typename ResponseContentLanguageT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithResponseContentLanguage ( ResponseContentLanguageT &&  value)

inline

Sets the Content-Language header of the response.

Definition at line 248 of file HeadObjectRequest.h.

WithResponseContentType()

template<typename ResponseContentTypeT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithResponseContentType ( ResponseContentTypeT &&  value)

inline

Sets the Content-Type header of the response.

Definition at line 260 of file HeadObjectRequest.h.

WithResponseExpires()

template<typename ResponseExpiresT = Aws::Utils::DateTime>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithResponseExpires ( ResponseExpiresT &&  value)

inline

Sets the Expires header of the response.

Definition at line 272 of file HeadObjectRequest.h.

WithSSECustomerAlgorithm()

template<typename SSECustomerAlgorithmT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithSSECustomerAlgorithm ( SSECustomerAlgorithmT &&  value)

inline

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

This functionality is not supported for directory buckets.

Definition at line 300 of file HeadObjectRequest.h.

WithSSECustomerKey()

template<typename SSECustomerKeyT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithSSECustomerKey ( SSECustomerKeyT &&  value)

inline

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.

This functionality is not supported for directory buckets.

Definition at line 317 of file HeadObjectRequest.h.

WithSSECustomerKeyMD5()

template<typename SSECustomerKeyMD5T = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithSSECustomerKeyMD5 ( SSECustomerKeyMD5T &&  value)

inline

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.

This functionality is not supported for directory buckets.

Definition at line 332 of file HeadObjectRequest.h.

WithVersionId()

template<typename VersionIdT = Aws::String>

HeadObjectRequest & Aws::S3::Model::HeadObjectRequest::WithVersionId ( VersionIdT &&  value)

inline

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

Definition at line 286 of file HeadObjectRequest.h.

---

The documentation for this class was generated from the following file:

• generated/src/aws-cpp-sdk-s3/include/aws/s3/model/HeadObjectRequest.h