Aws::S3::Model::GetBucketWebsiteRequest Class Reference

#include <GetBucketWebsiteRequest.h>

Inheritance diagram for Aws::S3::Model::GetBucketWebsiteRequest:

Public Member Functions

AWS_S3_API GetBucketWebsiteRequest ()=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>

GetBucketWebsiteRequest & WithBucket (BucketT &&value)

 

const Aws::String & GetExpectedBucketOwner () const

 

bool ExpectedBucketOwnerHasBeenSet () const

 

template<typename ExpectedBucketOwnerT = Aws::String>

void SetExpectedBucketOwner (ExpectedBucketOwnerT &&value)

 

template<typename ExpectedBucketOwnerT = Aws::String>

GetBucketWebsiteRequest & WithExpectedBucketOwner (ExpectedBucketOwnerT &&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>>

GetBucketWebsiteRequest & WithCustomizedAccessLogTag (CustomizedAccessLogTagT &&value)

 

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

GetBucketWebsiteRequest & 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

 

RetryContext GetRetryContext () const

 

void SetRetryContext (const RetryContext &context) const

 

virtual Aws::Vector< smithy::AuthSchemeOption > GetRequestSpecificSupportedAuth () 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 23 of file GetBucketWebsiteRequest.h.

Constructor & Destructor Documentation

GetBucketWebsiteRequest()

AWS_S3_API Aws::S3::Model::GetBucketWebsiteRequest::GetBucketWebsiteRequest ( )

default

Member Function Documentation

AddCustomizedAccessLogTag()

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

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

CustomizedAccessLogTagValueT &&  value 

)

inline

Definition at line 98 of file GetBucketWebsiteRequest.h.

AddQueryStringParameters()

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

overridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

BucketHasBeenSet()

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

inline

The bucket name for which to get the website configuration.

Definition at line 50 of file GetBucketWebsiteRequest.h.

CustomizedAccessLogTagHasBeenSet()

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

inline

Definition at line 86 of file GetBucketWebsiteRequest.h.

ExpectedBucketOwnerHasBeenSet()

bool Aws::S3::Model::GetBucketWebsiteRequest::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 70 of file GetBucketWebsiteRequest.h.

GetBucket()

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

inline

The bucket name for which to get the website configuration.

Definition at line 49 of file GetBucketWebsiteRequest.h.

GetCustomizedAccessLogTag()

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

inline

Definition at line 85 of file GetBucketWebsiteRequest.h.

GetEndpointContextParams()

AWS_S3_API EndpointParameters Aws::S3::Model::GetBucketWebsiteRequest::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::GetBucketWebsiteRequest::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 69 of file GetBucketWebsiteRequest.h.

GetRequestSpecificHeaders()

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

overridevirtual

Reimplemented from Aws::S3::S3Request.

GetServiceRequestName()

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

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 31 of file GetBucketWebsiteRequest.h.

HasEmbeddedError()

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

const Http::HeaderValueCollection &  header 

) const

overridevirtual

Reimplemented from Aws::AmazonWebServiceRequest.

SerializePayload()

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

overridevirtual

Implements Aws::AmazonSerializableWebServiceRequest.

SetBucket()

template<typename BucketT = Aws::String>

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

inline

The bucket name for which to get the website configuration.

Definition at line 52 of file GetBucketWebsiteRequest.h.

SetCustomizedAccessLogTag()

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

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

inline

Definition at line 88 of file GetBucketWebsiteRequest.h.

SetExpectedBucketOwner()

template<typename ExpectedBucketOwnerT = Aws::String>

void Aws::S3::Model::GetBucketWebsiteRequest::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 72 of file GetBucketWebsiteRequest.h.

WithBucket()

template<typename BucketT = Aws::String>

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

inline

The bucket name for which to get the website configuration.

Definition at line 57 of file GetBucketWebsiteRequest.h.

WithCustomizedAccessLogTag()

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

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

inline

Definition at line 93 of file GetBucketWebsiteRequest.h.

WithExpectedBucketOwner()

template<typename ExpectedBucketOwnerT = Aws::String>

GetBucketWebsiteRequest & Aws::S3::Model::GetBucketWebsiteRequest::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 77 of file GetBucketWebsiteRequest.h.

---

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

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