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

#include <DeleteObjectRequest.h>

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

Public Member Functions

 DeleteObjectRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
void AddQueryStringParameters (Aws::Http::URI &uri) const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
DeleteObjectRequestWithBucket (const Aws::String &value)
 
DeleteObjectRequestWithBucket (Aws::String &&value)
 
DeleteObjectRequestWithBucket (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)
 
DeleteObjectRequestWithKey (const Aws::String &value)
 
DeleteObjectRequestWithKey (Aws::String &&value)
 
DeleteObjectRequestWithKey (const char *value)
 
const Aws::StringGetMFA () const
 
bool MFAHasBeenSet () const
 
void SetMFA (const Aws::String &value)
 
void SetMFA (Aws::String &&value)
 
void SetMFA (const char *value)
 
DeleteObjectRequestWithMFA (const Aws::String &value)
 
DeleteObjectRequestWithMFA (Aws::String &&value)
 
DeleteObjectRequestWithMFA (const char *value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
DeleteObjectRequestWithVersionId (const Aws::String &value)
 
DeleteObjectRequestWithVersionId (Aws::String &&value)
 
DeleteObjectRequestWithVersionId (const char *value)
 
const RequestPayerGetRequestPayer () const
 
bool RequestPayerHasBeenSet () const
 
void SetRequestPayer (const RequestPayer &value)
 
void SetRequestPayer (RequestPayer &&value)
 
DeleteObjectRequestWithRequestPayer (const RequestPayer &value)
 
DeleteObjectRequestWithRequestPayer (RequestPayer &&value)
 
bool GetBypassGovernanceRetention () const
 
bool BypassGovernanceRetentionHasBeenSet () const
 
void SetBypassGovernanceRetention (bool value)
 
DeleteObjectRequestWithBypassGovernanceRetention (bool value)
 
const Aws::StringGetExpectedBucketOwner () const
 
bool ExpectedBucketOwnerHasBeenSet () const
 
void SetExpectedBucketOwner (const Aws::String &value)
 
void SetExpectedBucketOwner (Aws::String &&value)
 
void SetExpectedBucketOwner (const char *value)
 
DeleteObjectRequestWithExpectedBucketOwner (const Aws::String &value)
 
DeleteObjectRequestWithExpectedBucketOwner (Aws::String &&value)
 
DeleteObjectRequestWithExpectedBucketOwner (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)
 
DeleteObjectRequestWithCustomizedAccessLogTag (const Aws::Map< Aws::String, Aws::String > &value)
 
DeleteObjectRequestWithCustomizedAccessLogTag (Aws::Map< Aws::String, Aws::String > &&value)
 
DeleteObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, const Aws::String &value)
 
DeleteObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const Aws::String &value)
 
DeleteObjectRequestAddCustomizedAccessLogTag (const Aws::String &key, Aws::String &&value)
 
DeleteObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, Aws::String &&value)
 
DeleteObjectRequestAddCustomizedAccessLogTag (const char *key, Aws::String &&value)
 
DeleteObjectRequestAddCustomizedAccessLogTag (Aws::String &&key, const char *value)
 
DeleteObjectRequestAddCustomizedAccessLogTag (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 27 of file DeleteObjectRequest.h.

Constructor & Destructor Documentation

◆ DeleteObjectRequest()

Aws::S3::Model::DeleteObjectRequest::DeleteObjectRequest ( )

Member Function Documentation

◆ AddCustomizedAccessLogTag() [1/7]

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

Definition at line 490 of file DeleteObjectRequest.h.

◆ AddCustomizedAccessLogTag() [2/7]

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

Definition at line 484 of file DeleteObjectRequest.h.

◆ AddCustomizedAccessLogTag() [3/7]

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

Definition at line 496 of file DeleteObjectRequest.h.

◆ AddCustomizedAccessLogTag() [4/7]

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

Definition at line 487 of file DeleteObjectRequest.h.

◆ AddCustomizedAccessLogTag() [5/7]

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

Definition at line 481 of file DeleteObjectRequest.h.

◆ AddCustomizedAccessLogTag() [6/7]

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

Definition at line 493 of file DeleteObjectRequest.h.

◆ AddCustomizedAccessLogTag() [7/7]

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

Definition at line 499 of file DeleteObjectRequest.h.

◆ AddQueryStringParameters()

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

The bucket name of the bucket containing the object.

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 85 of file DeleteObjectRequest.h.

◆ BypassGovernanceRetentionHasBeenSet()

bool Aws::S3::Model::DeleteObjectRequest::BypassGovernanceRetentionHasBeenSet ( ) const
inline

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

Definition at line 390 of file DeleteObjectRequest.h.

◆ CustomizedAccessLogTagHasBeenSet()

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

Definition at line 466 of file DeleteObjectRequest.h.

◆ ExpectedBucketOwnerHasBeenSet()

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

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

Definition at line 417 of file DeleteObjectRequest.h.

◆ GetBucket()

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

The bucket name of the bucket containing the object.

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 64 of file DeleteObjectRequest.h.

◆ GetBypassGovernanceRetention()

bool Aws::S3::Model::DeleteObjectRequest::GetBypassGovernanceRetention ( ) const
inline

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

Definition at line 384 of file DeleteObjectRequest.h.

◆ GetCustomizedAccessLogTag()

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

Definition at line 463 of file DeleteObjectRequest.h.

◆ GetExpectedBucketOwner()

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

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

Definition at line 410 of file DeleteObjectRequest.h.

◆ GetKey()

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

Key name of the object to delete.

Definition at line 217 of file DeleteObjectRequest.h.

◆ GetMFA()

const Aws::String& Aws::S3::Model::DeleteObjectRequest::GetMFA ( ) const
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 261 of file DeleteObjectRequest.h.

◆ GetRequestPayer()

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

Definition at line 362 of file DeleteObjectRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::S3::S3Request.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file DeleteObjectRequest.h.

◆ GetVersionId()

const Aws::String& Aws::S3::Model::DeleteObjectRequest::GetVersionId ( ) const
inline

VersionId used to reference a specific version of the object.

Definition at line 323 of file DeleteObjectRequest.h.

◆ KeyHasBeenSet()

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

Key name of the object to delete.

Definition at line 222 of file DeleteObjectRequest.h.

◆ MFAHasBeenSet()

bool Aws::S3::Model::DeleteObjectRequest::MFAHasBeenSet ( ) const
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 269 of file DeleteObjectRequest.h.

◆ RequestPayerHasBeenSet()

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

Definition at line 365 of file DeleteObjectRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetBucket() [1/3]

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

The bucket name of the bucket containing the object.

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 127 of file DeleteObjectRequest.h.

◆ SetBucket() [2/3]

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

The bucket name of the bucket containing the object.

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 106 of file DeleteObjectRequest.h.

◆ SetBucket() [3/3]

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

The bucket name of the bucket containing the object.

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 148 of file DeleteObjectRequest.h.

◆ SetBypassGovernanceRetention()

void Aws::S3::Model::DeleteObjectRequest::SetBypassGovernanceRetention ( bool  value)
inline

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

Definition at line 396 of file DeleteObjectRequest.h.

◆ SetCustomizedAccessLogTag() [1/2]

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

Definition at line 472 of file DeleteObjectRequest.h.

◆ SetCustomizedAccessLogTag() [2/2]

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

Definition at line 469 of file DeleteObjectRequest.h.

◆ SetExpectedBucketOwner() [1/3]

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

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

Definition at line 431 of file DeleteObjectRequest.h.

◆ SetExpectedBucketOwner() [2/3]

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

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

Definition at line 424 of file DeleteObjectRequest.h.

◆ SetExpectedBucketOwner() [3/3]

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

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

Definition at line 438 of file DeleteObjectRequest.h.

◆ SetKey() [1/3]

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

Key name of the object to delete.

Definition at line 232 of file DeleteObjectRequest.h.

◆ SetKey() [2/3]

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

Key name of the object to delete.

Definition at line 227 of file DeleteObjectRequest.h.

◆ SetKey() [3/3]

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

Key name of the object to delete.

Definition at line 237 of file DeleteObjectRequest.h.

◆ SetMFA() [1/3]

void Aws::S3::Model::DeleteObjectRequest::SetMFA ( Aws::String &&  value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 285 of file DeleteObjectRequest.h.

◆ SetMFA() [2/3]

void Aws::S3::Model::DeleteObjectRequest::SetMFA ( const Aws::String value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 277 of file DeleteObjectRequest.h.

◆ SetMFA() [3/3]

void Aws::S3::Model::DeleteObjectRequest::SetMFA ( const char *  value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 293 of file DeleteObjectRequest.h.

◆ SetRequestPayer() [1/2]

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

Definition at line 368 of file DeleteObjectRequest.h.

◆ SetRequestPayer() [2/2]

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

Definition at line 371 of file DeleteObjectRequest.h.

◆ SetVersionId() [1/3]

void Aws::S3::Model::DeleteObjectRequest::SetVersionId ( Aws::String &&  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 338 of file DeleteObjectRequest.h.

◆ SetVersionId() [2/3]

void Aws::S3::Model::DeleteObjectRequest::SetVersionId ( const Aws::String value)
inline

VersionId used to reference a specific version of the object.

Definition at line 333 of file DeleteObjectRequest.h.

◆ SetVersionId() [3/3]

void Aws::S3::Model::DeleteObjectRequest::SetVersionId ( const char *  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 343 of file DeleteObjectRequest.h.

◆ VersionIdHasBeenSet()

bool Aws::S3::Model::DeleteObjectRequest::VersionIdHasBeenSet ( ) const
inline

VersionId used to reference a specific version of the object.

Definition at line 328 of file DeleteObjectRequest.h.

◆ WithBucket() [1/3]

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

The bucket name of the bucket containing the object.

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 190 of file DeleteObjectRequest.h.

◆ WithBucket() [2/3]

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

The bucket name of the bucket containing the object.

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 169 of file DeleteObjectRequest.h.

◆ WithBucket() [3/3]

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

The bucket name of the bucket containing the object.

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 211 of file DeleteObjectRequest.h.

◆ WithBypassGovernanceRetention()

DeleteObjectRequest& Aws::S3::Model::DeleteObjectRequest::WithBypassGovernanceRetention ( bool  value)
inline

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.

Definition at line 402 of file DeleteObjectRequest.h.

◆ WithCustomizedAccessLogTag() [1/2]

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

Definition at line 478 of file DeleteObjectRequest.h.

◆ WithCustomizedAccessLogTag() [2/2]

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

Definition at line 475 of file DeleteObjectRequest.h.

◆ WithExpectedBucketOwner() [1/3]

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

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

Definition at line 452 of file DeleteObjectRequest.h.

◆ WithExpectedBucketOwner() [2/3]

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

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

Definition at line 445 of file DeleteObjectRequest.h.

◆ WithExpectedBucketOwner() [3/3]

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

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

Definition at line 459 of file DeleteObjectRequest.h.

◆ WithKey() [1/3]

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

Key name of the object to delete.

Definition at line 247 of file DeleteObjectRequest.h.

◆ WithKey() [2/3]

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

Key name of the object to delete.

Definition at line 242 of file DeleteObjectRequest.h.

◆ WithKey() [3/3]

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

Key name of the object to delete.

Definition at line 252 of file DeleteObjectRequest.h.

◆ WithMFA() [1/3]

DeleteObjectRequest& Aws::S3::Model::DeleteObjectRequest::WithMFA ( Aws::String &&  value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 309 of file DeleteObjectRequest.h.

◆ WithMFA() [2/3]

DeleteObjectRequest& Aws::S3::Model::DeleteObjectRequest::WithMFA ( const Aws::String value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 301 of file DeleteObjectRequest.h.

◆ WithMFA() [3/3]

DeleteObjectRequest& Aws::S3::Model::DeleteObjectRequest::WithMFA ( const char *  value)
inline

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.

Definition at line 317 of file DeleteObjectRequest.h.

◆ WithRequestPayer() [1/2]

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

Definition at line 374 of file DeleteObjectRequest.h.

◆ WithRequestPayer() [2/2]

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

Definition at line 377 of file DeleteObjectRequest.h.

◆ WithVersionId() [1/3]

DeleteObjectRequest& Aws::S3::Model::DeleteObjectRequest::WithVersionId ( Aws::String &&  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 353 of file DeleteObjectRequest.h.

◆ WithVersionId() [2/3]

DeleteObjectRequest& Aws::S3::Model::DeleteObjectRequest::WithVersionId ( const Aws::String value)
inline

VersionId used to reference a specific version of the object.

Definition at line 348 of file DeleteObjectRequest.h.

◆ WithVersionId() [3/3]

DeleteObjectRequest& Aws::S3::Model::DeleteObjectRequest::WithVersionId ( const char *  value)
inline

VersionId used to reference a specific version of the object.

Definition at line 358 of file DeleteObjectRequest.h.


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