Aws::S3::Model::HeadBucketRequest Class Reference

#include <HeadBucketRequest.h>

Inheritance diagram for Aws::S3::Model::HeadBucketRequest:

Public Member Functions
	HeadBucketRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
void	AddQueryStringParameters (Aws::Http::URI &uri) const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetBucket () const
bool	BucketHasBeenSet () const
void	SetBucket (const Aws::String &value)
void	SetBucket (Aws::String &&value)
void	SetBucket (const char *value)
HeadBucketRequest &	WithBucket (const Aws::String &value)
HeadBucketRequest &	WithBucket (Aws::String &&value)
HeadBucketRequest &	WithBucket (const char *value)
const Aws::String &	GetExpectedBucketOwner () const
bool	ExpectedBucketOwnerHasBeenSet () const
void	SetExpectedBucketOwner (const Aws::String &value)
void	SetExpectedBucketOwner (Aws::String &&value)
void	SetExpectedBucketOwner (const char *value)
HeadBucketRequest &	WithExpectedBucketOwner (const Aws::String &value)
HeadBucketRequest &	WithExpectedBucketOwner (Aws::String &&value)
HeadBucketRequest &	WithExpectedBucketOwner (const char *value)
const Aws::Map< Aws::String, Aws::String > &	GetCustomizedAccessLogTag () const
bool	CustomizedAccessLogTagHasBeenSet () const
void	SetCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
void	SetCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
HeadBucketRequest &	WithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
HeadBucketRequest &	WithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
HeadBucketRequest &	AddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
HeadBucketRequest &	AddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
HeadBucketRequest &	AddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
HeadBucketRequest &	AddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
HeadBucketRequest &	AddCustomizedAccessLogTag (const char *key, Aws::String &&value)
HeadBucketRequest &	AddCustomizedAccessLogTag (Aws::String &&key, const char *value)
HeadBucketRequest &	AddCustomizedAccessLogTag (const char *key, const char *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 void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () 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 void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
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

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 26 of file HeadBucketRequest.h.

Constructor & Destructor Documentation

HeadBucketRequest()

Aws::S3::Model::HeadBucketRequest::HeadBucketRequest

(

)

Member Function Documentation

AddCustomizedAccessLogTag() [1/7]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::AddCustomizedAccessLogTag ( Aws::String &&  key, Aws::String &&  value  )

inline

Definition at line 298 of file HeadBucketRequest.h.

AddCustomizedAccessLogTag() [2/7]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::AddCustomizedAccessLogTag ( Aws::String &&  key, const Aws::String &  value  )

inline

Definition at line 292 of file HeadBucketRequest.h.

AddCustomizedAccessLogTag() [3/7]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::AddCustomizedAccessLogTag ( Aws::String &&  key, const char *  value  )

inline

Definition at line 304 of file HeadBucketRequest.h.

AddCustomizedAccessLogTag() [4/7]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::AddCustomizedAccessLogTag ( const Aws::String &  key, Aws::String &&  value  )

inline

Definition at line 295 of file HeadBucketRequest.h.

AddCustomizedAccessLogTag() [5/7]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::AddCustomizedAccessLogTag ( const Aws::String &  key, const Aws::String &  value  )

inline

Definition at line 289 of file HeadBucketRequest.h.

AddCustomizedAccessLogTag() [6/7]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::AddCustomizedAccessLogTag ( const char *  key, Aws::String &&  value  )

inline

Definition at line 301 of file HeadBucketRequest.h.

AddCustomizedAccessLogTag() [7/7]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::AddCustomizedAccessLogTag ( const char *  key, const char *  value  )

inline

Definition at line 307 of file HeadBucketRequest.h.

AddQueryStringParameters()

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

overridevirtual

Do nothing virtual, override this to add query strings to the request

Reimplemented from Aws::AmazonWebServiceRequest.

BucketHasBeenSet()

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

inline

The bucket name.

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 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 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 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 S3 User Guide.

Definition at line 84 of file HeadBucketRequest.h.

CustomizedAccessLogTagHasBeenSet()

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

inline

Definition at line 274 of file HeadBucketRequest.h.

ExpectedBucketOwnerHasBeenSet()

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

inline

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.

Definition at line 225 of file HeadBucketRequest.h.

GetBucket()

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

inline

The bucket name.

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 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 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 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 S3 User Guide.

Definition at line 63 of file HeadBucketRequest.h.

GetCustomizedAccessLogTag()

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

inline

Definition at line 271 of file HeadBucketRequest.h.

GetExpectedBucketOwner()

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

inline

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.

Definition at line 218 of file HeadBucketRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3::Model::HeadBucketRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::S3::S3Request.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 35 of file HeadBucketRequest.h.

SerializePayload()

Aws::String Aws::S3::Model::HeadBucketRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetBucket() [1/3]

void Aws::S3::Model::HeadBucketRequest::SetBucket ( Aws::String &&  value )

inline

The bucket name.

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 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 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 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 S3 User Guide.

Definition at line 126 of file HeadBucketRequest.h.

SetBucket() [2/3]

void Aws::S3::Model::HeadBucketRequest::SetBucket ( const Aws::String &  value )

inline

The bucket name.

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 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 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 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 S3 User Guide.

Definition at line 105 of file HeadBucketRequest.h.

SetBucket() [3/3]

void Aws::S3::Model::HeadBucketRequest::SetBucket ( const char *  value )

inline

The bucket name.

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 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 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 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 S3 User Guide.

Definition at line 147 of file HeadBucketRequest.h.

SetCustomizedAccessLogTag() [1/2]

void Aws::S3::Model::HeadBucketRequest::SetCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value )

inline

Definition at line 280 of file HeadBucketRequest.h.

SetCustomizedAccessLogTag() [2/2]

void Aws::S3::Model::HeadBucketRequest::SetCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value )

inline

Definition at line 277 of file HeadBucketRequest.h.

SetExpectedBucketOwner() [1/3]

void Aws::S3::Model::HeadBucketRequest::SetExpectedBucketOwner ( Aws::String &&  value )

inline

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.

Definition at line 239 of file HeadBucketRequest.h.

SetExpectedBucketOwner() [2/3]

void Aws::S3::Model::HeadBucketRequest::SetExpectedBucketOwner ( const Aws::String &  value )

inline

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.

Definition at line 232 of file HeadBucketRequest.h.

SetExpectedBucketOwner() [3/3]

void Aws::S3::Model::HeadBucketRequest::SetExpectedBucketOwner ( const char *  value )

inline

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.

Definition at line 246 of file HeadBucketRequest.h.

WithBucket() [1/3]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::WithBucket ( Aws::String &&  value )

inline

The bucket name.

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 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 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 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 S3 User Guide.

Definition at line 189 of file HeadBucketRequest.h.

WithBucket() [2/3]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::WithBucket ( const Aws::String &  value )

inline

The bucket name.

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 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 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 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 S3 User Guide.

Definition at line 168 of file HeadBucketRequest.h.

WithBucket() [3/3]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::WithBucket ( const char *  value )

inline

The bucket name.

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 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 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 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 S3 User Guide.

Definition at line 210 of file HeadBucketRequest.h.

WithCustomizedAccessLogTag() [1/2]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::WithCustomizedAccessLogTag ( Aws::Map< Aws::String, Aws::String > &&  value )

inline

Definition at line 286 of file HeadBucketRequest.h.

WithCustomizedAccessLogTag() [2/2]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::WithCustomizedAccessLogTag ( const Aws::Map< Aws::String, Aws::String > &  value )

inline

Definition at line 283 of file HeadBucketRequest.h.

WithExpectedBucketOwner() [1/3]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::WithExpectedBucketOwner ( Aws::String &&  value )

inline

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.

Definition at line 260 of file HeadBucketRequest.h.

WithExpectedBucketOwner() [2/3]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::WithExpectedBucketOwner ( const Aws::String &  value )

inline

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.

Definition at line 253 of file HeadBucketRequest.h.

WithExpectedBucketOwner() [3/3]

HeadBucketRequest& Aws::S3::Model::HeadBucketRequest::WithExpectedBucketOwner ( const char *  value )

inline

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.

Definition at line 267 of file HeadBucketRequest.h.

---

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

• aws-cpp-sdk-s3/include/aws/s3/model/HeadBucketRequest.h