aws_sdk_s3/operation/delete_bucket_policy/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_bucket_policy::_delete_bucket_policy_output::DeleteBucketPolicyOutputBuilder;
3
4pub use crate::operation::delete_bucket_policy::_delete_bucket_policy_input::DeleteBucketPolicyInputBuilder;
5
6impl crate::operation::delete_bucket_policy::builders::DeleteBucketPolicyInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::delete_bucket_policy::DeleteBucketPolicyOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::delete_bucket_policy::DeleteBucketPolicyError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.delete_bucket_policy();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DeleteBucketPolicy`.
24///
25/// <p>Deletes the policy of a specified bucket.</p><note>
26/// <p><b>Directory buckets </b> - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i> </code>. Virtual-hosted-style requests aren't supported. For more information about endpoints in Availability Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/endpoint-directory-buckets-AZ.html">Regional and Zonal endpoints for directory buckets in Availability Zones</a> in the <i>Amazon S3 User Guide</i>. For more information about endpoints in Local Zones, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-lzs-for-directory-buckets.html">Concepts for directory buckets in Local Zones</a> in the <i>Amazon S3 User Guide</i>.</p>
27/// </note>
28/// <dl>
29/// <dt>
30/// Permissions
31/// </dt>
32/// <dd>
33/// <p>If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must both have the <code>DeleteBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.</p>
34/// <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p><important>
35/// <p>To ensure that bucket owners don't inadvertently lock themselves out of their own buckets, the root principal in a bucket owner's Amazon Web Services account can perform the <code>GetBucketPolicy</code>, <code>PutBucketPolicy</code>, and <code>DeleteBucketPolicy</code> API actions, even if their bucket policy explicitly denies the root principal's access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.</p>
36/// </important>
37/// <ul>
38/// <li>
39/// <p><b>General purpose bucket permissions</b> - The <code>s3:DeleteBucketPolicy</code> permission is required in a policy. For more information about general purpose buckets bucket policies, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html">Using Bucket Policies and User Policies</a> in the <i>Amazon S3 User Guide</i>.</p></li>
40/// <li>
41/// <p><b>Directory bucket permissions</b> - To grant access to this API operation, you must have the <code>s3express:DeleteBucketPolicy</code> permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn't supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-express-security-iam.html">Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone</a> in the <i>Amazon S3 User Guide</i>.</p></li>
42/// </ul>
43/// </dd>
44/// <dt>
45/// HTTP Host header syntax
46/// </dt>
47/// <dd>
48/// <p><b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p>
49/// </dd>
50/// </dl>
51/// <p>The following operations are related to <code>DeleteBucketPolicy</code></p>
52/// <ul>
53/// <li>
54/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></p></li>
55/// <li>
56/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a></p></li>
57/// </ul><important>
58/// <p>You must URL encode any signed header values that contain spaces. For example, if your header value is <code>my file.txt</code>, containing two spaces after <code>my</code>, you must URL encode this value to <code>my%20%20file.txt</code>.</p>
59/// </important>
60#[derive(::std::clone::Clone, ::std::fmt::Debug)]
61pub struct DeleteBucketPolicyFluentBuilder {
62    handle: ::std::sync::Arc<crate::client::Handle>,
63    inner: crate::operation::delete_bucket_policy::builders::DeleteBucketPolicyInputBuilder,
64    config_override: ::std::option::Option<crate::config::Builder>,
65}
66impl
67    crate::client::customize::internal::CustomizableSend<
68        crate::operation::delete_bucket_policy::DeleteBucketPolicyOutput,
69        crate::operation::delete_bucket_policy::DeleteBucketPolicyError,
70    > for DeleteBucketPolicyFluentBuilder
71{
72    fn send(
73        self,
74        config_override: crate::config::Builder,
75    ) -> crate::client::customize::internal::BoxFuture<
76        crate::client::customize::internal::SendResult<
77            crate::operation::delete_bucket_policy::DeleteBucketPolicyOutput,
78            crate::operation::delete_bucket_policy::DeleteBucketPolicyError,
79        >,
80    > {
81        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
82    }
83}
84impl DeleteBucketPolicyFluentBuilder {
85    /// Creates a new `DeleteBucketPolicyFluentBuilder`.
86    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
87        Self {
88            handle,
89            inner: ::std::default::Default::default(),
90            config_override: ::std::option::Option::None,
91        }
92    }
93    /// Access the DeleteBucketPolicy as a reference.
94    pub fn as_input(&self) -> &crate::operation::delete_bucket_policy::builders::DeleteBucketPolicyInputBuilder {
95        &self.inner
96    }
97    /// Sends the request and returns the response.
98    ///
99    /// If an error occurs, an `SdkError` will be returned with additional details that
100    /// can be matched against.
101    ///
102    /// By default, any retryable failures will be retried twice. Retry behavior
103    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
104    /// set when configuring the client.
105    pub async fn send(
106        self,
107    ) -> ::std::result::Result<
108        crate::operation::delete_bucket_policy::DeleteBucketPolicyOutput,
109        ::aws_smithy_runtime_api::client::result::SdkError<
110            crate::operation::delete_bucket_policy::DeleteBucketPolicyError,
111            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
112        >,
113    > {
114        let input = self
115            .inner
116            .build()
117            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
118        let runtime_plugins = crate::operation::delete_bucket_policy::DeleteBucketPolicy::operation_runtime_plugins(
119            self.handle.runtime_plugins.clone(),
120            &self.handle.conf,
121            self.config_override,
122        );
123        crate::operation::delete_bucket_policy::DeleteBucketPolicy::orchestrate(&runtime_plugins, input).await
124    }
125
126    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
127    pub fn customize(
128        self,
129    ) -> crate::client::customize::CustomizableOperation<
130        crate::operation::delete_bucket_policy::DeleteBucketPolicyOutput,
131        crate::operation::delete_bucket_policy::DeleteBucketPolicyError,
132        Self,
133    > {
134        crate::client::customize::CustomizableOperation::new(self)
135    }
136    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
137        self.set_config_override(::std::option::Option::Some(config_override.into()));
138        self
139    }
140
141    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
142        self.config_override = config_override;
143        self
144    }
145    /// <p>The bucket name.</p>
146    /// <p><b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i> </code>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i></p>
147    pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
148        self.inner = self.inner.bucket(input.into());
149        self
150    }
151    /// <p>The bucket name.</p>
152    /// <p><b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i> </code>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i></p>
153    pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
154        self.inner = self.inner.set_bucket(input);
155        self
156    }
157    /// <p>The bucket name.</p>
158    /// <p><b>Directory buckets </b> - When you use this operation with a directory bucket, you must use path-style requests in the format <code>https://s3express-control.<i>region-code</i>.amazonaws.com/<i>bucket-name</i> </code>. Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format <code> <i>bucket-base-name</i>--<i>zone-id</i>--x-s3</code> (for example, <code> <i>DOC-EXAMPLE-BUCKET</i>--<i>usw2-az1</i>--x-s3</code>). For information about bucket naming restrictions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/directory-bucket-naming-rules.html">Directory bucket naming rules</a> in the <i>Amazon S3 User Guide</i></p>
159    pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
160        self.inner.get_bucket()
161    }
162    /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p><note>
163    /// <p>For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code <code>501 Not Implemented</code>.</p>
164    /// </note>
165    pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
166        self.inner = self.inner.expected_bucket_owner(input.into());
167        self
168    }
169    /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p><note>
170    /// <p>For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code <code>501 Not Implemented</code>.</p>
171    /// </note>
172    pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
173        self.inner = self.inner.set_expected_bucket_owner(input);
174        self
175    }
176    /// <p>The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code <code>403 Forbidden</code> (access denied).</p><note>
177    /// <p>For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code <code>501 Not Implemented</code>.</p>
178    /// </note>
179    pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
180        self.inner.get_expected_bucket_owner()
181    }
182}