Aws::S3::S3Request Class Reference

#include <S3Request.h>

Inherits Aws::AmazonSerializableWebServiceRequest.

Inherited by Aws::S3::Model::AbortMultipartUploadRequest, Aws::S3::Model::CompleteMultipartUploadRequest, Aws::S3::Model::CopyObjectRequest, Aws::S3::Model::CreateBucketRequest, Aws::S3::Model::CreateMultipartUploadRequest, Aws::S3::Model::CreateSessionRequest, Aws::S3::Model::DeleteBucketAnalyticsConfigurationRequest, Aws::S3::Model::DeleteBucketCorsRequest, Aws::S3::Model::DeleteBucketEncryptionRequest, Aws::S3::Model::DeleteBucketIntelligentTieringConfigurationRequest, Aws::S3::Model::DeleteBucketInventoryConfigurationRequest, Aws::S3::Model::DeleteBucketLifecycleRequest, Aws::S3::Model::DeleteBucketMetricsConfigurationRequest, Aws::S3::Model::DeleteBucketOwnershipControlsRequest, Aws::S3::Model::DeleteBucketPolicyRequest, Aws::S3::Model::DeleteBucketReplicationRequest, Aws::S3::Model::DeleteBucketRequest, Aws::S3::Model::DeleteBucketTaggingRequest, Aws::S3::Model::DeleteBucketWebsiteRequest, Aws::S3::Model::DeleteObjectRequest, Aws::S3::Model::DeleteObjectTaggingRequest, Aws::S3::Model::DeleteObjectsRequest, Aws::S3::Model::DeletePublicAccessBlockRequest, Aws::S3::Model::GetBucketAccelerateConfigurationRequest, Aws::S3::Model::GetBucketAclRequest, Aws::S3::Model::GetBucketAnalyticsConfigurationRequest, Aws::S3::Model::GetBucketCorsRequest, Aws::S3::Model::GetBucketEncryptionRequest, Aws::S3::Model::GetBucketIntelligentTieringConfigurationRequest, Aws::S3::Model::GetBucketInventoryConfigurationRequest, Aws::S3::Model::GetBucketLifecycleConfigurationRequest, Aws::S3::Model::GetBucketLocationRequest, Aws::S3::Model::GetBucketLoggingRequest, Aws::S3::Model::GetBucketMetricsConfigurationRequest, Aws::S3::Model::GetBucketNotificationConfigurationRequest, Aws::S3::Model::GetBucketOwnershipControlsRequest, Aws::S3::Model::GetBucketPolicyRequest, Aws::S3::Model::GetBucketPolicyStatusRequest, Aws::S3::Model::GetBucketReplicationRequest, Aws::S3::Model::GetBucketRequestPaymentRequest, Aws::S3::Model::GetBucketTaggingRequest, Aws::S3::Model::GetBucketVersioningRequest, Aws::S3::Model::GetBucketWebsiteRequest, Aws::S3::Model::GetObjectAclRequest, Aws::S3::Model::GetObjectAttributesRequest, Aws::S3::Model::GetObjectLegalHoldRequest, Aws::S3::Model::GetObjectLockConfigurationRequest, Aws::S3::Model::GetObjectRequest, Aws::S3::Model::GetObjectRetentionRequest, Aws::S3::Model::GetObjectTaggingRequest, Aws::S3::Model::GetObjectTorrentRequest, Aws::S3::Model::GetPublicAccessBlockRequest, Aws::S3::Model::HeadBucketRequest, Aws::S3::Model::HeadObjectRequest, Aws::S3::Model::ListBucketAnalyticsConfigurationsRequest, Aws::S3::Model::ListBucketIntelligentTieringConfigurationsRequest, Aws::S3::Model::ListBucketInventoryConfigurationsRequest, Aws::S3::Model::ListBucketMetricsConfigurationsRequest, Aws::S3::Model::ListBucketsRequest, Aws::S3::Model::ListDirectoryBucketsRequest, Aws::S3::Model::ListMultipartUploadsRequest, Aws::S3::Model::ListObjectVersionsRequest, Aws::S3::Model::ListObjectsRequest, Aws::S3::Model::ListObjectsV2Request, Aws::S3::Model::ListPartsRequest, Aws::S3::Model::PutBucketAccelerateConfigurationRequest, Aws::S3::Model::PutBucketAclRequest, Aws::S3::Model::PutBucketAnalyticsConfigurationRequest, Aws::S3::Model::PutBucketCorsRequest, Aws::S3::Model::PutBucketEncryptionRequest, Aws::S3::Model::PutBucketIntelligentTieringConfigurationRequest, Aws::S3::Model::PutBucketInventoryConfigurationRequest, Aws::S3::Model::PutBucketLifecycleConfigurationRequest, Aws::S3::Model::PutBucketLoggingRequest, Aws::S3::Model::PutBucketMetricsConfigurationRequest, Aws::S3::Model::PutBucketNotificationConfigurationRequest, Aws::S3::Model::PutBucketOwnershipControlsRequest, Aws::S3::Model::PutBucketReplicationRequest, Aws::S3::Model::PutBucketRequestPaymentRequest, Aws::S3::Model::PutBucketTaggingRequest, Aws::S3::Model::PutBucketVersioningRequest, Aws::S3::Model::PutBucketWebsiteRequest, Aws::S3::Model::PutObjectAclRequest, Aws::S3::Model::PutObjectLegalHoldRequest, Aws::S3::Model::PutObjectLockConfigurationRequest, Aws::S3::Model::PutObjectRetentionRequest, Aws::S3::Model::PutObjectTaggingRequest, Aws::S3::Model::PutPublicAccessBlockRequest, Aws::S3::Model::RestoreObjectRequest, Aws::S3::Model::SelectObjectContentRequest, and Aws::S3::Model::UploadPartCopyRequest.

Public Types

using EndpointParameter = Aws::Endpoint::EndpointParameter

 

using EndpointParameters = Aws::Endpoint::EndpointParameters

 

Public Types inherited from Aws::AmazonWebServiceRequest

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

 

Public Member Functions

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

 

virtual Aws::String SerializePayload () const=0

 

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 AddQueryStringParameters (Aws::Http::URI &uri) const

 

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

 

virtual bool IsStreaming () const

 

virtual bool IsEventStreamRequest () const

 

virtual bool SignBody () const

 

virtual bool HasEmbeddedError (Aws::IOStream &body, const Aws::Http::HeaderValueCollection &header) 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 const char * GetServiceRequestName () const=0

 

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

 

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

 

virtual EndpointParameters GetEndpointContextParams () const

 

virtual Aws::Client::CompressionAlgorithm GetSelectedCompressionAlgorithm (Aws::Client::RequestCompressionConfig) 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)

 

Protected Member Functions

virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const

 

Protected Member Functions inherited from Aws::AmazonWebServiceRequest

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

 

Additional Inherited Members

Protected Attributes inherited from Aws::AmazonWebServiceRequest

Aws::Http::HeaderValueCollection m_additionalCustomHeaders

 

Detailed Description

Definition at line 18 of file S3Request.h.

Member Typedef Documentation

EndpointParameter

using Aws::S3::S3Request::EndpointParameter = Aws::Endpoint::EndpointParameter

Definition at line 21 of file S3Request.h.

EndpointParameters

using Aws::S3::S3Request::EndpointParameters = Aws::Endpoint::EndpointParameters

Definition at line 22 of file S3Request.h.

Constructor & Destructor Documentation

~S3Request()

virtual Aws::S3::S3Request::~S3Request ( )

inlinevirtual

Definition at line 24 of file S3Request.h.

Member Function Documentation

AddParametersToRequest()

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

inline

Definition at line 26 of file S3Request.h.

GetHeaders()

Aws::Http::HeaderValueCollection Aws::S3::S3Request::GetHeaders ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 28 of file S3Request.h.

GetRequestSpecificHeaders()

virtual Aws::Http::HeaderValueCollection Aws::S3::S3Request::GetRequestSpecificHeaders ( ) const

inlineprotectedvirtual

Reimplemented in Aws::S3::Model::AbortMultipartUploadRequest, Aws::S3::Model::CompleteMultipartUploadRequest, Aws::S3::Model::CopyObjectRequest, Aws::S3::Model::CreateBucketRequest, Aws::S3::Model::CreateMultipartUploadRequest, Aws::S3::Model::CreateSessionRequest, Aws::S3::Model::DeleteBucketAnalyticsConfigurationRequest, Aws::S3::Model::DeleteBucketCorsRequest, Aws::S3::Model::DeleteBucketEncryptionRequest, Aws::S3::Model::DeleteBucketInventoryConfigurationRequest, Aws::S3::Model::DeleteBucketLifecycleRequest, Aws::S3::Model::DeleteBucketMetricsConfigurationRequest, Aws::S3::Model::DeleteBucketOwnershipControlsRequest, Aws::S3::Model::DeleteBucketPolicyRequest, Aws::S3::Model::DeleteBucketReplicationRequest, Aws::S3::Model::DeleteBucketRequest, Aws::S3::Model::DeleteBucketTaggingRequest, Aws::S3::Model::DeleteBucketWebsiteRequest, Aws::S3::Model::DeleteObjectRequest, Aws::S3::Model::DeleteObjectsRequest, Aws::S3::Model::DeleteObjectTaggingRequest, Aws::S3::Model::DeletePublicAccessBlockRequest, Aws::S3::Model::GetBucketAccelerateConfigurationRequest, Aws::S3::Model::GetBucketAclRequest, Aws::S3::Model::GetBucketAnalyticsConfigurationRequest, Aws::S3::Model::GetBucketCorsRequest, Aws::S3::Model::GetBucketEncryptionRequest, Aws::S3::Model::GetBucketInventoryConfigurationRequest, Aws::S3::Model::GetBucketLifecycleConfigurationRequest, Aws::S3::Model::GetBucketLocationRequest, Aws::S3::Model::GetBucketLoggingRequest, Aws::S3::Model::GetBucketMetricsConfigurationRequest, Aws::S3::Model::GetBucketNotificationConfigurationRequest, Aws::S3::Model::GetBucketOwnershipControlsRequest, Aws::S3::Model::GetBucketPolicyRequest, Aws::S3::Model::GetBucketPolicyStatusRequest, Aws::S3::Model::GetBucketReplicationRequest, Aws::S3::Model::GetBucketRequestPaymentRequest, Aws::S3::Model::GetBucketTaggingRequest, Aws::S3::Model::GetBucketVersioningRequest, Aws::S3::Model::GetBucketWebsiteRequest, Aws::S3::Model::GetObjectAclRequest, Aws::S3::Model::GetObjectAttributesRequest, Aws::S3::Model::GetObjectLegalHoldRequest, Aws::S3::Model::GetObjectLockConfigurationRequest, Aws::S3::Model::GetObjectRequest, Aws::S3::Model::GetObjectRetentionRequest, Aws::S3::Model::GetObjectTaggingRequest, Aws::S3::Model::GetObjectTorrentRequest, Aws::S3::Model::GetPublicAccessBlockRequest, Aws::S3::Model::HeadBucketRequest, Aws::S3::Model::HeadObjectRequest, Aws::S3::Model::ListBucketAnalyticsConfigurationsRequest, Aws::S3::Model::ListBucketInventoryConfigurationsRequest, Aws::S3::Model::ListBucketMetricsConfigurationsRequest, Aws::S3::Model::ListMultipartUploadsRequest, Aws::S3::Model::ListObjectsRequest, Aws::S3::Model::ListObjectsV2Request, Aws::S3::Model::ListObjectVersionsRequest, Aws::S3::Model::ListPartsRequest, Aws::S3::Model::PutBucketAccelerateConfigurationRequest, Aws::S3::Model::PutBucketAclRequest, Aws::S3::Model::PutBucketAnalyticsConfigurationRequest, Aws::S3::Model::PutBucketCorsRequest, Aws::S3::Model::PutBucketEncryptionRequest, Aws::S3::Model::PutBucketInventoryConfigurationRequest, Aws::S3::Model::PutBucketLifecycleConfigurationRequest, Aws::S3::Model::PutBucketLoggingRequest, Aws::S3::Model::PutBucketMetricsConfigurationRequest, Aws::S3::Model::PutBucketNotificationConfigurationRequest, Aws::S3::Model::PutBucketOwnershipControlsRequest, Aws::S3::Model::PutBucketReplicationRequest, Aws::S3::Model::PutBucketRequestPaymentRequest, Aws::S3::Model::PutBucketTaggingRequest, Aws::S3::Model::PutBucketVersioningRequest, Aws::S3::Model::PutBucketWebsiteRequest, Aws::S3::Model::PutObjectAclRequest, Aws::S3::Model::PutObjectLegalHoldRequest, Aws::S3::Model::PutObjectLockConfigurationRequest, Aws::S3::Model::PutObjectRetentionRequest, Aws::S3::Model::PutObjectTaggingRequest, Aws::S3::Model::PutPublicAccessBlockRequest, Aws::S3::Model::RestoreObjectRequest, Aws::S3::Model::SelectObjectContentRequest, and Aws::S3::Model::UploadPartCopyRequest.

Definition at line 41 of file S3Request.h.

---

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

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