/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include <aws/s3/S3_EXPORTS.h> #include <aws/s3/S3Request.h> #include <aws/core/utils/memory/stl/AWSString.h> #include <aws/s3/model/RequestPayer.h> #include <aws/core/utils/memory/stl/AWSMap.h> #include <utility> namespace Aws { namespace Http { class URI; } //namespace Http namespace S3 { namespace Model { /** */ class DeleteObjectRequest : public S3Request { public: AWS_S3_API DeleteObjectRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DeleteObject"; } AWS_S3_API Aws::String SerializePayload() const override; AWS_S3_API void AddQueryStringParameters(Aws::Http::URI& uri) const override; AWS_S3_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** * Helper function to collect parameters (configurable and static hardcoded) required for endpoint computation. */ AWS_S3_API EndpointParameters GetEndpointContextParams() const override; /** * <p>The bucket name of the bucket containing the object. </p> <p>When using this * action with an access point, you must direct requests to the access point * hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline const Aws::String& GetBucket() const{ return m_bucket; } /** * <p>The bucket name of the bucket containing the object. </p> <p>When using this * action with an access point, you must direct requests to the access point * hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline bool BucketHasBeenSet() const { return m_bucketHasBeenSet; } /** * <p>The bucket name of the bucket containing the object. </p> <p>When using this * action with an access point, you must direct requests to the access point * hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline void SetBucket(const Aws::String& value) { m_bucketHasBeenSet = true; m_bucket = value; } /** * <p>The bucket name of the bucket containing the object. </p> <p>When using this * action with an access point, you must direct requests to the access point * hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline void SetBucket(Aws::String&& value) { m_bucketHasBeenSet = true; m_bucket = std::move(value); } /** * <p>The bucket name of the bucket containing the object. </p> <p>When using this * action with an access point, you must direct requests to the access point * hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline void SetBucket(const char* value) { m_bucketHasBeenSet = true; m_bucket.assign(value); } /** * <p>The bucket name of the bucket containing the object. </p> <p>When using this * action with an access point, you must direct requests to the access point * hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline DeleteObjectRequest& WithBucket(const Aws::String& value) { SetBucket(value); return *this;} /** * <p>The bucket name of the bucket containing the object. </p> <p>When using this * action with an access point, you must direct requests to the access point * hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline DeleteObjectRequest& WithBucket(Aws::String&& value) { SetBucket(std::move(value)); return *this;} /** * <p>The bucket name of the bucket containing the object. </p> <p>When using this * action with an access point, you must direct requests to the access point * hostname. The access point hostname takes the form * <i>AccessPointName</i>-<i>AccountId</i>.s3-accesspoint.<i>Region</i>.amazonaws.com. * When using this action with an access point through the Amazon Web Services * SDKs, you provide the access point ARN in place of the bucket name. For more * information about access point ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html">Using * access points</a> in the <i>Amazon S3 User Guide</i>.</p> <p>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 <code> * <i>AccessPointName</i>-<i>AccountId</i>.<i>outpostID</i>.s3-outposts.<i>Region</i>.amazonaws.com</code>. * When using this action with S3 on Outposts through the Amazon Web Services SDKs, * you provide the Outposts bucket ARN in place of the bucket name. For more * information about S3 on Outposts ARNs, see <a * href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html">Using * Amazon S3 on Outposts</a> in the <i>Amazon S3 User Guide</i>.</p> */ inline DeleteObjectRequest& WithBucket(const char* value) { SetBucket(value); return *this;} /** * <p>Key name of the object to delete.</p> */ inline const Aws::String& GetKey() const{ return m_key; } /** * <p>Key name of the object to delete.</p> */ inline bool KeyHasBeenSet() const { return m_keyHasBeenSet; } /** * <p>Key name of the object to delete.</p> */ inline void SetKey(const Aws::String& value) { m_keyHasBeenSet = true; m_key = value; } /** * <p>Key name of the object to delete.</p> */ inline void SetKey(Aws::String&& value) { m_keyHasBeenSet = true; m_key = std::move(value); } /** * <p>Key name of the object to delete.</p> */ inline void SetKey(const char* value) { m_keyHasBeenSet = true; m_key.assign(value); } /** * <p>Key name of the object to delete.</p> */ inline DeleteObjectRequest& WithKey(const Aws::String& value) { SetKey(value); return *this;} /** * <p>Key name of the object to delete.</p> */ inline DeleteObjectRequest& WithKey(Aws::String&& value) { SetKey(std::move(value)); return *this;} /** * <p>Key name of the object to delete.</p> */ inline DeleteObjectRequest& WithKey(const char* value) { SetKey(value); return *this;} /** * <p>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.</p> */ inline const Aws::String& GetMFA() const{ return m_mFA; } /** * <p>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.</p> */ inline bool MFAHasBeenSet() const { return m_mFAHasBeenSet; } /** * <p>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.</p> */ inline void SetMFA(const Aws::String& value) { m_mFAHasBeenSet = true; m_mFA = value; } /** * <p>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.</p> */ inline void SetMFA(Aws::String&& value) { m_mFAHasBeenSet = true; m_mFA = std::move(value); } /** * <p>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.</p> */ inline void SetMFA(const char* value) { m_mFAHasBeenSet = true; m_mFA.assign(value); } /** * <p>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.</p> */ inline DeleteObjectRequest& WithMFA(const Aws::String& value) { SetMFA(value); return *this;} /** * <p>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.</p> */ inline DeleteObjectRequest& WithMFA(Aws::String&& value) { SetMFA(std::move(value)); return *this;} /** * <p>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.</p> */ inline DeleteObjectRequest& WithMFA(const char* value) { SetMFA(value); return *this;} /** * <p>VersionId used to reference a specific version of the object.</p> */ inline const Aws::String& GetVersionId() const{ return m_versionId; } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline bool VersionIdHasBeenSet() const { return m_versionIdHasBeenSet; } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline void SetVersionId(const Aws::String& value) { m_versionIdHasBeenSet = true; m_versionId = value; } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline void SetVersionId(Aws::String&& value) { m_versionIdHasBeenSet = true; m_versionId = std::move(value); } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline void SetVersionId(const char* value) { m_versionIdHasBeenSet = true; m_versionId.assign(value); } /** * <p>VersionId used to reference a specific version of the object.</p> */ inline DeleteObjectRequest& WithVersionId(const Aws::String& value) { SetVersionId(value); return *this;} /** * <p>VersionId used to reference a specific version of the object.</p> */ inline DeleteObjectRequest& WithVersionId(Aws::String&& value) { SetVersionId(std::move(value)); return *this;} /** * <p>VersionId used to reference a specific version of the object.</p> */ inline DeleteObjectRequest& WithVersionId(const char* value) { SetVersionId(value); return *this;} inline const RequestPayer& GetRequestPayer() const{ return m_requestPayer; } inline bool RequestPayerHasBeenSet() const { return m_requestPayerHasBeenSet; } inline void SetRequestPayer(const RequestPayer& value) { m_requestPayerHasBeenSet = true; m_requestPayer = value; } inline void SetRequestPayer(RequestPayer&& value) { m_requestPayerHasBeenSet = true; m_requestPayer = std::move(value); } inline DeleteObjectRequest& WithRequestPayer(const RequestPayer& value) { SetRequestPayer(value); return *this;} inline DeleteObjectRequest& WithRequestPayer(RequestPayer&& value) { SetRequestPayer(std::move(value)); return *this;} /** * <p>Indicates whether S3 Object Lock should bypass Governance-mode restrictions * to process this operation. To use this header, you must have the * <code>s3:BypassGovernanceRetention</code> permission.</p> */ inline bool GetBypassGovernanceRetention() const{ return m_bypassGovernanceRetention; } /** * <p>Indicates whether S3 Object Lock should bypass Governance-mode restrictions * to process this operation. To use this header, you must have the * <code>s3:BypassGovernanceRetention</code> permission.</p> */ inline bool BypassGovernanceRetentionHasBeenSet() const { return m_bypassGovernanceRetentionHasBeenSet; } /** * <p>Indicates whether S3 Object Lock should bypass Governance-mode restrictions * to process this operation. To use this header, you must have the * <code>s3:BypassGovernanceRetention</code> permission.</p> */ inline void SetBypassGovernanceRetention(bool value) { m_bypassGovernanceRetentionHasBeenSet = true; m_bypassGovernanceRetention = value; } /** * <p>Indicates whether S3 Object Lock should bypass Governance-mode restrictions * to process this operation. To use this header, you must have the * <code>s3:BypassGovernanceRetention</code> permission.</p> */ inline DeleteObjectRequest& WithBypassGovernanceRetention(bool value) { SetBypassGovernanceRetention(value); return *this;} /** * <p>The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request fails with the HTTP status code <code>403 * Forbidden</code> (access denied).</p> */ inline const Aws::String& GetExpectedBucketOwner() const{ return m_expectedBucketOwner; } /** * <p>The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request fails with the HTTP status code <code>403 * Forbidden</code> (access denied).</p> */ inline bool ExpectedBucketOwnerHasBeenSet() const { return m_expectedBucketOwnerHasBeenSet; } /** * <p>The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request fails with the HTTP status code <code>403 * Forbidden</code> (access denied).</p> */ inline void SetExpectedBucketOwner(const Aws::String& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = value; } /** * <p>The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request fails with the HTTP status code <code>403 * Forbidden</code> (access denied).</p> */ inline void SetExpectedBucketOwner(Aws::String&& value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner = std::move(value); } /** * <p>The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request fails with the HTTP status code <code>403 * Forbidden</code> (access denied).</p> */ inline void SetExpectedBucketOwner(const char* value) { m_expectedBucketOwnerHasBeenSet = true; m_expectedBucketOwner.assign(value); } /** * <p>The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request fails with the HTTP status code <code>403 * Forbidden</code> (access denied).</p> */ inline DeleteObjectRequest& WithExpectedBucketOwner(const Aws::String& value) { SetExpectedBucketOwner(value); return *this;} /** * <p>The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request fails with the HTTP status code <code>403 * Forbidden</code> (access denied).</p> */ inline DeleteObjectRequest& WithExpectedBucketOwner(Aws::String&& value) { SetExpectedBucketOwner(std::move(value)); return *this;} /** * <p>The account ID of the expected bucket owner. If the bucket is owned by a * different account, the request fails with the HTTP status code <code>403 * Forbidden</code> (access denied).</p> */ inline DeleteObjectRequest& WithExpectedBucketOwner(const char* value) { SetExpectedBucketOwner(value); return *this;} inline const Aws::Map<Aws::String, Aws::String>& GetCustomizedAccessLogTag() const{ return m_customizedAccessLogTag; } inline bool CustomizedAccessLogTagHasBeenSet() const { return m_customizedAccessLogTagHasBeenSet; } inline void SetCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = value; } inline void SetCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag = std::move(value); } inline DeleteObjectRequest& WithCustomizedAccessLogTag(const Aws::Map<Aws::String, Aws::String>& value) { SetCustomizedAccessLogTag(value); return *this;} inline DeleteObjectRequest& WithCustomizedAccessLogTag(Aws::Map<Aws::String, Aws::String>&& value) { SetCustomizedAccessLogTag(std::move(value)); return *this;} inline DeleteObjectRequest& AddCustomizedAccessLogTag(const Aws::String& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } inline DeleteObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, const Aws::String& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline DeleteObjectRequest& AddCustomizedAccessLogTag(const Aws::String& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline DeleteObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), std::move(value)); return *this; } inline DeleteObjectRequest& AddCustomizedAccessLogTag(const char* key, Aws::String&& value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, std::move(value)); return *this; } inline DeleteObjectRequest& AddCustomizedAccessLogTag(Aws::String&& key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(std::move(key), value); return *this; } inline DeleteObjectRequest& AddCustomizedAccessLogTag(const char* key, const char* value) { m_customizedAccessLogTagHasBeenSet = true; m_customizedAccessLogTag.emplace(key, value); return *this; } private: Aws::String m_bucket; bool m_bucketHasBeenSet = false; Aws::String m_key; bool m_keyHasBeenSet = false; Aws::String m_mFA; bool m_mFAHasBeenSet = false; Aws::String m_versionId; bool m_versionIdHasBeenSet = false; RequestPayer m_requestPayer; bool m_requestPayerHasBeenSet = false; bool m_bypassGovernanceRetention; bool m_bypassGovernanceRetentionHasBeenSet = false; Aws::String m_expectedBucketOwner; bool m_expectedBucketOwnerHasBeenSet = false; Aws::Map<Aws::String, Aws::String> m_customizedAccessLogTag; bool m_customizedAccessLogTagHasBeenSet = false; }; } // namespace Model } // namespace S3 } // namespace Aws