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

#include <CopyObjectRequest.h>

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

Public Member Functions

 CopyObjectRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const ObjectCannedACLGetACL () const
 
bool ACLHasBeenSet () const
 
void SetACL (const ObjectCannedACL &value)
 
void SetACL (ObjectCannedACL &&value)
 
CopyObjectRequestWithACL (const ObjectCannedACL &value)
 
CopyObjectRequestWithACL (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)
 
CopyObjectRequestWithBucket (const Aws::String &value)
 
CopyObjectRequestWithBucket (Aws::String &&value)
 
CopyObjectRequestWithBucket (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)
 
CopyObjectRequestWithCacheControl (const Aws::String &value)
 
CopyObjectRequestWithCacheControl (Aws::String &&value)
 
CopyObjectRequestWithCacheControl (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)
 
CopyObjectRequestWithContentDisposition (const Aws::String &value)
 
CopyObjectRequestWithContentDisposition (Aws::String &&value)
 
CopyObjectRequestWithContentDisposition (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)
 
CopyObjectRequestWithContentEncoding (const Aws::String &value)
 
CopyObjectRequestWithContentEncoding (Aws::String &&value)
 
CopyObjectRequestWithContentEncoding (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)
 
CopyObjectRequestWithContentLanguage (const Aws::String &value)
 
CopyObjectRequestWithContentLanguage (Aws::String &&value)
 
CopyObjectRequestWithContentLanguage (const char *value)
 
const Aws::StringGetContentType () const
 
bool ContentTypeHasBeenSet () const
 
void SetContentType (const Aws::String &value)
 
void SetContentType (Aws::String &&value)
 
void SetContentType (const char *value)
 
CopyObjectRequestWithContentType (const Aws::String &value)
 
CopyObjectRequestWithContentType (Aws::String &&value)
 
CopyObjectRequestWithContentType (const char *value)
 
const Aws::StringGetCopySource () const
 
bool CopySourceHasBeenSet () const
 
void SetCopySource (const Aws::String &value)
 
void SetCopySource (Aws::String &&value)
 
void SetCopySource (const char *value)
 
CopyObjectRequestWithCopySource (const Aws::String &value)
 
CopyObjectRequestWithCopySource (Aws::String &&value)
 
CopyObjectRequestWithCopySource (const char *value)
 
const Aws::StringGetCopySourceIfMatch () const
 
bool CopySourceIfMatchHasBeenSet () const
 
void SetCopySourceIfMatch (const Aws::String &value)
 
void SetCopySourceIfMatch (Aws::String &&value)
 
void SetCopySourceIfMatch (const char *value)
 
CopyObjectRequestWithCopySourceIfMatch (const Aws::String &value)
 
CopyObjectRequestWithCopySourceIfMatch (Aws::String &&value)
 
CopyObjectRequestWithCopySourceIfMatch (const char *value)
 
const Aws::Utils::DateTimeGetCopySourceIfModifiedSince () const
 
bool CopySourceIfModifiedSinceHasBeenSet () const
 
void SetCopySourceIfModifiedSince (const Aws::Utils::DateTime &value)
 
void SetCopySourceIfModifiedSince (Aws::Utils::DateTime &&value)
 
CopyObjectRequestWithCopySourceIfModifiedSince (const Aws::Utils::DateTime &value)
 
CopyObjectRequestWithCopySourceIfModifiedSince (Aws::Utils::DateTime &&value)
 
const Aws::StringGetCopySourceIfNoneMatch () const
 
bool CopySourceIfNoneMatchHasBeenSet () const
 
void SetCopySourceIfNoneMatch (const Aws::String &value)
 
void SetCopySourceIfNoneMatch (Aws::String &&value)
 
void SetCopySourceIfNoneMatch (const char *value)
 
CopyObjectRequestWithCopySourceIfNoneMatch (const Aws::String &value)
 
CopyObjectRequestWithCopySourceIfNoneMatch (Aws::String &&value)
 
CopyObjectRequestWithCopySourceIfNoneMatch (const char *value)
 
const Aws::Utils::DateTimeGetCopySourceIfUnmodifiedSince () const
 
bool CopySourceIfUnmodifiedSinceHasBeenSet () const
 
void SetCopySourceIfUnmodifiedSince (const Aws::Utils::DateTime &value)
 
void SetCopySourceIfUnmodifiedSince (Aws::Utils::DateTime &&value)
 
CopyObjectRequestWithCopySourceIfUnmodifiedSince (const Aws::Utils::DateTime &value)
 
CopyObjectRequestWithCopySourceIfUnmodifiedSince (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetExpires () const
 
bool ExpiresHasBeenSet () const
 
void SetExpires (const Aws::Utils::DateTime &value)
 
void SetExpires (Aws::Utils::DateTime &&value)
 
CopyObjectRequestWithExpires (const Aws::Utils::DateTime &value)
 
CopyObjectRequestWithExpires (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)
 
CopyObjectRequestWithGrantFullControl (const Aws::String &value)
 
CopyObjectRequestWithGrantFullControl (Aws::String &&value)
 
CopyObjectRequestWithGrantFullControl (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)
 
CopyObjectRequestWithGrantRead (const Aws::String &value)
 
CopyObjectRequestWithGrantRead (Aws::String &&value)
 
CopyObjectRequestWithGrantRead (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)
 
CopyObjectRequestWithGrantReadACP (const Aws::String &value)
 
CopyObjectRequestWithGrantReadACP (Aws::String &&value)
 
CopyObjectRequestWithGrantReadACP (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)
 
CopyObjectRequestWithGrantWriteACP (const Aws::String &value)
 
CopyObjectRequestWithGrantWriteACP (Aws::String &&value)
 
CopyObjectRequestWithGrantWriteACP (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)
 
CopyObjectRequestWithKey (const Aws::String &value)
 
CopyObjectRequestWithKey (Aws::String &&value)
 
CopyObjectRequestWithKey (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)
 
CopyObjectRequestWithMetadata (const Aws::Map< Aws::String, Aws::String > &value)
 
CopyObjectRequestWithMetadata (Aws::Map< Aws::String, Aws::String > &&value)
 
CopyObjectRequestAddMetadata (const Aws::String &key, const Aws::String &value)
 
CopyObjectRequestAddMetadata (Aws::String &&key, const Aws::String &value)
 
CopyObjectRequestAddMetadata (const Aws::String &key, Aws::String &&value)
 
CopyObjectRequestAddMetadata (Aws::String &&key, Aws::String &&value)
 
CopyObjectRequestAddMetadata (const char *key, Aws::String &&value)
 
CopyObjectRequestAddMetadata (Aws::String &&key, const char *value)
 
CopyObjectRequestAddMetadata (const char *key, const char *value)
 
const MetadataDirectiveGetMetadataDirective () const
 
bool MetadataDirectiveHasBeenSet () const
 
void SetMetadataDirective (const MetadataDirective &value)
 
void SetMetadataDirective (MetadataDirective &&value)
 
CopyObjectRequestWithMetadataDirective (const MetadataDirective &value)
 
CopyObjectRequestWithMetadataDirective (MetadataDirective &&value)
 
const TaggingDirectiveGetTaggingDirective () const
 
bool TaggingDirectiveHasBeenSet () const
 
void SetTaggingDirective (const TaggingDirective &value)
 
void SetTaggingDirective (TaggingDirective &&value)
 
CopyObjectRequestWithTaggingDirective (const TaggingDirective &value)
 
CopyObjectRequestWithTaggingDirective (TaggingDirective &&value)
 
const ServerSideEncryptionGetServerSideEncryption () const
 
bool ServerSideEncryptionHasBeenSet () const
 
void SetServerSideEncryption (const ServerSideEncryption &value)
 
void SetServerSideEncryption (ServerSideEncryption &&value)
 
CopyObjectRequestWithServerSideEncryption (const ServerSideEncryption &value)
 
CopyObjectRequestWithServerSideEncryption (ServerSideEncryption &&value)
 
const StorageClassGetStorageClass () const
 
bool StorageClassHasBeenSet () const
 
void SetStorageClass (const StorageClass &value)
 
void SetStorageClass (StorageClass &&value)
 
CopyObjectRequestWithStorageClass (const StorageClass &value)
 
CopyObjectRequestWithStorageClass (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)
 
CopyObjectRequestWithWebsiteRedirectLocation (const Aws::String &value)
 
CopyObjectRequestWithWebsiteRedirectLocation (Aws::String &&value)
 
CopyObjectRequestWithWebsiteRedirectLocation (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)
 
CopyObjectRequestWithSSECustomerAlgorithm (const Aws::String &value)
 
CopyObjectRequestWithSSECustomerAlgorithm (Aws::String &&value)
 
CopyObjectRequestWithSSECustomerAlgorithm (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)
 
CopyObjectRequestWithSSECustomerKey (const Aws::String &value)
 
CopyObjectRequestWithSSECustomerKey (Aws::String &&value)
 
CopyObjectRequestWithSSECustomerKey (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)
 
CopyObjectRequestWithSSECustomerKeyMD5 (const Aws::String &value)
 
CopyObjectRequestWithSSECustomerKeyMD5 (Aws::String &&value)
 
CopyObjectRequestWithSSECustomerKeyMD5 (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)
 
CopyObjectRequestWithSSEKMSKeyId (const Aws::String &value)
 
CopyObjectRequestWithSSEKMSKeyId (Aws::String &&value)
 
CopyObjectRequestWithSSEKMSKeyId (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)
 
CopyObjectRequestWithSSEKMSEncryptionContext (const Aws::String &value)
 
CopyObjectRequestWithSSEKMSEncryptionContext (Aws::String &&value)
 
CopyObjectRequestWithSSEKMSEncryptionContext (const char *value)
 
bool GetBucketKeyEnabled () const
 
bool BucketKeyEnabledHasBeenSet () const
 
void SetBucketKeyEnabled (bool value)
 
CopyObjectRequestWithBucketKeyEnabled (bool value)
 
const Aws::StringGetCopySourceSSECustomerAlgorithm () const
 
bool CopySourceSSECustomerAlgorithmHasBeenSet () const
 
void SetCopySourceSSECustomerAlgorithm (const Aws::String &value)
 
void SetCopySourceSSECustomerAlgorithm (Aws::String &&value)
 
void SetCopySourceSSECustomerAlgorithm (const char *value)
 
CopyObjectRequestWithCopySourceSSECustomerAlgorithm (const Aws::String &value)
 
CopyObjectRequestWithCopySourceSSECustomerAlgorithm (Aws::String &&value)
 
CopyObjectRequestWithCopySourceSSECustomerAlgorithm (const char *value)
 
const Aws::StringGetCopySourceSSECustomerKey () const
 
bool CopySourceSSECustomerKeyHasBeenSet () const
 
void SetCopySourceSSECustomerKey (const Aws::String &value)
 
void SetCopySourceSSECustomerKey (Aws::String &&value)
 
void SetCopySourceSSECustomerKey (const char *value)
 
CopyObjectRequestWithCopySourceSSECustomerKey (const Aws::String &value)
 
CopyObjectRequestWithCopySourceSSECustomerKey (Aws::String &&value)
 
CopyObjectRequestWithCopySourceSSECustomerKey (const char *value)
 
const Aws::StringGetCopySourceSSECustomerKeyMD5 () const
 
bool CopySourceSSECustomerKeyMD5HasBeenSet () const
 
void SetCopySourceSSECustomerKeyMD5 (const Aws::String &value)
 
void SetCopySourceSSECustomerKeyMD5 (Aws::String &&value)
 
void SetCopySourceSSECustomerKeyMD5 (const char *value)
 
CopyObjectRequestWithCopySourceSSECustomerKeyMD5 (const Aws::String &value)
 
CopyObjectRequestWithCopySourceSSECustomerKeyMD5 (Aws::String &&value)
 
CopyObjectRequestWithCopySourceSSECustomerKeyMD5 (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
CopyObjectRequestWithRequestPayer (const RequestPayer &value)
 
CopyObjectRequestWithRequestPayer (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)
 
CopyObjectRequestWithTagging (const Aws::String &value)
 
CopyObjectRequestWithTagging (Aws::String &&value)
 
CopyObjectRequestWithTagging (const char *value)
 
const ObjectLockModeGetObjectLockMode () const
 
bool ObjectLockModeHasBeenSet () const
 
void SetObjectLockMode (const ObjectLockMode &value)
 
void SetObjectLockMode (ObjectLockMode &&value)
 
CopyObjectRequestWithObjectLockMode (const ObjectLockMode &value)
 
CopyObjectRequestWithObjectLockMode (ObjectLockMode &&value)
 
const Aws::Utils::DateTimeGetObjectLockRetainUntilDate () const
 
bool ObjectLockRetainUntilDateHasBeenSet () const
 
void SetObjectLockRetainUntilDate (const Aws::Utils::DateTime &value)
 
void SetObjectLockRetainUntilDate (Aws::Utils::DateTime &&value)
 
CopyObjectRequestWithObjectLockRetainUntilDate (const Aws::Utils::DateTime &value)
 
CopyObjectRequestWithObjectLockRetainUntilDate (Aws::Utils::DateTime &&value)
 
const ObjectLockLegalHoldStatusGetObjectLockLegalHoldStatus () const
 
bool ObjectLockLegalHoldStatusHasBeenSet () const
 
void SetObjectLockLegalHoldStatus (const ObjectLockLegalHoldStatus &value)
 
void SetObjectLockLegalHoldStatus (ObjectLockLegalHoldStatus &&value)
 
CopyObjectRequestWithObjectLockLegalHoldStatus (const ObjectLockLegalHoldStatus &value)
 
CopyObjectRequestWithObjectLockLegalHoldStatus (ObjectLockLegalHoldStatus &&value)
 
const Aws::StringGetExpectedBucketOwner () const
 
bool ExpectedBucketOwnerHasBeenSet () const
 
void SetExpectedBucketOwner (const Aws::String &value)
 
void SetExpectedBucketOwner (Aws::String &&value)
 
void SetExpectedBucketOwner (const char *value)
 
CopyObjectRequestWithExpectedBucketOwner (const Aws::String &value)
 
CopyObjectRequestWithExpectedBucketOwner (Aws::String &&value)
 
CopyObjectRequestWithExpectedBucketOwner (const char *value)
 
const Aws::StringGetExpectedSourceBucketOwner () const
 
bool ExpectedSourceBucketOwnerHasBeenSet () const
 
void SetExpectedSourceBucketOwner (const Aws::String &value)
 
void SetExpectedSourceBucketOwner (Aws::String &&value)
 
void SetExpectedSourceBucketOwner (const char *value)
 
CopyObjectRequestWithExpectedSourceBucketOwner (const Aws::String &value)
 
CopyObjectRequestWithExpectedSourceBucketOwner (Aws::String &&value)
 
CopyObjectRequestWithExpectedSourceBucketOwner (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetCustomizedAccessLogTag () const
 
bool CustomizedAccessLogTagHasBeenSet () const
 
void SetCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
CopyObjectRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
CopyObjectRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
CopyObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
CopyObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
CopyObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
CopyObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
CopyObjectRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
CopyObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
CopyObjectRequestAddCustomizedAccessLogTag (const char *key, const char *value)
 
- Public Member Functions inherited from Aws::S3::S3Request
virtual ~S3Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const 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 35 of file CopyObjectRequest.h.

Constructor & Destructor Documentation

◆ CopyObjectRequest()

Aws::S3::Model::CopyObjectRequest::CopyObjectRequest ( )

Member Function Documentation

◆ ACLHasBeenSet()

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

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 63 of file CopyObjectRequest.h.

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 2332 of file CopyObjectRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 2326 of file CopyObjectRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 2338 of file CopyObjectRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 2329 of file CopyObjectRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 2323 of file CopyObjectRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 2335 of file CopyObjectRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 2341 of file CopyObjectRequest.h.

◆ AddMetadata() [1/7]

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

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

Definition at line 1237 of file CopyObjectRequest.h.

◆ AddMetadata() [2/7]

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

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

Definition at line 1227 of file CopyObjectRequest.h.

◆ AddMetadata() [3/7]

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

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

Definition at line 1247 of file CopyObjectRequest.h.

◆ AddMetadata() [4/7]

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

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

Definition at line 1232 of file CopyObjectRequest.h.

◆ AddMetadata() [5/7]

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

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

Definition at line 1222 of file CopyObjectRequest.h.

◆ AddMetadata() [6/7]

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

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

Definition at line 1242 of file CopyObjectRequest.h.

◆ AddMetadata() [7/7]

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

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

Definition at line 1252 of file CopyObjectRequest.h.

◆ AddQueryStringParameters()

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

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 130 of file CopyObjectRequest.h.

◆ BucketKeyEnabledHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::BucketKeyEnabledHasBeenSet ( ) const
inline

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

Definition at line 1831 of file CopyObjectRequest.h.

◆ CacheControlHasBeenSet()

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

Specifies caching behavior along the request/reply chain.

Definition at line 267 of file CopyObjectRequest.h.

◆ ContentDispositionHasBeenSet()

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

Specifies presentational information for the object.

Definition at line 308 of file CopyObjectRequest.h.

◆ ContentEncodingHasBeenSet()

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

Definition at line 353 of file CopyObjectRequest.h.

◆ ContentLanguageHasBeenSet()

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

The language the content is in.

Definition at line 406 of file CopyObjectRequest.h.

◆ ContentTypeHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::ContentTypeHasBeenSet ( ) const
inline

A standard MIME type describing the format of the object data.

Definition at line 447 of file CopyObjectRequest.h.

◆ CopySourceHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::CopySourceHasBeenSet ( ) const
inline

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Definition at line 550 of file CopyObjectRequest.h.

◆ CopySourceIfMatchHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::CopySourceIfMatchHasBeenSet ( ) const
inline

Copies the object if its entity tag (ETag) matches the specified tag.

Definition at line 777 of file CopyObjectRequest.h.

◆ CopySourceIfModifiedSinceHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::CopySourceIfModifiedSinceHasBeenSet ( ) const
inline

Copies the object if it has been modified since the specified time.

Definition at line 818 of file CopyObjectRequest.h.

◆ CopySourceIfNoneMatchHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::CopySourceIfNoneMatchHasBeenSet ( ) const
inline

Copies the object if its entity tag (ETag) is different than the specified ETag.

Definition at line 851 of file CopyObjectRequest.h.

◆ CopySourceIfUnmodifiedSinceHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::CopySourceIfUnmodifiedSinceHasBeenSet ( ) const
inline

Copies the object if it hasn't been modified since the specified time.

Definition at line 898 of file CopyObjectRequest.h.

◆ CopySourceSSECustomerAlgorithmHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::CopySourceSSECustomerAlgorithmHasBeenSet ( ) const
inline

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

Definition at line 1862 of file CopyObjectRequest.h.

◆ CopySourceSSECustomerKeyHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::CopySourceSSECustomerKeyHasBeenSet ( ) const
inline

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Definition at line 1913 of file CopyObjectRequest.h.

◆ CopySourceSSECustomerKeyMD5HasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::CopySourceSSECustomerKeyMD5HasBeenSet ( ) 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 1970 of file CopyObjectRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 2308 of file CopyObjectRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::ExpectedBucketOwnerHasBeenSet ( ) const
inline

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2202 of file CopyObjectRequest.h.

◆ ExpectedSourceBucketOwnerHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::ExpectedSourceBucketOwnerHasBeenSet ( ) const
inline

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2259 of file CopyObjectRequest.h.

◆ ExpiresHasBeenSet()

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

The date and time at which the object is no longer cacheable.

Definition at line 929 of file CopyObjectRequest.h.

◆ GetACL()

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

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 57 of file CopyObjectRequest.h.

◆ GetBucket()

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

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 109 of file CopyObjectRequest.h.

◆ GetBucketKeyEnabled()

bool Aws::S3::Model::CopyObjectRequest::GetBucketKeyEnabled ( ) const
inline

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

Definition at line 1822 of file CopyObjectRequest.h.

◆ GetCacheControl()

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

Specifies caching behavior along the request/reply chain.

Definition at line 262 of file CopyObjectRequest.h.

◆ GetContentDisposition()

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

Specifies presentational information for the object.

Definition at line 303 of file CopyObjectRequest.h.

◆ GetContentEncoding()

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

Definition at line 346 of file CopyObjectRequest.h.

◆ GetContentLanguage()

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

The language the content is in.

Definition at line 401 of file CopyObjectRequest.h.

◆ GetContentType()

const Aws::String& Aws::S3::Model::CopyObjectRequest::GetContentType ( ) const
inline

A standard MIME type describing the format of the object data.

Definition at line 442 of file CopyObjectRequest.h.

◆ GetCopySource()

const Aws::String& Aws::S3::Model::CopyObjectRequest::GetCopySource ( ) const
inline

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Definition at line 514 of file CopyObjectRequest.h.

◆ GetCopySourceIfMatch()

const Aws::String& Aws::S3::Model::CopyObjectRequest::GetCopySourceIfMatch ( ) const
inline

Copies the object if its entity tag (ETag) matches the specified tag.

Definition at line 772 of file CopyObjectRequest.h.

◆ GetCopySourceIfModifiedSince()

const Aws::Utils::DateTime& Aws::S3::Model::CopyObjectRequest::GetCopySourceIfModifiedSince ( ) const
inline

Copies the object if it has been modified since the specified time.

Definition at line 813 of file CopyObjectRequest.h.

◆ GetCopySourceIfNoneMatch()

const Aws::String& Aws::S3::Model::CopyObjectRequest::GetCopySourceIfNoneMatch ( ) const
inline

Copies the object if its entity tag (ETag) is different than the specified ETag.

Definition at line 845 of file CopyObjectRequest.h.

◆ GetCopySourceIfUnmodifiedSince()

const Aws::Utils::DateTime& Aws::S3::Model::CopyObjectRequest::GetCopySourceIfUnmodifiedSince ( ) const
inline

Copies the object if it hasn't been modified since the specified time.

Definition at line 893 of file CopyObjectRequest.h.

◆ GetCopySourceSSECustomerAlgorithm()

const Aws::String& Aws::S3::Model::CopyObjectRequest::GetCopySourceSSECustomerAlgorithm ( ) const
inline

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

Definition at line 1856 of file CopyObjectRequest.h.

◆ GetCopySourceSSECustomerKey()

const Aws::String& Aws::S3::Model::CopyObjectRequest::GetCopySourceSSECustomerKey ( ) const
inline

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Definition at line 1906 of file CopyObjectRequest.h.

◆ GetCopySourceSSECustomerKeyMD5()

const Aws::String& Aws::S3::Model::CopyObjectRequest::GetCopySourceSSECustomerKeyMD5 ( ) 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 1963 of file CopyObjectRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 2305 of file CopyObjectRequest.h.

◆ GetExpectedBucketOwner()

const Aws::String& Aws::S3::Model::CopyObjectRequest::GetExpectedBucketOwner ( ) const
inline

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2195 of file CopyObjectRequest.h.

◆ GetExpectedSourceBucketOwner()

const Aws::String& Aws::S3::Model::CopyObjectRequest::GetExpectedSourceBucketOwner ( ) const
inline

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2252 of file CopyObjectRequest.h.

◆ GetExpires()

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

The date and time at which the object is no longer cacheable.

Definition at line 924 of file CopyObjectRequest.h.

◆ GetGrantFullControl()

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

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

This action is not supported by Amazon S3 on Outposts.

Definition at line 956 of file CopyObjectRequest.h.

◆ GetGrantRead()

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

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1005 of file CopyObjectRequest.h.

◆ GetGrantReadACP()

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

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1054 of file CopyObjectRequest.h.

◆ GetGrantWriteACP()

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

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1103 of file CopyObjectRequest.h.

◆ GetKey()

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

The key of the destination object.

Definition at line 1151 of file CopyObjectRequest.h.

◆ GetMetadata()

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

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

Definition at line 1192 of file CopyObjectRequest.h.

◆ GetMetadataDirective()

const MetadataDirective& Aws::S3::Model::CopyObjectRequest::GetMetadataDirective ( ) const
inline

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Definition at line 1259 of file CopyObjectRequest.h.

◆ GetObjectLockLegalHoldStatus()

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

Specifies whether you want to apply a Legal Hold to the copied object.

Definition at line 2162 of file CopyObjectRequest.h.

◆ GetObjectLockMode()

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

The Object Lock mode that you want to apply to the copied object.

Definition at line 2094 of file CopyObjectRequest.h.

◆ GetObjectLockRetainUntilDate()

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

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

Definition at line 2126 of file CopyObjectRequest.h.

◆ GetRequestPayer()

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

Definition at line 2016 of file CopyObjectRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServerSideEncryption()

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

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

Definition at line 1333 of file CopyObjectRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 44 of file CopyObjectRequest.h.

◆ GetSSECustomerAlgorithm()

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

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

Definition at line 1494 of file CopyObjectRequest.h.

◆ GetSSECustomerKey()

const Aws::String& Aws::S3::Model::CopyObjectRequest::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 1546 of file CopyObjectRequest.h.

◆ GetSSECustomerKeyMD5()

const Aws::String& Aws::S3::Model::CopyObjectRequest::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 1617 of file CopyObjectRequest.h.

◆ GetSSEKMSEncryptionContext()

const Aws::String& Aws::S3::Model::CopyObjectRequest::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 1763 of file CopyObjectRequest.h.

◆ GetSSEKMSKeyId()

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

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Definition at line 1678 of file CopyObjectRequest.h.

◆ GetStorageClass()

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

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Definition at line 1375 of file CopyObjectRequest.h.

◆ GetTagging()

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

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Definition at line 2039 of file CopyObjectRequest.h.

◆ GetTaggingDirective()

const TaggingDirective& Aws::S3::Model::CopyObjectRequest::GetTaggingDirective ( ) const
inline

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Definition at line 1296 of file CopyObjectRequest.h.

◆ GetWebsiteRedirectLocation()

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

Definition at line 1438 of file CopyObjectRequest.h.

◆ GrantFullControlHasBeenSet()

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

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

This action is not supported by Amazon S3 on Outposts.

Definition at line 962 of file CopyObjectRequest.h.

◆ GrantReadACPHasBeenSet()

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

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1060 of file CopyObjectRequest.h.

◆ GrantReadHasBeenSet()

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

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1011 of file CopyObjectRequest.h.

◆ GrantWriteACPHasBeenSet()

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

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1109 of file CopyObjectRequest.h.

◆ KeyHasBeenSet()

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

The key of the destination object.

Definition at line 1156 of file CopyObjectRequest.h.

◆ MetadataDirectiveHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::MetadataDirectiveHasBeenSet ( ) const
inline

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Definition at line 1265 of file CopyObjectRequest.h.

◆ MetadataHasBeenSet()

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

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

Definition at line 1197 of file CopyObjectRequest.h.

◆ ObjectLockLegalHoldStatusHasBeenSet()

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

Specifies whether you want to apply a Legal Hold to the copied object.

Definition at line 2167 of file CopyObjectRequest.h.

◆ ObjectLockModeHasBeenSet()

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

The Object Lock mode that you want to apply to the copied object.

Definition at line 2099 of file CopyObjectRequest.h.

◆ ObjectLockRetainUntilDateHasBeenSet()

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

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

Definition at line 2132 of file CopyObjectRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 2019 of file CopyObjectRequest.h.

◆ SerializePayload()

Aws::String Aws::S3::Model::CopyObjectRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServerSideEncryptionHasBeenSet()

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

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

Definition at line 1339 of file CopyObjectRequest.h.

◆ SetACL() [1/2]

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

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 69 of file CopyObjectRequest.h.

◆ SetACL() [2/2]

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

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 75 of file CopyObjectRequest.h.

◆ SetBucket() [1/3]

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

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 172 of file CopyObjectRequest.h.

◆ SetBucket() [2/3]

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

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 151 of file CopyObjectRequest.h.

◆ SetBucket() [3/3]

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

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 193 of file CopyObjectRequest.h.

◆ SetBucketKeyEnabled()

void Aws::S3::Model::CopyObjectRequest::SetBucketKeyEnabled ( bool  value)
inline

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

Definition at line 1840 of file CopyObjectRequest.h.

◆ SetCacheControl() [1/3]

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

Specifies caching behavior along the request/reply chain.

Definition at line 277 of file CopyObjectRequest.h.

◆ SetCacheControl() [2/3]

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

Specifies caching behavior along the request/reply chain.

Definition at line 272 of file CopyObjectRequest.h.

◆ SetCacheControl() [3/3]

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

Specifies caching behavior along the request/reply chain.

Definition at line 282 of file CopyObjectRequest.h.

◆ SetContentDisposition() [1/3]

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

Specifies presentational information for the object.

Definition at line 318 of file CopyObjectRequest.h.

◆ SetContentDisposition() [2/3]

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

Specifies presentational information for the object.

Definition at line 313 of file CopyObjectRequest.h.

◆ SetContentDisposition() [3/3]

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

Specifies presentational information for the object.

Definition at line 323 of file CopyObjectRequest.h.

◆ SetContentEncoding() [1/3]

void Aws::S3::Model::CopyObjectRequest::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.

Definition at line 367 of file CopyObjectRequest.h.

◆ SetContentEncoding() [2/3]

void Aws::S3::Model::CopyObjectRequest::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.

Definition at line 360 of file CopyObjectRequest.h.

◆ SetContentEncoding() [3/3]

void Aws::S3::Model::CopyObjectRequest::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.

Definition at line 374 of file CopyObjectRequest.h.

◆ SetContentLanguage() [1/3]

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

The language the content is in.

Definition at line 416 of file CopyObjectRequest.h.

◆ SetContentLanguage() [2/3]

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

The language the content is in.

Definition at line 411 of file CopyObjectRequest.h.

◆ SetContentLanguage() [3/3]

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

The language the content is in.

Definition at line 421 of file CopyObjectRequest.h.

◆ SetContentType() [1/3]

void Aws::S3::Model::CopyObjectRequest::SetContentType ( Aws::String &&  value)
inline

A standard MIME type describing the format of the object data.

Definition at line 457 of file CopyObjectRequest.h.

◆ SetContentType() [2/3]

void Aws::S3::Model::CopyObjectRequest::SetContentType ( const Aws::String value)
inline

A standard MIME type describing the format of the object data.

Definition at line 452 of file CopyObjectRequest.h.

◆ SetContentType() [3/3]

void Aws::S3::Model::CopyObjectRequest::SetContentType ( const char *  value)
inline

A standard MIME type describing the format of the object data.

Definition at line 462 of file CopyObjectRequest.h.

◆ SetCopySource() [1/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySource ( Aws::String &&  value)
inline

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Definition at line 622 of file CopyObjectRequest.h.

◆ SetCopySource() [2/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySource ( const Aws::String value)
inline

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Definition at line 586 of file CopyObjectRequest.h.

◆ SetCopySource() [3/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySource ( const char *  value)
inline

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Definition at line 658 of file CopyObjectRequest.h.

◆ SetCopySourceIfMatch() [1/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfMatch ( Aws::String &&  value)
inline

Copies the object if its entity tag (ETag) matches the specified tag.

Definition at line 787 of file CopyObjectRequest.h.

◆ SetCopySourceIfMatch() [2/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfMatch ( const Aws::String value)
inline

Copies the object if its entity tag (ETag) matches the specified tag.

Definition at line 782 of file CopyObjectRequest.h.

◆ SetCopySourceIfMatch() [3/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfMatch ( const char *  value)
inline

Copies the object if its entity tag (ETag) matches the specified tag.

Definition at line 792 of file CopyObjectRequest.h.

◆ SetCopySourceIfModifiedSince() [1/2]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfModifiedSince ( Aws::Utils::DateTime &&  value)
inline

Copies the object if it has been modified since the specified time.

Definition at line 828 of file CopyObjectRequest.h.

◆ SetCopySourceIfModifiedSince() [2/2]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfModifiedSince ( const Aws::Utils::DateTime value)
inline

Copies the object if it has been modified since the specified time.

Definition at line 823 of file CopyObjectRequest.h.

◆ SetCopySourceIfNoneMatch() [1/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfNoneMatch ( Aws::String &&  value)
inline

Copies the object if its entity tag (ETag) is different than the specified ETag.

Definition at line 863 of file CopyObjectRequest.h.

◆ SetCopySourceIfNoneMatch() [2/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfNoneMatch ( const Aws::String value)
inline

Copies the object if its entity tag (ETag) is different than the specified ETag.

Definition at line 857 of file CopyObjectRequest.h.

◆ SetCopySourceIfNoneMatch() [3/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfNoneMatch ( const char *  value)
inline

Copies the object if its entity tag (ETag) is different than the specified ETag.

Definition at line 869 of file CopyObjectRequest.h.

◆ SetCopySourceIfUnmodifiedSince() [1/2]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfUnmodifiedSince ( Aws::Utils::DateTime &&  value)
inline

Copies the object if it hasn't been modified since the specified time.

Definition at line 908 of file CopyObjectRequest.h.

◆ SetCopySourceIfUnmodifiedSince() [2/2]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceIfUnmodifiedSince ( const Aws::Utils::DateTime value)
inline

Copies the object if it hasn't been modified since the specified time.

Definition at line 903 of file CopyObjectRequest.h.

◆ SetCopySourceSSECustomerAlgorithm() [1/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceSSECustomerAlgorithm ( Aws::String &&  value)
inline

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

Definition at line 1874 of file CopyObjectRequest.h.

◆ SetCopySourceSSECustomerAlgorithm() [2/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceSSECustomerAlgorithm ( const Aws::String value)
inline

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

Definition at line 1868 of file CopyObjectRequest.h.

◆ SetCopySourceSSECustomerAlgorithm() [3/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceSSECustomerAlgorithm ( const char *  value)
inline

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

Definition at line 1880 of file CopyObjectRequest.h.

◆ SetCopySourceSSECustomerKey() [1/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceSSECustomerKey ( Aws::String &&  value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Definition at line 1927 of file CopyObjectRequest.h.

◆ SetCopySourceSSECustomerKey() [2/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceSSECustomerKey ( const Aws::String value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Definition at line 1920 of file CopyObjectRequest.h.

◆ SetCopySourceSSECustomerKey() [3/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceSSECustomerKey ( const char *  value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Definition at line 1934 of file CopyObjectRequest.h.

◆ SetCopySourceSSECustomerKeyMD5() [1/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceSSECustomerKeyMD5 ( 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 1984 of file CopyObjectRequest.h.

◆ SetCopySourceSSECustomerKeyMD5() [2/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceSSECustomerKeyMD5 ( 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 1977 of file CopyObjectRequest.h.

◆ SetCopySourceSSECustomerKeyMD5() [3/3]

void Aws::S3::Model::CopyObjectRequest::SetCopySourceSSECustomerKeyMD5 ( 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 1991 of file CopyObjectRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 2314 of file CopyObjectRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 2311 of file CopyObjectRequest.h.

◆ SetExpectedBucketOwner() [1/3]

void Aws::S3::Model::CopyObjectRequest::SetExpectedBucketOwner ( Aws::String &&  value)
inline

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2216 of file CopyObjectRequest.h.

◆ SetExpectedBucketOwner() [2/3]

void Aws::S3::Model::CopyObjectRequest::SetExpectedBucketOwner ( const Aws::String value)
inline

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2209 of file CopyObjectRequest.h.

◆ SetExpectedBucketOwner() [3/3]

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

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2223 of file CopyObjectRequest.h.

◆ SetExpectedSourceBucketOwner() [1/3]

void Aws::S3::Model::CopyObjectRequest::SetExpectedSourceBucketOwner ( Aws::String &&  value)
inline

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2273 of file CopyObjectRequest.h.

◆ SetExpectedSourceBucketOwner() [2/3]

void Aws::S3::Model::CopyObjectRequest::SetExpectedSourceBucketOwner ( const Aws::String value)
inline

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2266 of file CopyObjectRequest.h.

◆ SetExpectedSourceBucketOwner() [3/3]

void Aws::S3::Model::CopyObjectRequest::SetExpectedSourceBucketOwner ( const char *  value)
inline

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2280 of file CopyObjectRequest.h.

◆ SetExpires() [1/2]

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

The date and time at which the object is no longer cacheable.

Definition at line 939 of file CopyObjectRequest.h.

◆ SetExpires() [2/2]

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

The date and time at which the object is no longer cacheable.

Definition at line 934 of file CopyObjectRequest.h.

◆ SetGrantFullControl() [1/3]

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

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

This action is not supported by Amazon S3 on Outposts.

Definition at line 974 of file CopyObjectRequest.h.

◆ SetGrantFullControl() [2/3]

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

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

This action is not supported by Amazon S3 on Outposts.

Definition at line 968 of file CopyObjectRequest.h.

◆ SetGrantFullControl() [3/3]

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

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

This action is not supported by Amazon S3 on Outposts.

Definition at line 980 of file CopyObjectRequest.h.

◆ SetGrantRead() [1/3]

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

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1023 of file CopyObjectRequest.h.

◆ SetGrantRead() [2/3]

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

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1017 of file CopyObjectRequest.h.

◆ SetGrantRead() [3/3]

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

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1029 of file CopyObjectRequest.h.

◆ SetGrantReadACP() [1/3]

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

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1072 of file CopyObjectRequest.h.

◆ SetGrantReadACP() [2/3]

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

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1066 of file CopyObjectRequest.h.

◆ SetGrantReadACP() [3/3]

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

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1078 of file CopyObjectRequest.h.

◆ SetGrantWriteACP() [1/3]

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

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1121 of file CopyObjectRequest.h.

◆ SetGrantWriteACP() [2/3]

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

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1115 of file CopyObjectRequest.h.

◆ SetGrantWriteACP() [3/3]

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

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1127 of file CopyObjectRequest.h.

◆ SetKey() [1/3]

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

The key of the destination object.

Definition at line 1166 of file CopyObjectRequest.h.

◆ SetKey() [2/3]

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

The key of the destination object.

Definition at line 1161 of file CopyObjectRequest.h.

◆ SetKey() [3/3]

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

The key of the destination object.

Definition at line 1171 of file CopyObjectRequest.h.

◆ SetMetadata() [1/2]

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

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

Definition at line 1207 of file CopyObjectRequest.h.

◆ SetMetadata() [2/2]

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

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

Definition at line 1202 of file CopyObjectRequest.h.

◆ SetMetadataDirective() [1/2]

void Aws::S3::Model::CopyObjectRequest::SetMetadataDirective ( const MetadataDirective value)
inline

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Definition at line 1271 of file CopyObjectRequest.h.

◆ SetMetadataDirective() [2/2]

void Aws::S3::Model::CopyObjectRequest::SetMetadataDirective ( MetadataDirective &&  value)
inline

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Definition at line 1277 of file CopyObjectRequest.h.

◆ SetObjectLockLegalHoldStatus() [1/2]

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

Specifies whether you want to apply a Legal Hold to the copied object.

Definition at line 2172 of file CopyObjectRequest.h.

◆ SetObjectLockLegalHoldStatus() [2/2]

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

Specifies whether you want to apply a Legal Hold to the copied object.

Definition at line 2177 of file CopyObjectRequest.h.

◆ SetObjectLockMode() [1/2]

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

The Object Lock mode that you want to apply to the copied object.

Definition at line 2104 of file CopyObjectRequest.h.

◆ SetObjectLockMode() [2/2]

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

The Object Lock mode that you want to apply to the copied object.

Definition at line 2109 of file CopyObjectRequest.h.

◆ SetObjectLockRetainUntilDate() [1/2]

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

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

Definition at line 2144 of file CopyObjectRequest.h.

◆ SetObjectLockRetainUntilDate() [2/2]

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

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

Definition at line 2138 of file CopyObjectRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 2022 of file CopyObjectRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 2025 of file CopyObjectRequest.h.

◆ SetServerSideEncryption() [1/2]

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

◆ SetServerSideEncryption() [2/2]

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

◆ SetSSECustomerAlgorithm() [1/3]

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

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

Definition at line 1512 of file CopyObjectRequest.h.

◆ SetSSECustomerAlgorithm() [2/3]

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

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

Definition at line 1506 of file CopyObjectRequest.h.

◆ SetSSECustomerAlgorithm() [3/3]

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

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

Definition at line 1518 of file CopyObjectRequest.h.

◆ SetSSECustomerKey() [1/3]

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

◆ SetSSECustomerKey() [2/3]

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

◆ SetSSECustomerKey() [3/3]

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

◆ SetSSECustomerKeyMD5() [1/3]

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

◆ SetSSECustomerKeyMD5() [2/3]

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

◆ SetSSECustomerKeyMD5() [3/3]

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

◆ SetSSEKMSEncryptionContext() [1/3]

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

◆ SetSSEKMSEncryptionContext() [2/3]

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

◆ SetSSEKMSEncryptionContext() [3/3]

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

◆ SetSSEKMSKeyId() [1/3]

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

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Definition at line 1711 of file CopyObjectRequest.h.

◆ SetSSEKMSKeyId() [2/3]

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

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Definition at line 1700 of file CopyObjectRequest.h.

◆ SetSSEKMSKeyId() [3/3]

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

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Definition at line 1722 of file CopyObjectRequest.h.

◆ SetStorageClass() [1/2]

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

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Definition at line 1397 of file CopyObjectRequest.h.

◆ SetStorageClass() [2/2]

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

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Definition at line 1408 of file CopyObjectRequest.h.

◆ SetTagging() [1/3]

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

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Definition at line 2060 of file CopyObjectRequest.h.

◆ SetTagging() [2/3]

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

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Definition at line 2053 of file CopyObjectRequest.h.

◆ SetTagging() [3/3]

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

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Definition at line 2067 of file CopyObjectRequest.h.

◆ SetTaggingDirective() [1/2]

void Aws::S3::Model::CopyObjectRequest::SetTaggingDirective ( const TaggingDirective value)
inline

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Definition at line 1308 of file CopyObjectRequest.h.

◆ SetTaggingDirective() [2/2]

void Aws::S3::Model::CopyObjectRequest::SetTaggingDirective ( TaggingDirective &&  value)
inline

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Definition at line 1314 of file CopyObjectRequest.h.

◆ SetWebsiteRedirectLocation() [1/3]

void Aws::S3::Model::CopyObjectRequest::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.

Definition at line 1459 of file CopyObjectRequest.h.

◆ SetWebsiteRedirectLocation() [2/3]

void Aws::S3::Model::CopyObjectRequest::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.

Definition at line 1452 of file CopyObjectRequest.h.

◆ SetWebsiteRedirectLocation() [3/3]

void Aws::S3::Model::CopyObjectRequest::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.

Definition at line 1466 of file CopyObjectRequest.h.

◆ SSECustomerAlgorithmHasBeenSet()

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

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

Definition at line 1500 of file CopyObjectRequest.h.

◆ SSECustomerKeyHasBeenSet()

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

◆ SSECustomerKeyMD5HasBeenSet()

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

◆ SSEKMSEncryptionContextHasBeenSet()

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

◆ SSEKMSKeyIdHasBeenSet()

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

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Definition at line 1689 of file CopyObjectRequest.h.

◆ StorageClassHasBeenSet()

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

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Definition at line 1386 of file CopyObjectRequest.h.

◆ TaggingDirectiveHasBeenSet()

bool Aws::S3::Model::CopyObjectRequest::TaggingDirectiveHasBeenSet ( ) const
inline

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Definition at line 1302 of file CopyObjectRequest.h.

◆ TaggingHasBeenSet()

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

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Definition at line 2046 of file CopyObjectRequest.h.

◆ WebsiteRedirectLocationHasBeenSet()

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

Definition at line 1445 of file CopyObjectRequest.h.

◆ WithACL() [1/2]

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

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 81 of file CopyObjectRequest.h.

◆ WithACL() [2/2]

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

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 87 of file CopyObjectRequest.h.

◆ WithBucket() [1/3]

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

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 235 of file CopyObjectRequest.h.

◆ WithBucket() [2/3]

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

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 214 of file CopyObjectRequest.h.

◆ WithBucket() [3/3]

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

The name of the destination bucket.

When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.

When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this action using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Definition at line 256 of file CopyObjectRequest.h.

◆ WithBucketKeyEnabled()

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithBucketKeyEnabled ( bool  value)
inline

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

Definition at line 1849 of file CopyObjectRequest.h.

◆ WithCacheControl() [1/3]

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

Specifies caching behavior along the request/reply chain.

Definition at line 292 of file CopyObjectRequest.h.

◆ WithCacheControl() [2/3]

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

Specifies caching behavior along the request/reply chain.

Definition at line 287 of file CopyObjectRequest.h.

◆ WithCacheControl() [3/3]

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

Specifies caching behavior along the request/reply chain.

Definition at line 297 of file CopyObjectRequest.h.

◆ WithContentDisposition() [1/3]

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

Specifies presentational information for the object.

Definition at line 333 of file CopyObjectRequest.h.

◆ WithContentDisposition() [2/3]

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

Specifies presentational information for the object.

Definition at line 328 of file CopyObjectRequest.h.

◆ WithContentDisposition() [3/3]

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

Specifies presentational information for the object.

Definition at line 338 of file CopyObjectRequest.h.

◆ WithContentEncoding() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::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.

Definition at line 388 of file CopyObjectRequest.h.

◆ WithContentEncoding() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::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.

Definition at line 381 of file CopyObjectRequest.h.

◆ WithContentEncoding() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::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.

Definition at line 395 of file CopyObjectRequest.h.

◆ WithContentLanguage() [1/3]

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

The language the content is in.

Definition at line 431 of file CopyObjectRequest.h.

◆ WithContentLanguage() [2/3]

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

The language the content is in.

Definition at line 426 of file CopyObjectRequest.h.

◆ WithContentLanguage() [3/3]

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

The language the content is in.

Definition at line 436 of file CopyObjectRequest.h.

◆ WithContentType() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithContentType ( Aws::String &&  value)
inline

A standard MIME type describing the format of the object data.

Definition at line 472 of file CopyObjectRequest.h.

◆ WithContentType() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithContentType ( const Aws::String value)
inline

A standard MIME type describing the format of the object data.

Definition at line 467 of file CopyObjectRequest.h.

◆ WithContentType() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithContentType ( const char *  value)
inline

A standard MIME type describing the format of the object data.

Definition at line 477 of file CopyObjectRequest.h.

◆ WithCopySource() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySource ( Aws::String &&  value)
inline

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Definition at line 730 of file CopyObjectRequest.h.

◆ WithCopySource() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySource ( const Aws::String value)
inline

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Definition at line 694 of file CopyObjectRequest.h.

◆ WithCopySource() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySource ( const char *  value)
inline

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

  • For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

  • For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

    Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.

    Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Definition at line 766 of file CopyObjectRequest.h.

◆ WithCopySourceIfMatch() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfMatch ( Aws::String &&  value)
inline

Copies the object if its entity tag (ETag) matches the specified tag.

Definition at line 802 of file CopyObjectRequest.h.

◆ WithCopySourceIfMatch() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfMatch ( const Aws::String value)
inline

Copies the object if its entity tag (ETag) matches the specified tag.

Definition at line 797 of file CopyObjectRequest.h.

◆ WithCopySourceIfMatch() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfMatch ( const char *  value)
inline

Copies the object if its entity tag (ETag) matches the specified tag.

Definition at line 807 of file CopyObjectRequest.h.

◆ WithCopySourceIfModifiedSince() [1/2]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfModifiedSince ( Aws::Utils::DateTime &&  value)
inline

Copies the object if it has been modified since the specified time.

Definition at line 838 of file CopyObjectRequest.h.

◆ WithCopySourceIfModifiedSince() [2/2]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfModifiedSince ( const Aws::Utils::DateTime value)
inline

Copies the object if it has been modified since the specified time.

Definition at line 833 of file CopyObjectRequest.h.

◆ WithCopySourceIfNoneMatch() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfNoneMatch ( Aws::String &&  value)
inline

Copies the object if its entity tag (ETag) is different than the specified ETag.

Definition at line 881 of file CopyObjectRequest.h.

◆ WithCopySourceIfNoneMatch() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfNoneMatch ( const Aws::String value)
inline

Copies the object if its entity tag (ETag) is different than the specified ETag.

Definition at line 875 of file CopyObjectRequest.h.

◆ WithCopySourceIfNoneMatch() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfNoneMatch ( const char *  value)
inline

Copies the object if its entity tag (ETag) is different than the specified ETag.

Definition at line 887 of file CopyObjectRequest.h.

◆ WithCopySourceIfUnmodifiedSince() [1/2]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfUnmodifiedSince ( Aws::Utils::DateTime &&  value)
inline

Copies the object if it hasn't been modified since the specified time.

Definition at line 918 of file CopyObjectRequest.h.

◆ WithCopySourceIfUnmodifiedSince() [2/2]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceIfUnmodifiedSince ( const Aws::Utils::DateTime value)
inline

Copies the object if it hasn't been modified since the specified time.

Definition at line 913 of file CopyObjectRequest.h.

◆ WithCopySourceSSECustomerAlgorithm() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceSSECustomerAlgorithm ( Aws::String &&  value)
inline

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

Definition at line 1892 of file CopyObjectRequest.h.

◆ WithCopySourceSSECustomerAlgorithm() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceSSECustomerAlgorithm ( const Aws::String value)
inline

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

Definition at line 1886 of file CopyObjectRequest.h.

◆ WithCopySourceSSECustomerAlgorithm() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceSSECustomerAlgorithm ( const char *  value)
inline

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

Definition at line 1898 of file CopyObjectRequest.h.

◆ WithCopySourceSSECustomerKey() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceSSECustomerKey ( Aws::String &&  value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Definition at line 1948 of file CopyObjectRequest.h.

◆ WithCopySourceSSECustomerKey() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceSSECustomerKey ( const Aws::String value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Definition at line 1941 of file CopyObjectRequest.h.

◆ WithCopySourceSSECustomerKey() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceSSECustomerKey ( const char *  value)
inline

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Definition at line 1955 of file CopyObjectRequest.h.

◆ WithCopySourceSSECustomerKeyMD5() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceSSECustomerKeyMD5 ( 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 2005 of file CopyObjectRequest.h.

◆ WithCopySourceSSECustomerKeyMD5() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceSSECustomerKeyMD5 ( 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 1998 of file CopyObjectRequest.h.

◆ WithCopySourceSSECustomerKeyMD5() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithCopySourceSSECustomerKeyMD5 ( 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 2012 of file CopyObjectRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 2320 of file CopyObjectRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 2317 of file CopyObjectRequest.h.

◆ WithExpectedBucketOwner() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithExpectedBucketOwner ( Aws::String &&  value)
inline

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2237 of file CopyObjectRequest.h.

◆ WithExpectedBucketOwner() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithExpectedBucketOwner ( const Aws::String value)
inline

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2230 of file CopyObjectRequest.h.

◆ WithExpectedBucketOwner() [3/3]

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

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2244 of file CopyObjectRequest.h.

◆ WithExpectedSourceBucketOwner() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithExpectedSourceBucketOwner ( Aws::String &&  value)
inline

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2294 of file CopyObjectRequest.h.

◆ WithExpectedSourceBucketOwner() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithExpectedSourceBucketOwner ( const Aws::String value)
inline

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2287 of file CopyObjectRequest.h.

◆ WithExpectedSourceBucketOwner() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithExpectedSourceBucketOwner ( const char *  value)
inline

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Definition at line 2301 of file CopyObjectRequest.h.

◆ WithExpires() [1/2]

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

The date and time at which the object is no longer cacheable.

Definition at line 949 of file CopyObjectRequest.h.

◆ WithExpires() [2/2]

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

The date and time at which the object is no longer cacheable.

Definition at line 944 of file CopyObjectRequest.h.

◆ WithGrantFullControl() [1/3]

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

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

This action is not supported by Amazon S3 on Outposts.

Definition at line 992 of file CopyObjectRequest.h.

◆ WithGrantFullControl() [2/3]

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

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

This action is not supported by Amazon S3 on Outposts.

Definition at line 986 of file CopyObjectRequest.h.

◆ WithGrantFullControl() [3/3]

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

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

This action is not supported by Amazon S3 on Outposts.

Definition at line 998 of file CopyObjectRequest.h.

◆ WithGrantRead() [1/3]

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

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1041 of file CopyObjectRequest.h.

◆ WithGrantRead() [2/3]

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

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1035 of file CopyObjectRequest.h.

◆ WithGrantRead() [3/3]

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

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1047 of file CopyObjectRequest.h.

◆ WithGrantReadACP() [1/3]

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

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1090 of file CopyObjectRequest.h.

◆ WithGrantReadACP() [2/3]

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

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1084 of file CopyObjectRequest.h.

◆ WithGrantReadACP() [3/3]

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

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1096 of file CopyObjectRequest.h.

◆ WithGrantWriteACP() [1/3]

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

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1139 of file CopyObjectRequest.h.

◆ WithGrantWriteACP() [2/3]

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

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1133 of file CopyObjectRequest.h.

◆ WithGrantWriteACP() [3/3]

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

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Definition at line 1145 of file CopyObjectRequest.h.

◆ WithKey() [1/3]

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

The key of the destination object.

Definition at line 1181 of file CopyObjectRequest.h.

◆ WithKey() [2/3]

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

The key of the destination object.

Definition at line 1176 of file CopyObjectRequest.h.

◆ WithKey() [3/3]

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

The key of the destination object.

Definition at line 1186 of file CopyObjectRequest.h.

◆ WithMetadata() [1/2]

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

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

Definition at line 1217 of file CopyObjectRequest.h.

◆ WithMetadata() [2/2]

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

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

Definition at line 1212 of file CopyObjectRequest.h.

◆ WithMetadataDirective() [1/2]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithMetadataDirective ( const MetadataDirective value)
inline

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Definition at line 1283 of file CopyObjectRequest.h.

◆ WithMetadataDirective() [2/2]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithMetadataDirective ( MetadataDirective &&  value)
inline

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Definition at line 1289 of file CopyObjectRequest.h.

◆ WithObjectLockLegalHoldStatus() [1/2]

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

Specifies whether you want to apply a Legal Hold to the copied object.

Definition at line 2182 of file CopyObjectRequest.h.

◆ WithObjectLockLegalHoldStatus() [2/2]

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

Specifies whether you want to apply a Legal Hold to the copied object.

Definition at line 2187 of file CopyObjectRequest.h.

◆ WithObjectLockMode() [1/2]

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

The Object Lock mode that you want to apply to the copied object.

Definition at line 2114 of file CopyObjectRequest.h.

◆ WithObjectLockMode() [2/2]

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

The Object Lock mode that you want to apply to the copied object.

Definition at line 2119 of file CopyObjectRequest.h.

◆ WithObjectLockRetainUntilDate() [1/2]

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

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

Definition at line 2156 of file CopyObjectRequest.h.

◆ WithObjectLockRetainUntilDate() [2/2]

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

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

Definition at line 2150 of file CopyObjectRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 2028 of file CopyObjectRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 2031 of file CopyObjectRequest.h.

◆ WithServerSideEncryption() [1/2]

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

◆ WithServerSideEncryption() [2/2]

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

◆ WithSSECustomerAlgorithm() [1/3]

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

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

Definition at line 1530 of file CopyObjectRequest.h.

◆ WithSSECustomerAlgorithm() [2/3]

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

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

Definition at line 1524 of file CopyObjectRequest.h.

◆ WithSSECustomerAlgorithm() [3/3]

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

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

Definition at line 1536 of file CopyObjectRequest.h.

◆ WithSSECustomerKey() [1/3]

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

◆ WithSSECustomerKey() [2/3]

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

◆ WithSSECustomerKey() [3/3]

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

◆ WithSSECustomerKeyMD5() [1/3]

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

◆ WithSSECustomerKeyMD5() [2/3]

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

◆ WithSSECustomerKeyMD5() [3/3]

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

◆ WithSSEKMSEncryptionContext() [1/3]

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

◆ WithSSEKMSEncryptionContext() [2/3]

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

◆ WithSSEKMSEncryptionContext() [3/3]

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

◆ WithSSEKMSKeyId() [1/3]

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

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Definition at line 1744 of file CopyObjectRequest.h.

◆ WithSSEKMSKeyId() [2/3]

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

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Definition at line 1733 of file CopyObjectRequest.h.

◆ WithSSEKMSKeyId() [3/3]

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

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Definition at line 1755 of file CopyObjectRequest.h.

◆ WithStorageClass() [1/2]

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

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Definition at line 1419 of file CopyObjectRequest.h.

◆ WithStorageClass() [2/2]

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

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Definition at line 1430 of file CopyObjectRequest.h.

◆ WithTagging() [1/3]

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

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Definition at line 2081 of file CopyObjectRequest.h.

◆ WithTagging() [2/3]

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

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Definition at line 2074 of file CopyObjectRequest.h.

◆ WithTagging() [3/3]

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

The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Definition at line 2088 of file CopyObjectRequest.h.

◆ WithTaggingDirective() [1/2]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithTaggingDirective ( const TaggingDirective value)
inline

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Definition at line 1320 of file CopyObjectRequest.h.

◆ WithTaggingDirective() [2/2]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::WithTaggingDirective ( TaggingDirective &&  value)
inline

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Definition at line 1326 of file CopyObjectRequest.h.

◆ WithWebsiteRedirectLocation() [1/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::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.

Definition at line 1480 of file CopyObjectRequest.h.

◆ WithWebsiteRedirectLocation() [2/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::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.

Definition at line 1473 of file CopyObjectRequest.h.

◆ WithWebsiteRedirectLocation() [3/3]

CopyObjectRequest& Aws::S3::Model::CopyObjectRequest::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.

Definition at line 1487 of file CopyObjectRequest.h.


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