AWS SDK for C++  1.8.22
AWS SDK for C++
Public Member Functions | List of all members
Aws::S3::Model::PutObjectRequest Class Reference

#include <PutObjectRequest.h>

+ Inheritance diagram for Aws::S3::Model::PutObjectRequest:

Public Member Functions

 PutObjectRequest ()
 
virtual const char * GetServiceRequestName () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const ObjectCannedACLGetACL () const
 
bool ACLHasBeenSet () const
 
void SetACL (const ObjectCannedACL &value)
 
void SetACL (ObjectCannedACL &&value)
 
PutObjectRequestWithACL (const ObjectCannedACL &value)
 
PutObjectRequestWithACL (ObjectCannedACL &&value)
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
PutObjectRequestWithBucket (const Aws::String &value)
 
PutObjectRequestWithBucket (Aws::String &&value)
 
PutObjectRequestWithBucket (const char *value)
 
const Aws::StringGetCacheControl () const
 
bool CacheControlHasBeenSet () const
 
void SetCacheControl (const Aws::String &value)
 
void SetCacheControl (Aws::String &&value)
 
void SetCacheControl (const char *value)
 
PutObjectRequestWithCacheControl (const Aws::String &value)
 
PutObjectRequestWithCacheControl (Aws::String &&value)
 
PutObjectRequestWithCacheControl (const char *value)
 
const Aws::StringGetContentDisposition () const
 
bool ContentDispositionHasBeenSet () const
 
void SetContentDisposition (const Aws::String &value)
 
void SetContentDisposition (Aws::String &&value)
 
void SetContentDisposition (const char *value)
 
PutObjectRequestWithContentDisposition (const Aws::String &value)
 
PutObjectRequestWithContentDisposition (Aws::String &&value)
 
PutObjectRequestWithContentDisposition (const char *value)
 
const Aws::StringGetContentEncoding () const
 
bool ContentEncodingHasBeenSet () const
 
void SetContentEncoding (const Aws::String &value)
 
void SetContentEncoding (Aws::String &&value)
 
void SetContentEncoding (const char *value)
 
PutObjectRequestWithContentEncoding (const Aws::String &value)
 
PutObjectRequestWithContentEncoding (Aws::String &&value)
 
PutObjectRequestWithContentEncoding (const char *value)
 
const Aws::StringGetContentLanguage () const
 
bool ContentLanguageHasBeenSet () const
 
void SetContentLanguage (const Aws::String &value)
 
void SetContentLanguage (Aws::String &&value)
 
void SetContentLanguage (const char *value)
 
PutObjectRequestWithContentLanguage (const Aws::String &value)
 
PutObjectRequestWithContentLanguage (Aws::String &&value)
 
PutObjectRequestWithContentLanguage (const char *value)
 
long long GetContentLength () const
 
bool ContentLengthHasBeenSet () const
 
void SetContentLength (long long value)
 
PutObjectRequestWithContentLength (long long value)
 
const Aws::StringGetContentMD5 () const
 
bool ContentMD5HasBeenSet () const
 
void SetContentMD5 (const Aws::String &value)
 
void SetContentMD5 (Aws::String &&value)
 
void SetContentMD5 (const char *value)
 
PutObjectRequestWithContentMD5 (const Aws::String &value)
 
PutObjectRequestWithContentMD5 (Aws::String &&value)
 
PutObjectRequestWithContentMD5 (const char *value)
 
const Aws::Utils::DateTimeGetExpires () const
 
bool ExpiresHasBeenSet () const
 
void SetExpires (const Aws::Utils::DateTime &value)
 
void SetExpires (Aws::Utils::DateTime &&value)
 
PutObjectRequestWithExpires (const Aws::Utils::DateTime &value)
 
PutObjectRequestWithExpires (Aws::Utils::DateTime &&value)
 
const Aws::StringGetGrantFullControl () const
 
bool GrantFullControlHasBeenSet () const
 
void SetGrantFullControl (const Aws::String &value)
 
void SetGrantFullControl (Aws::String &&value)
 
void SetGrantFullControl (const char *value)
 
PutObjectRequestWithGrantFullControl (const Aws::String &value)
 
PutObjectRequestWithGrantFullControl (Aws::String &&value)
 
PutObjectRequestWithGrantFullControl (const char *value)
 
const Aws::StringGetGrantRead () const
 
bool GrantReadHasBeenSet () const
 
void SetGrantRead (const Aws::String &value)
 
void SetGrantRead (Aws::String &&value)
 
void SetGrantRead (const char *value)
 
PutObjectRequestWithGrantRead (const Aws::String &value)
 
PutObjectRequestWithGrantRead (Aws::String &&value)
 
PutObjectRequestWithGrantRead (const char *value)
 
const Aws::StringGetGrantReadACP () const
 
bool GrantReadACPHasBeenSet () const
 
void SetGrantReadACP (const Aws::String &value)
 
void SetGrantReadACP (Aws::String &&value)
 
void SetGrantReadACP (const char *value)
 
PutObjectRequestWithGrantReadACP (const Aws::String &value)
 
PutObjectRequestWithGrantReadACP (Aws::String &&value)
 
PutObjectRequestWithGrantReadACP (const char *value)
 
const Aws::StringGetGrantWriteACP () const
 
bool GrantWriteACPHasBeenSet () const
 
void SetGrantWriteACP (const Aws::String &value)
 
void SetGrantWriteACP (Aws::String &&value)
 
void SetGrantWriteACP (const char *value)
 
PutObjectRequestWithGrantWriteACP (const Aws::String &value)
 
PutObjectRequestWithGrantWriteACP (Aws::String &&value)
 
PutObjectRequestWithGrantWriteACP (const char *value)
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
PutObjectRequestWithKey (const Aws::String &value)
 
PutObjectRequestWithKey (Aws::String &&value)
 
PutObjectRequestWithKey (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetMetadata () const
 
bool MetadataHasBeenSet () const
 
void SetMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
PutObjectRequestWithMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
PutObjectRequestWithMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
PutObjectRequestAddMetadata (const Aws::String &key, const Aws::String &value)
 
PutObjectRequestAddMetadata (Aws::String &&key, const Aws::String &value)
 
PutObjectRequestAddMetadata (const Aws::String &key, Aws::String &&value)
 
PutObjectRequestAddMetadata (Aws::String &&key, Aws::String &&value)
 
PutObjectRequestAddMetadata (const char *key, Aws::String &&value)
 
PutObjectRequestAddMetadata (Aws::String &&key, const char *value)
 
PutObjectRequestAddMetadata (const char *key, const char *value)
 
const ServerSideEncryptionGetServerSideEncryption () const
 
bool ServerSideEncryptionHasBeenSet () const
 
void SetServerSideEncryption (const ServerSideEncryption &value)
 
void SetServerSideEncryption (ServerSideEncryption &&value)
 
PutObjectRequestWithServerSideEncryption (const ServerSideEncryption &value)
 
PutObjectRequestWithServerSideEncryption (ServerSideEncryption &&value)
 
const StorageClassGetStorageClass () const
 
bool StorageClassHasBeenSet () const
 
void SetStorageClass (const StorageClass &value)
 
void SetStorageClass (StorageClass &&value)
 
PutObjectRequestWithStorageClass (const StorageClass &value)
 
PutObjectRequestWithStorageClass (StorageClass &&value)
 
const Aws::StringGetWebsiteRedirectLocation () const
 
bool WebsiteRedirectLocationHasBeenSet () const
 
void SetWebsiteRedirectLocation (const Aws::String &value)
 
void SetWebsiteRedirectLocation (Aws::String &&value)
 
void SetWebsiteRedirectLocation (const char *value)
 
PutObjectRequestWithWebsiteRedirectLocation (const Aws::String &value)
 
PutObjectRequestWithWebsiteRedirectLocation (Aws::String &&value)
 
PutObjectRequestWithWebsiteRedirectLocation (const char *value)
 
const Aws::StringGetSSECustomerAlgorithm () const
 
bool SSECustomerAlgorithmHasBeenSet () const
 
void SetSSECustomerAlgorithm (const Aws::String &value)
 
void SetSSECustomerAlgorithm (Aws::String &&value)
 
void SetSSECustomerAlgorithm (const char *value)
 
PutObjectRequestWithSSECustomerAlgorithm (const Aws::String &value)
 
PutObjectRequestWithSSECustomerAlgorithm (Aws::String &&value)
 
PutObjectRequestWithSSECustomerAlgorithm (const char *value)
 
const Aws::StringGetSSECustomerKey () const
 
bool SSECustomerKeyHasBeenSet () const
 
void SetSSECustomerKey (const Aws::String &value)
 
void SetSSECustomerKey (Aws::String &&value)
 
void SetSSECustomerKey (const char *value)
 
PutObjectRequestWithSSECustomerKey (const Aws::String &value)
 
PutObjectRequestWithSSECustomerKey (Aws::String &&value)
 
PutObjectRequestWithSSECustomerKey (const char *value)
 
const Aws::StringGetSSECustomerKeyMD5 () const
 
bool SSECustomerKeyMD5HasBeenSet () const
 
void SetSSECustomerKeyMD5 (const Aws::String &value)
 
void SetSSECustomerKeyMD5 (Aws::String &&value)
 
void SetSSECustomerKeyMD5 (const char *value)
 
PutObjectRequestWithSSECustomerKeyMD5 (const Aws::String &value)
 
PutObjectRequestWithSSECustomerKeyMD5 (Aws::String &&value)
 
PutObjectRequestWithSSECustomerKeyMD5 (const char *value)
 
const Aws::StringGetSSEKMSKeyId () const
 
bool SSEKMSKeyIdHasBeenSet () const
 
void SetSSEKMSKeyId (const Aws::String &value)
 
void SetSSEKMSKeyId (Aws::String &&value)
 
void SetSSEKMSKeyId (const char *value)
 
PutObjectRequestWithSSEKMSKeyId (const Aws::String &value)
 
PutObjectRequestWithSSEKMSKeyId (Aws::String &&value)
 
PutObjectRequestWithSSEKMSKeyId (const char *value)
 
const Aws::StringGetSSEKMSEncryptionContext () const
 
bool SSEKMSEncryptionContextHasBeenSet () const
 
void SetSSEKMSEncryptionContext (const Aws::String &value)
 
void SetSSEKMSEncryptionContext (Aws::String &&value)
 
void SetSSEKMSEncryptionContext (const char *value)
 
PutObjectRequestWithSSEKMSEncryptionContext (const Aws::String &value)
 
PutObjectRequestWithSSEKMSEncryptionContext (Aws::String &&value)
 
PutObjectRequestWithSSEKMSEncryptionContext (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
PutObjectRequestWithRequestPayer (const RequestPayer &value)
 
PutObjectRequestWithRequestPayer (RequestPayer &&value)
 
const Aws::StringGetTagging () const
 
bool TaggingHasBeenSet () const
 
void SetTagging (const Aws::String &value)
 
void SetTagging (Aws::String &&value)
 
void SetTagging (const char *value)
 
PutObjectRequestWithTagging (const Aws::String &value)
 
PutObjectRequestWithTagging (Aws::String &&value)
 
PutObjectRequestWithTagging (const char *value)
 
const ObjectLockModeGetObjectLockMode () const
 
bool ObjectLockModeHasBeenSet () const
 
void SetObjectLockMode (const ObjectLockMode &value)
 
void SetObjectLockMode (ObjectLockMode &&value)
 
PutObjectRequestWithObjectLockMode (const ObjectLockMode &value)
 
PutObjectRequestWithObjectLockMode (ObjectLockMode &&value)
 
const Aws::Utils::DateTimeGetObjectLockRetainUntilDate () const
 
bool ObjectLockRetainUntilDateHasBeenSet () const
 
void SetObjectLockRetainUntilDate (const Aws::Utils::DateTime &value)
 
void SetObjectLockRetainUntilDate (Aws::Utils::DateTime &&value)
 
PutObjectRequestWithObjectLockRetainUntilDate (const Aws::Utils::DateTime &value)
 
PutObjectRequestWithObjectLockRetainUntilDate (Aws::Utils::DateTime &&value)
 
const ObjectLockLegalHoldStatusGetObjectLockLegalHoldStatus () const
 
bool ObjectLockLegalHoldStatusHasBeenSet () const
 
void SetObjectLockLegalHoldStatus (const ObjectLockLegalHoldStatus &value)
 
void SetObjectLockLegalHoldStatus (ObjectLockLegalHoldStatus &&value)
 
PutObjectRequestWithObjectLockLegalHoldStatus (const ObjectLockLegalHoldStatus &value)
 
PutObjectRequestWithObjectLockLegalHoldStatus (ObjectLockLegalHoldStatus &&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)
 
PutObjectRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
PutObjectRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
PutObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
PutObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
PutObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
PutObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
PutObjectRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
PutObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
PutObjectRequestAddCustomizedAccessLogTag (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::AmazonStreamingWebServiceRequest
 AmazonStreamingWebServiceRequest ()
 
virtual ~AmazonStreamingWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
void SetBody (const std::shared_ptr< Aws::IOStream > &body)
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
bool IsStreaming () const override
 
const Aws::StringGetContentType () const
 
void SetContentType (const Aws::String &contentType)
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () 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::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () 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 34 of file PutObjectRequest.h.

Constructor & Destructor Documentation

◆ PutObjectRequest()

Aws::S3::Model::PutObjectRequest::PutObjectRequest ( )

Member Function Documentation

◆ ACLHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ACLHasBeenSet ( ) const
inline

The canned ACL to apply to the object. For more information, see Canned ACL.

Definition at line 62 of file PutObjectRequest.h.

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 1648 of file PutObjectRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 1651 of file PutObjectRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 1654 of file PutObjectRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 1657 of file PutObjectRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 1660 of file PutObjectRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 1663 of file PutObjectRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 1666 of file PutObjectRequest.h.

◆ AddMetadata() [1/7]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::AddMetadata ( const Aws::String key,
const Aws::String value 
)
inline

A map of metadata to store with the object in S3.

Definition at line 833 of file PutObjectRequest.h.

◆ AddMetadata() [2/7]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::AddMetadata ( Aws::String &&  key,
const Aws::String value 
)
inline

A map of metadata to store with the object in S3.

Definition at line 838 of file PutObjectRequest.h.

◆ AddMetadata() [3/7]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::AddMetadata ( const Aws::String key,
Aws::String &&  value 
)
inline

A map of metadata to store with the object in S3.

Definition at line 843 of file PutObjectRequest.h.

◆ AddMetadata() [4/7]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::AddMetadata ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A map of metadata to store with the object in S3.

Definition at line 848 of file PutObjectRequest.h.

◆ AddMetadata() [5/7]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::AddMetadata ( const char *  key,
Aws::String &&  value 
)
inline

A map of metadata to store with the object in S3.

Definition at line 853 of file PutObjectRequest.h.

◆ AddMetadata() [6/7]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::AddMetadata ( Aws::String &&  key,
const char *  value 
)
inline

A map of metadata to store with the object in S3.

Definition at line 858 of file PutObjectRequest.h.

◆ AddMetadata() [7/7]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::AddMetadata ( const char *  key,
const char *  value 
)
inline

A map of metadata to store with the object in S3.

Definition at line 863 of file PutObjectRequest.h.

◆ AddQueryStringParameters()

void Aws::S3::Model::PutObjectRequest::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::PutObjectRequest::BucketHasBeenSet ( ) const
inline

Bucket name to which the PUT operation was initiated.

When using this API 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 operation using 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 Simple Storage Service Developer Guide.

Definition at line 119 of file PutObjectRequest.h.

◆ CacheControlHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::CacheControlHasBeenSet ( ) const
inline

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Definition at line 218 of file PutObjectRequest.h.

◆ ContentDispositionHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ContentDispositionHasBeenSet ( ) const
inline

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

Definition at line 275 of file PutObjectRequest.h.

◆ ContentEncodingHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ContentEncodingHasBeenSet ( ) const
inline

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Definition at line 334 of file PutObjectRequest.h.

◆ ContentLanguageHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ContentLanguageHasBeenSet ( ) const
inline

The language the content is in.

Definition at line 393 of file PutObjectRequest.h.

◆ ContentLengthHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ContentLengthHasBeenSet ( ) const
inline

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

Definition at line 438 of file PutObjectRequest.h.

◆ ContentMD5HasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ContentMD5HasBeenSet ( ) const
inline

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

Definition at line 475 of file PutObjectRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::CustomizedAccessLogTagHasBeenSet ( ) const
inline

Definition at line 1633 of file PutObjectRequest.h.

◆ ExpiresHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ExpiresHasBeenSet ( ) const
inline

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

Definition at line 556 of file PutObjectRequest.h.

◆ GetACL()

const ObjectCannedACL& Aws::S3::Model::PutObjectRequest::GetACL ( ) const
inline

The canned ACL to apply to the object. For more information, see Canned ACL.

Definition at line 55 of file PutObjectRequest.h.

◆ GetBucket()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetBucket ( ) const
inline

Bucket name to which the PUT operation was initiated.

When using this API 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 operation using 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 Simple Storage Service Developer Guide.

Definition at line 105 of file PutObjectRequest.h.

◆ GetCacheControl()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetCacheControl ( ) const
inline

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Definition at line 211 of file PutObjectRequest.h.

◆ GetContentDisposition()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetContentDisposition ( ) const
inline

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

Definition at line 268 of file PutObjectRequest.h.

◆ GetContentEncoding()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetContentEncoding ( ) const
inline

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Definition at line 326 of file PutObjectRequest.h.

◆ GetContentLanguage()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetContentLanguage ( ) const
inline

The language the content is in.

Definition at line 388 of file PutObjectRequest.h.

◆ GetContentLength()

long long Aws::S3::Model::PutObjectRequest::GetContentLength ( ) const
inline

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

Definition at line 431 of file PutObjectRequest.h.

◆ GetContentMD5()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetContentMD5 ( ) const
inline

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

Definition at line 464 of file PutObjectRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 1630 of file PutObjectRequest.h.

◆ GetExpires()

const Aws::Utils::DateTime& Aws::S3::Model::PutObjectRequest::GetExpires ( ) const
inline

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

Definition at line 549 of file PutObjectRequest.h.

◆ GetGrantFullControl()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetGrantFullControl ( ) const
inline

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Definition at line 591 of file PutObjectRequest.h.

◆ GetGrantRead()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetGrantRead ( ) const
inline

Allows grantee to read the object data and its metadata.

Definition at line 639 of file PutObjectRequest.h.

◆ GetGrantReadACP()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetGrantReadACP ( ) const
inline

Allows grantee to read the object ACL.

Definition at line 680 of file PutObjectRequest.h.

◆ GetGrantWriteACP()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetGrantWriteACP ( ) const
inline

Allows grantee to write the ACL for the applicable object.

Definition at line 721 of file PutObjectRequest.h.

◆ GetKey()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetKey ( ) const
inline

Object key for which the PUT operation was initiated.

Definition at line 762 of file PutObjectRequest.h.

◆ GetMetadata()

const Aws::Map<Aws::String, Aws::String>& Aws::S3::Model::PutObjectRequest::GetMetadata ( ) const
inline

A map of metadata to store with the object in S3.

Definition at line 803 of file PutObjectRequest.h.

◆ GetObjectLockLegalHoldStatus()

const ObjectLockLegalHoldStatus& Aws::S3::Model::PutObjectRequest::GetObjectLockLegalHoldStatus ( ) const
inline

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

Definition at line 1586 of file PutObjectRequest.h.

◆ GetObjectLockMode()

const ObjectLockMode& Aws::S3::Model::PutObjectRequest::GetObjectLockMode ( ) const
inline

The Object Lock mode that you want to apply to this object.

Definition at line 1521 of file PutObjectRequest.h.

◆ GetObjectLockRetainUntilDate()

const Aws::Utils::DateTime& Aws::S3::Model::PutObjectRequest::GetObjectLockRetainUntilDate ( ) const
inline

The date and time when you want this object's Object Lock to expire.

Definition at line 1552 of file PutObjectRequest.h.

◆ GetRequestPayer()

const RequestPayer& Aws::S3::Model::PutObjectRequest::GetRequestPayer ( ) const
inline

Definition at line 1451 of file PutObjectRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::S3::Model::PutObjectRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Override this method to put data members from a subclass into the headers collection.

Reimplemented from Aws::AmazonStreamingWebServiceRequest.

◆ GetServerSideEncryption()

const ServerSideEncryption& Aws::S3::Model::PutObjectRequest::GetServerSideEncryption ( ) const
inline

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Definition at line 870 of file PutObjectRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::S3::Model::PutObjectRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 43 of file PutObjectRequest.h.

◆ GetSSECustomerAlgorithm()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetSSECustomerAlgorithm ( ) const
inline

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

Definition at line 1105 of file PutObjectRequest.h.

◆ GetSSECustomerKey()

const Aws::String& Aws::S3::Model::PutObjectRequest::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.

Definition at line 1157 of file PutObjectRequest.h.

◆ GetSSECustomerKeyMD5()

const Aws::String& Aws::S3::Model::PutObjectRequest::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.

Definition at line 1228 of file PutObjectRequest.h.

◆ GetSSEKMSEncryptionContext()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetSSEKMSEncryptionContext ( ) const
inline

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Definition at line 1398 of file PutObjectRequest.h.

◆ GetSSEKMSKeyId()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetSSEKMSKeyId ( ) const
inline

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Definition at line 1292 of file PutObjectRequest.h.

◆ GetStorageClass()

const StorageClass& Aws::S3::Model::PutObjectRequest::GetStorageClass ( ) const
inline

If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.

Definition at line 907 of file PutObjectRequest.h.

◆ GetTagging()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetTagging ( ) const
inline

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

Definition at line 1473 of file PutObjectRequest.h.

◆ GetWebsiteRedirectLocation()

const Aws::String& Aws::S3::Model::PutObjectRequest::GetWebsiteRedirectLocation ( ) const
inline

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

Definition at line 958 of file PutObjectRequest.h.

◆ GrantFullControlHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::GrantFullControlHasBeenSet ( ) const
inline

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Definition at line 597 of file PutObjectRequest.h.

◆ GrantReadACPHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::GrantReadACPHasBeenSet ( ) const
inline

Allows grantee to read the object ACL.

Definition at line 685 of file PutObjectRequest.h.

◆ GrantReadHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::GrantReadHasBeenSet ( ) const
inline

Allows grantee to read the object data and its metadata.

Definition at line 644 of file PutObjectRequest.h.

◆ GrantWriteACPHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::GrantWriteACPHasBeenSet ( ) const
inline

Allows grantee to write the ACL for the applicable object.

Definition at line 726 of file PutObjectRequest.h.

◆ KeyHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::KeyHasBeenSet ( ) const
inline

Object key for which the PUT operation was initiated.

Definition at line 767 of file PutObjectRequest.h.

◆ MetadataHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::MetadataHasBeenSet ( ) const
inline

A map of metadata to store with the object in S3.

Definition at line 808 of file PutObjectRequest.h.

◆ ObjectLockLegalHoldStatusHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ObjectLockLegalHoldStatusHasBeenSet ( ) const
inline

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

Definition at line 1594 of file PutObjectRequest.h.

◆ ObjectLockModeHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ObjectLockModeHasBeenSet ( ) const
inline

The Object Lock mode that you want to apply to this object.

Definition at line 1526 of file PutObjectRequest.h.

◆ ObjectLockRetainUntilDateHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ObjectLockRetainUntilDateHasBeenSet ( ) const
inline

The date and time when you want this object's Object Lock to expire.

Definition at line 1557 of file PutObjectRequest.h.

◆ RequestPayerHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::RequestPayerHasBeenSet ( ) const
inline

Definition at line 1454 of file PutObjectRequest.h.

◆ ServerSideEncryptionHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::ServerSideEncryptionHasBeenSet ( ) const
inline

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Definition at line 876 of file PutObjectRequest.h.

◆ SetACL() [1/2]

void Aws::S3::Model::PutObjectRequest::SetACL ( const ObjectCannedACL value)
inline

The canned ACL to apply to the object. For more information, see Canned ACL.

Definition at line 69 of file PutObjectRequest.h.

◆ SetACL() [2/2]

void Aws::S3::Model::PutObjectRequest::SetACL ( ObjectCannedACL &&  value)
inline

The canned ACL to apply to the object. For more information, see Canned ACL.

Definition at line 76 of file PutObjectRequest.h.

◆ SetBucket() [1/3]

void Aws::S3::Model::PutObjectRequest::SetBucket ( const Aws::String value)
inline

Bucket name to which the PUT operation was initiated.

When using this API 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 operation using 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 Simple Storage Service Developer Guide.

Definition at line 133 of file PutObjectRequest.h.

◆ SetBucket() [2/3]

void Aws::S3::Model::PutObjectRequest::SetBucket ( Aws::String &&  value)
inline

Bucket name to which the PUT operation was initiated.

When using this API 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 operation using 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 Simple Storage Service Developer Guide.

Definition at line 147 of file PutObjectRequest.h.

◆ SetBucket() [3/3]

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

Bucket name to which the PUT operation was initiated.

When using this API 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 operation using 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 Simple Storage Service Developer Guide.

Definition at line 161 of file PutObjectRequest.h.

◆ SetCacheControl() [1/3]

void Aws::S3::Model::PutObjectRequest::SetCacheControl ( const Aws::String value)
inline

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Definition at line 225 of file PutObjectRequest.h.

◆ SetCacheControl() [2/3]

void Aws::S3::Model::PutObjectRequest::SetCacheControl ( Aws::String &&  value)
inline

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Definition at line 232 of file PutObjectRequest.h.

◆ SetCacheControl() [3/3]

void Aws::S3::Model::PutObjectRequest::SetCacheControl ( const char *  value)
inline

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Definition at line 239 of file PutObjectRequest.h.

◆ SetContentDisposition() [1/3]

void Aws::S3::Model::PutObjectRequest::SetContentDisposition ( const Aws::String value)
inline

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

Definition at line 282 of file PutObjectRequest.h.

◆ SetContentDisposition() [2/3]

void Aws::S3::Model::PutObjectRequest::SetContentDisposition ( Aws::String &&  value)
inline

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

Definition at line 289 of file PutObjectRequest.h.

◆ SetContentDisposition() [3/3]

void Aws::S3::Model::PutObjectRequest::SetContentDisposition ( const char *  value)
inline

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

Definition at line 296 of file PutObjectRequest.h.

◆ SetContentEncoding() [1/3]

void Aws::S3::Model::PutObjectRequest::SetContentEncoding ( const Aws::String value)
inline

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Definition at line 342 of file PutObjectRequest.h.

◆ SetContentEncoding() [2/3]

void Aws::S3::Model::PutObjectRequest::SetContentEncoding ( Aws::String &&  value)
inline

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Definition at line 350 of file PutObjectRequest.h.

◆ SetContentEncoding() [3/3]

void Aws::S3::Model::PutObjectRequest::SetContentEncoding ( const char *  value)
inline

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Definition at line 358 of file PutObjectRequest.h.

◆ SetContentLanguage() [1/3]

void Aws::S3::Model::PutObjectRequest::SetContentLanguage ( const Aws::String value)
inline

The language the content is in.

Definition at line 398 of file PutObjectRequest.h.

◆ SetContentLanguage() [2/3]

void Aws::S3::Model::PutObjectRequest::SetContentLanguage ( Aws::String &&  value)
inline

The language the content is in.

Definition at line 403 of file PutObjectRequest.h.

◆ SetContentLanguage() [3/3]

void Aws::S3::Model::PutObjectRequest::SetContentLanguage ( const char *  value)
inline

The language the content is in.

Definition at line 408 of file PutObjectRequest.h.

◆ SetContentLength()

void Aws::S3::Model::PutObjectRequest::SetContentLength ( long long  value)
inline

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

Definition at line 445 of file PutObjectRequest.h.

◆ SetContentMD5() [1/3]

void Aws::S3::Model::PutObjectRequest::SetContentMD5 ( const Aws::String value)
inline

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

Definition at line 486 of file PutObjectRequest.h.

◆ SetContentMD5() [2/3]

void Aws::S3::Model::PutObjectRequest::SetContentMD5 ( Aws::String &&  value)
inline

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

Definition at line 497 of file PutObjectRequest.h.

◆ SetContentMD5() [3/3]

void Aws::S3::Model::PutObjectRequest::SetContentMD5 ( const char *  value)
inline

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

Definition at line 508 of file PutObjectRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 1636 of file PutObjectRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 1639 of file PutObjectRequest.h.

◆ SetExpires() [1/2]

void Aws::S3::Model::PutObjectRequest::SetExpires ( const Aws::Utils::DateTime value)
inline

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

Definition at line 563 of file PutObjectRequest.h.

◆ SetExpires() [2/2]

void Aws::S3::Model::PutObjectRequest::SetExpires ( Aws::Utils::DateTime &&  value)
inline

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

Definition at line 570 of file PutObjectRequest.h.

◆ SetGrantFullControl() [1/3]

void Aws::S3::Model::PutObjectRequest::SetGrantFullControl ( const Aws::String value)
inline

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Definition at line 603 of file PutObjectRequest.h.

◆ SetGrantFullControl() [2/3]

void Aws::S3::Model::PutObjectRequest::SetGrantFullControl ( Aws::String &&  value)
inline

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Definition at line 609 of file PutObjectRequest.h.

◆ SetGrantFullControl() [3/3]

void Aws::S3::Model::PutObjectRequest::SetGrantFullControl ( const char *  value)
inline

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Definition at line 615 of file PutObjectRequest.h.

◆ SetGrantRead() [1/3]

void Aws::S3::Model::PutObjectRequest::SetGrantRead ( const Aws::String value)
inline

Allows grantee to read the object data and its metadata.

Definition at line 649 of file PutObjectRequest.h.

◆ SetGrantRead() [2/3]

void Aws::S3::Model::PutObjectRequest::SetGrantRead ( Aws::String &&  value)
inline

Allows grantee to read the object data and its metadata.

Definition at line 654 of file PutObjectRequest.h.

◆ SetGrantRead() [3/3]

void Aws::S3::Model::PutObjectRequest::SetGrantRead ( const char *  value)
inline

Allows grantee to read the object data and its metadata.

Definition at line 659 of file PutObjectRequest.h.

◆ SetGrantReadACP() [1/3]

void Aws::S3::Model::PutObjectRequest::SetGrantReadACP ( const Aws::String value)
inline

Allows grantee to read the object ACL.

Definition at line 690 of file PutObjectRequest.h.

◆ SetGrantReadACP() [2/3]

void Aws::S3::Model::PutObjectRequest::SetGrantReadACP ( Aws::String &&  value)
inline

Allows grantee to read the object ACL.

Definition at line 695 of file PutObjectRequest.h.

◆ SetGrantReadACP() [3/3]

void Aws::S3::Model::PutObjectRequest::SetGrantReadACP ( const char *  value)
inline

Allows grantee to read the object ACL.

Definition at line 700 of file PutObjectRequest.h.

◆ SetGrantWriteACP() [1/3]

void Aws::S3::Model::PutObjectRequest::SetGrantWriteACP ( const Aws::String value)
inline

Allows grantee to write the ACL for the applicable object.

Definition at line 731 of file PutObjectRequest.h.

◆ SetGrantWriteACP() [2/3]

void Aws::S3::Model::PutObjectRequest::SetGrantWriteACP ( Aws::String &&  value)
inline

Allows grantee to write the ACL for the applicable object.

Definition at line 736 of file PutObjectRequest.h.

◆ SetGrantWriteACP() [3/3]

void Aws::S3::Model::PutObjectRequest::SetGrantWriteACP ( const char *  value)
inline

Allows grantee to write the ACL for the applicable object.

Definition at line 741 of file PutObjectRequest.h.

◆ SetKey() [1/3]

void Aws::S3::Model::PutObjectRequest::SetKey ( const Aws::String value)
inline

Object key for which the PUT operation was initiated.

Definition at line 772 of file PutObjectRequest.h.

◆ SetKey() [2/3]

void Aws::S3::Model::PutObjectRequest::SetKey ( Aws::String &&  value)
inline

Object key for which the PUT operation was initiated.

Definition at line 777 of file PutObjectRequest.h.

◆ SetKey() [3/3]

void Aws::S3::Model::PutObjectRequest::SetKey ( const char *  value)
inline

Object key for which the PUT operation was initiated.

Definition at line 782 of file PutObjectRequest.h.

◆ SetMetadata() [1/2]

void Aws::S3::Model::PutObjectRequest::SetMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of metadata to store with the object in S3.

Definition at line 813 of file PutObjectRequest.h.

◆ SetMetadata() [2/2]

void Aws::S3::Model::PutObjectRequest::SetMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of metadata to store with the object in S3.

Definition at line 818 of file PutObjectRequest.h.

◆ SetObjectLockLegalHoldStatus() [1/2]

void Aws::S3::Model::PutObjectRequest::SetObjectLockLegalHoldStatus ( const ObjectLockLegalHoldStatus value)
inline

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

Definition at line 1602 of file PutObjectRequest.h.

◆ SetObjectLockLegalHoldStatus() [2/2]

void Aws::S3::Model::PutObjectRequest::SetObjectLockLegalHoldStatus ( ObjectLockLegalHoldStatus &&  value)
inline

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

Definition at line 1610 of file PutObjectRequest.h.

◆ SetObjectLockMode() [1/2]

void Aws::S3::Model::PutObjectRequest::SetObjectLockMode ( const ObjectLockMode value)
inline

The Object Lock mode that you want to apply to this object.

Definition at line 1531 of file PutObjectRequest.h.

◆ SetObjectLockMode() [2/2]

void Aws::S3::Model::PutObjectRequest::SetObjectLockMode ( ObjectLockMode &&  value)
inline

The Object Lock mode that you want to apply to this object.

Definition at line 1536 of file PutObjectRequest.h.

◆ SetObjectLockRetainUntilDate() [1/2]

void Aws::S3::Model::PutObjectRequest::SetObjectLockRetainUntilDate ( const Aws::Utils::DateTime value)
inline

The date and time when you want this object's Object Lock to expire.

Definition at line 1562 of file PutObjectRequest.h.

◆ SetObjectLockRetainUntilDate() [2/2]

void Aws::S3::Model::PutObjectRequest::SetObjectLockRetainUntilDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when you want this object's Object Lock to expire.

Definition at line 1567 of file PutObjectRequest.h.

◆ SetRequestPayer() [1/2]

void Aws::S3::Model::PutObjectRequest::SetRequestPayer ( const RequestPayer value)
inline

Definition at line 1457 of file PutObjectRequest.h.

◆ SetRequestPayer() [2/2]

void Aws::S3::Model::PutObjectRequest::SetRequestPayer ( RequestPayer &&  value)
inline

Definition at line 1460 of file PutObjectRequest.h.

◆ SetServerSideEncryption() [1/2]

void Aws::S3::Model::PutObjectRequest::SetServerSideEncryption ( const ServerSideEncryption value)
inline

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Definition at line 882 of file PutObjectRequest.h.

◆ SetServerSideEncryption() [2/2]

void Aws::S3::Model::PutObjectRequest::SetServerSideEncryption ( ServerSideEncryption &&  value)
inline

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Definition at line 888 of file PutObjectRequest.h.

◆ SetSSECustomerAlgorithm() [1/3]

void Aws::S3::Model::PutObjectRequest::SetSSECustomerAlgorithm ( const Aws::String value)
inline

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

Definition at line 1117 of file PutObjectRequest.h.

◆ SetSSECustomerAlgorithm() [2/3]

void Aws::S3::Model::PutObjectRequest::SetSSECustomerAlgorithm ( Aws::String &&  value)
inline

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

Definition at line 1123 of file PutObjectRequest.h.

◆ SetSSECustomerAlgorithm() [3/3]

void Aws::S3::Model::PutObjectRequest::SetSSECustomerAlgorithm ( const char *  value)
inline

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

Definition at line 1129 of file PutObjectRequest.h.

◆ SetSSECustomerKey() [1/3]

void Aws::S3::Model::PutObjectRequest::SetSSECustomerKey ( const Aws::String 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.

Definition at line 1175 of file PutObjectRequest.h.

◆ SetSSECustomerKey() [2/3]

void Aws::S3::Model::PutObjectRequest::SetSSECustomerKey ( Aws::String &&  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.

Definition at line 1184 of file PutObjectRequest.h.

◆ SetSSECustomerKey() [3/3]

void Aws::S3::Model::PutObjectRequest::SetSSECustomerKey ( const char *  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.

Definition at line 1193 of file PutObjectRequest.h.

◆ SetSSECustomerKeyMD5() [1/3]

void Aws::S3::Model::PutObjectRequest::SetSSECustomerKeyMD5 ( const Aws::String 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.

Definition at line 1242 of file PutObjectRequest.h.

◆ SetSSECustomerKeyMD5() [2/3]

void Aws::S3::Model::PutObjectRequest::SetSSECustomerKeyMD5 ( Aws::String &&  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.

Definition at line 1249 of file PutObjectRequest.h.

◆ SetSSECustomerKeyMD5() [3/3]

void Aws::S3::Model::PutObjectRequest::SetSSECustomerKeyMD5 ( const char *  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.

Definition at line 1256 of file PutObjectRequest.h.

◆ SetSSEKMSEncryptionContext() [1/3]

void Aws::S3::Model::PutObjectRequest::SetSSEKMSEncryptionContext ( const Aws::String value)
inline

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Definition at line 1412 of file PutObjectRequest.h.

◆ SetSSEKMSEncryptionContext() [2/3]

void Aws::S3::Model::PutObjectRequest::SetSSEKMSEncryptionContext ( Aws::String &&  value)
inline

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Definition at line 1419 of file PutObjectRequest.h.

◆ SetSSEKMSEncryptionContext() [3/3]

void Aws::S3::Model::PutObjectRequest::SetSSEKMSEncryptionContext ( const char *  value)
inline

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Definition at line 1426 of file PutObjectRequest.h.

◆ SetSSEKMSKeyId() [1/3]

void Aws::S3::Model::PutObjectRequest::SetSSEKMSKeyId ( const Aws::String value)
inline

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Definition at line 1320 of file PutObjectRequest.h.

◆ SetSSEKMSKeyId() [2/3]

void Aws::S3::Model::PutObjectRequest::SetSSEKMSKeyId ( Aws::String &&  value)
inline

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Definition at line 1334 of file PutObjectRequest.h.

◆ SetSSEKMSKeyId() [3/3]

void Aws::S3::Model::PutObjectRequest::SetSSEKMSKeyId ( const char *  value)
inline

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Definition at line 1348 of file PutObjectRequest.h.

◆ SetStorageClass() [1/2]

void Aws::S3::Model::PutObjectRequest::SetStorageClass ( const StorageClass value)
inline

If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.

Definition at line 919 of file PutObjectRequest.h.

◆ SetStorageClass() [2/2]

void Aws::S3::Model::PutObjectRequest::SetStorageClass ( StorageClass &&  value)
inline

If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.

Definition at line 925 of file PutObjectRequest.h.

◆ SetTagging() [1/3]

void Aws::S3::Model::PutObjectRequest::SetTagging ( const Aws::String value)
inline

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

Definition at line 1485 of file PutObjectRequest.h.

◆ SetTagging() [2/3]

void Aws::S3::Model::PutObjectRequest::SetTagging ( Aws::String &&  value)
inline

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

Definition at line 1491 of file PutObjectRequest.h.

◆ SetTagging() [3/3]

void Aws::S3::Model::PutObjectRequest::SetTagging ( const char *  value)
inline

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

Definition at line 1497 of file PutObjectRequest.h.

◆ SetWebsiteRedirectLocation() [1/3]

void Aws::S3::Model::PutObjectRequest::SetWebsiteRedirectLocation ( const Aws::String value)
inline

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

Definition at line 998 of file PutObjectRequest.h.

◆ SetWebsiteRedirectLocation() [2/3]

void Aws::S3::Model::PutObjectRequest::SetWebsiteRedirectLocation ( Aws::String &&  value)
inline

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

Definition at line 1018 of file PutObjectRequest.h.

◆ SetWebsiteRedirectLocation() [3/3]

void Aws::S3::Model::PutObjectRequest::SetWebsiteRedirectLocation ( const char *  value)
inline

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

Definition at line 1038 of file PutObjectRequest.h.

◆ SSECustomerAlgorithmHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::SSECustomerAlgorithmHasBeenSet ( ) const
inline

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

Definition at line 1111 of file PutObjectRequest.h.

◆ SSECustomerKeyHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::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.

Definition at line 1166 of file PutObjectRequest.h.

◆ SSECustomerKeyMD5HasBeenSet()

bool Aws::S3::Model::PutObjectRequest::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.

Definition at line 1235 of file PutObjectRequest.h.

◆ SSEKMSEncryptionContextHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::SSEKMSEncryptionContextHasBeenSet ( ) const
inline

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Definition at line 1405 of file PutObjectRequest.h.

◆ SSEKMSKeyIdHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::SSEKMSKeyIdHasBeenSet ( ) const
inline

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Definition at line 1306 of file PutObjectRequest.h.

◆ StorageClassHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::StorageClassHasBeenSet ( ) const
inline

If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.

Definition at line 913 of file PutObjectRequest.h.

◆ TaggingHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::TaggingHasBeenSet ( ) const
inline

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

Definition at line 1479 of file PutObjectRequest.h.

◆ WebsiteRedirectLocationHasBeenSet()

bool Aws::S3::Model::PutObjectRequest::WebsiteRedirectLocationHasBeenSet ( ) const
inline

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

Definition at line 978 of file PutObjectRequest.h.

◆ WithACL() [1/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithACL ( const ObjectCannedACL value)
inline

The canned ACL to apply to the object. For more information, see Canned ACL.

Definition at line 83 of file PutObjectRequest.h.

◆ WithACL() [2/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithACL ( ObjectCannedACL &&  value)
inline

The canned ACL to apply to the object. For more information, see Canned ACL.

Definition at line 90 of file PutObjectRequest.h.

◆ WithBucket() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithBucket ( const Aws::String value)
inline

Bucket name to which the PUT operation was initiated.

When using this API 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 operation using 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 Simple Storage Service Developer Guide.

Definition at line 175 of file PutObjectRequest.h.

◆ WithBucket() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithBucket ( Aws::String &&  value)
inline

Bucket name to which the PUT operation was initiated.

When using this API 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 operation using 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 Simple Storage Service Developer Guide.

Definition at line 189 of file PutObjectRequest.h.

◆ WithBucket() [3/3]

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

Bucket name to which the PUT operation was initiated.

When using this API 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 operation using 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 Simple Storage Service Developer Guide.

Definition at line 203 of file PutObjectRequest.h.

◆ WithCacheControl() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithCacheControl ( const Aws::String value)
inline

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Definition at line 246 of file PutObjectRequest.h.

◆ WithCacheControl() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithCacheControl ( Aws::String &&  value)
inline

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Definition at line 253 of file PutObjectRequest.h.

◆ WithCacheControl() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithCacheControl ( const char *  value)
inline

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

Definition at line 260 of file PutObjectRequest.h.

◆ WithContentDisposition() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentDisposition ( const Aws::String value)
inline

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

Definition at line 303 of file PutObjectRequest.h.

◆ WithContentDisposition() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentDisposition ( Aws::String &&  value)
inline

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

Definition at line 310 of file PutObjectRequest.h.

◆ WithContentDisposition() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentDisposition ( const char *  value)
inline

Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.

Definition at line 317 of file PutObjectRequest.h.

◆ WithContentEncoding() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentEncoding ( const Aws::String value)
inline

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Definition at line 366 of file PutObjectRequest.h.

◆ WithContentEncoding() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentEncoding ( Aws::String &&  value)
inline

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Definition at line 374 of file PutObjectRequest.h.

◆ WithContentEncoding() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentEncoding ( const char *  value)
inline

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.

Definition at line 382 of file PutObjectRequest.h.

◆ WithContentLanguage() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentLanguage ( const Aws::String value)
inline

The language the content is in.

Definition at line 413 of file PutObjectRequest.h.

◆ WithContentLanguage() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentLanguage ( Aws::String &&  value)
inline

The language the content is in.

Definition at line 418 of file PutObjectRequest.h.

◆ WithContentLanguage() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentLanguage ( const char *  value)
inline

The language the content is in.

Definition at line 423 of file PutObjectRequest.h.

◆ WithContentLength()

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentLength ( long long  value)
inline

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.

Definition at line 452 of file PutObjectRequest.h.

◆ WithContentMD5() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentMD5 ( const Aws::String value)
inline

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

Definition at line 519 of file PutObjectRequest.h.

◆ WithContentMD5() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentMD5 ( Aws::String &&  value)
inline

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

Definition at line 530 of file PutObjectRequest.h.

◆ WithContentMD5() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithContentMD5 ( const char *  value)
inline

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

Definition at line 541 of file PutObjectRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 1642 of file PutObjectRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 1645 of file PutObjectRequest.h.

◆ WithExpires() [1/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithExpires ( const Aws::Utils::DateTime value)
inline

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

Definition at line 577 of file PutObjectRequest.h.

◆ WithExpires() [2/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithExpires ( Aws::Utils::DateTime &&  value)
inline

The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.

Definition at line 584 of file PutObjectRequest.h.

◆ WithGrantFullControl() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantFullControl ( const Aws::String value)
inline

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Definition at line 621 of file PutObjectRequest.h.

◆ WithGrantFullControl() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantFullControl ( Aws::String &&  value)
inline

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Definition at line 627 of file PutObjectRequest.h.

◆ WithGrantFullControl() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantFullControl ( const char *  value)
inline

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Definition at line 633 of file PutObjectRequest.h.

◆ WithGrantRead() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantRead ( const Aws::String value)
inline

Allows grantee to read the object data and its metadata.

Definition at line 664 of file PutObjectRequest.h.

◆ WithGrantRead() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantRead ( Aws::String &&  value)
inline

Allows grantee to read the object data and its metadata.

Definition at line 669 of file PutObjectRequest.h.

◆ WithGrantRead() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantRead ( const char *  value)
inline

Allows grantee to read the object data and its metadata.

Definition at line 674 of file PutObjectRequest.h.

◆ WithGrantReadACP() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantReadACP ( const Aws::String value)
inline

Allows grantee to read the object ACL.

Definition at line 705 of file PutObjectRequest.h.

◆ WithGrantReadACP() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantReadACP ( Aws::String &&  value)
inline

Allows grantee to read the object ACL.

Definition at line 710 of file PutObjectRequest.h.

◆ WithGrantReadACP() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantReadACP ( const char *  value)
inline

Allows grantee to read the object ACL.

Definition at line 715 of file PutObjectRequest.h.

◆ WithGrantWriteACP() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantWriteACP ( const Aws::String value)
inline

Allows grantee to write the ACL for the applicable object.

Definition at line 746 of file PutObjectRequest.h.

◆ WithGrantWriteACP() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantWriteACP ( Aws::String &&  value)
inline

Allows grantee to write the ACL for the applicable object.

Definition at line 751 of file PutObjectRequest.h.

◆ WithGrantWriteACP() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithGrantWriteACP ( const char *  value)
inline

Allows grantee to write the ACL for the applicable object.

Definition at line 756 of file PutObjectRequest.h.

◆ WithKey() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithKey ( const Aws::String value)
inline

Object key for which the PUT operation was initiated.

Definition at line 787 of file PutObjectRequest.h.

◆ WithKey() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithKey ( Aws::String &&  value)
inline

Object key for which the PUT operation was initiated.

Definition at line 792 of file PutObjectRequest.h.

◆ WithKey() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithKey ( const char *  value)
inline

Object key for which the PUT operation was initiated.

Definition at line 797 of file PutObjectRequest.h.

◆ WithMetadata() [1/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithMetadata ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map of metadata to store with the object in S3.

Definition at line 823 of file PutObjectRequest.h.

◆ WithMetadata() [2/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithMetadata ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map of metadata to store with the object in S3.

Definition at line 828 of file PutObjectRequest.h.

◆ WithObjectLockLegalHoldStatus() [1/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithObjectLockLegalHoldStatus ( const ObjectLockLegalHoldStatus value)
inline

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

Definition at line 1618 of file PutObjectRequest.h.

◆ WithObjectLockLegalHoldStatus() [2/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithObjectLockLegalHoldStatus ( ObjectLockLegalHoldStatus &&  value)
inline

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.

Definition at line 1626 of file PutObjectRequest.h.

◆ WithObjectLockMode() [1/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithObjectLockMode ( const ObjectLockMode value)
inline

The Object Lock mode that you want to apply to this object.

Definition at line 1541 of file PutObjectRequest.h.

◆ WithObjectLockMode() [2/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithObjectLockMode ( ObjectLockMode &&  value)
inline

The Object Lock mode that you want to apply to this object.

Definition at line 1546 of file PutObjectRequest.h.

◆ WithObjectLockRetainUntilDate() [1/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithObjectLockRetainUntilDate ( const Aws::Utils::DateTime value)
inline

The date and time when you want this object's Object Lock to expire.

Definition at line 1572 of file PutObjectRequest.h.

◆ WithObjectLockRetainUntilDate() [2/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithObjectLockRetainUntilDate ( Aws::Utils::DateTime &&  value)
inline

The date and time when you want this object's Object Lock to expire.

Definition at line 1577 of file PutObjectRequest.h.

◆ WithRequestPayer() [1/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithRequestPayer ( const RequestPayer value)
inline

Definition at line 1463 of file PutObjectRequest.h.

◆ WithRequestPayer() [2/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithRequestPayer ( RequestPayer &&  value)
inline

Definition at line 1466 of file PutObjectRequest.h.

◆ WithServerSideEncryption() [1/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithServerSideEncryption ( const ServerSideEncryption value)
inline

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Definition at line 894 of file PutObjectRequest.h.

◆ WithServerSideEncryption() [2/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithServerSideEncryption ( ServerSideEncryption &&  value)
inline

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Definition at line 900 of file PutObjectRequest.h.

◆ WithSSECustomerAlgorithm() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSECustomerAlgorithm ( const Aws::String value)
inline

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

Definition at line 1135 of file PutObjectRequest.h.

◆ WithSSECustomerAlgorithm() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSECustomerAlgorithm ( Aws::String &&  value)
inline

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

Definition at line 1141 of file PutObjectRequest.h.

◆ WithSSECustomerAlgorithm() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSECustomerAlgorithm ( const char *  value)
inline

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

Definition at line 1147 of file PutObjectRequest.h.

◆ WithSSECustomerKey() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSECustomerKey ( const Aws::String 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.

Definition at line 1202 of file PutObjectRequest.h.

◆ WithSSECustomerKey() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSECustomerKey ( Aws::String &&  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.

Definition at line 1211 of file PutObjectRequest.h.

◆ WithSSECustomerKey() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSECustomerKey ( const char *  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.

Definition at line 1220 of file PutObjectRequest.h.

◆ WithSSECustomerKeyMD5() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSECustomerKeyMD5 ( const Aws::String 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.

Definition at line 1263 of file PutObjectRequest.h.

◆ WithSSECustomerKeyMD5() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSECustomerKeyMD5 ( Aws::String &&  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.

Definition at line 1270 of file PutObjectRequest.h.

◆ WithSSECustomerKeyMD5() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSECustomerKeyMD5 ( const char *  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.

Definition at line 1277 of file PutObjectRequest.h.

◆ WithSSEKMSEncryptionContext() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSEKMSEncryptionContext ( const Aws::String value)
inline

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Definition at line 1433 of file PutObjectRequest.h.

◆ WithSSEKMSEncryptionContext() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSEKMSEncryptionContext ( Aws::String &&  value)
inline

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Definition at line 1440 of file PutObjectRequest.h.

◆ WithSSEKMSEncryptionContext() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSEKMSEncryptionContext ( const char *  value)
inline

Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Definition at line 1447 of file PutObjectRequest.h.

◆ WithSSEKMSKeyId() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSEKMSKeyId ( const Aws::String value)
inline

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Definition at line 1362 of file PutObjectRequest.h.

◆ WithSSEKMSKeyId() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSEKMSKeyId ( Aws::String &&  value)
inline

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Definition at line 1376 of file PutObjectRequest.h.

◆ WithSSEKMSKeyId() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithSSEKMSKeyId ( const char *  value)
inline

If x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.

If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.

Definition at line 1390 of file PutObjectRequest.h.

◆ WithStorageClass() [1/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithStorageClass ( const StorageClass value)
inline

If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.

Definition at line 931 of file PutObjectRequest.h.

◆ WithStorageClass() [2/2]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithStorageClass ( StorageClass &&  value)
inline

If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.

Definition at line 937 of file PutObjectRequest.h.

◆ WithTagging() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithTagging ( const Aws::String value)
inline

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

Definition at line 1503 of file PutObjectRequest.h.

◆ WithTagging() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithTagging ( Aws::String &&  value)
inline

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

Definition at line 1509 of file PutObjectRequest.h.

◆ WithTagging() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithTagging ( const char *  value)
inline

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

Definition at line 1515 of file PutObjectRequest.h.

◆ WithWebsiteRedirectLocation() [1/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithWebsiteRedirectLocation ( const Aws::String value)
inline

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

Definition at line 1058 of file PutObjectRequest.h.

◆ WithWebsiteRedirectLocation() [2/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithWebsiteRedirectLocation ( Aws::String &&  value)
inline

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

Definition at line 1078 of file PutObjectRequest.h.

◆ WithWebsiteRedirectLocation() [3/3]

PutObjectRequest& Aws::S3::Model::PutObjectRequest::WithWebsiteRedirectLocation ( const char *  value)
inline

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.

In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:

x-amz-website-redirect-location: /anotherPage.html

In the following example, the request header sets the object redirect to another website:

x-amz-website-redirect-location: http://www.example.com/

For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.

Definition at line 1098 of file PutObjectRequest.h.


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