aws_sdk_s3/operation/delete_bucket/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_bucket::_delete_bucket_output::DeleteBucketOutputBuilder;
3
4pub use crate::operation::delete_bucket::_delete_bucket_input::DeleteBucketInputBuilder;
5
6impl crate::operation::delete_bucket::builders::DeleteBucketInputBuilder {
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::DeleteBucketOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::delete_bucket::DeleteBucketError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.delete_bucket();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DeleteBucket`.
24///
25/// <p>Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.</p><note>
26/// <ul>
27/// <li>
28/// <p><b>Directory buckets</b> - If multipart uploads in a directory bucket are in progress, you can't delete the bucket until all the in-progress multipart uploads are aborted or completed.</p></li>
29/// <li>
30/// <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></li>
31/// </ul>
32/// </note>
33/// <dl>
34/// <dt>
35/// Permissions
36/// </dt>
37/// <dd>
38/// <ul>
39/// <li>
40/// <p><b>General purpose bucket permissions</b> - You must have the <code>s3:DeleteBucket</code> permission on the specified bucket in a policy.</p></li>
41/// <li>
42/// <p><b>Directory bucket permissions</b> - You must have the <code>s3express:DeleteBucket</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>
43/// </ul>
44/// </dd>
45/// <dt>
46/// HTTP Host header syntax
47/// </dt>
48/// <dd>
49/// <p><b>Directory buckets </b> - The HTTP Host header syntax is <code>s3express-control.<i>region-code</i>.amazonaws.com</code>.</p>
50/// </dd>
51/// </dl>
52/// <p>The following operations are related to <code>DeleteBucket</code>:</p>
53/// <ul>
54/// <li>
55/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html">CreateBucket</a></p></li>
56/// <li>
57/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html">DeleteObject</a></p></li>
58/// </ul><important>
59/// <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>
60/// </important>
61#[derive(::std::clone::Clone, ::std::fmt::Debug)]
62pub struct DeleteBucketFluentBuilder {
63 handle: ::std::sync::Arc<crate::client::Handle>,
64 inner: crate::operation::delete_bucket::builders::DeleteBucketInputBuilder,
65 config_override: ::std::option::Option<crate::config::Builder>,
66}
67impl
68 crate::client::customize::internal::CustomizableSend<
69 crate::operation::delete_bucket::DeleteBucketOutput,
70 crate::operation::delete_bucket::DeleteBucketError,
71 > for DeleteBucketFluentBuilder
72{
73 fn send(
74 self,
75 config_override: crate::config::Builder,
76 ) -> crate::client::customize::internal::BoxFuture<
77 crate::client::customize::internal::SendResult<
78 crate::operation::delete_bucket::DeleteBucketOutput,
79 crate::operation::delete_bucket::DeleteBucketError,
80 >,
81 > {
82 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
83 }
84}
85impl DeleteBucketFluentBuilder {
86 /// Creates a new `DeleteBucketFluentBuilder`.
87 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
88 Self {
89 handle,
90 inner: ::std::default::Default::default(),
91 config_override: ::std::option::Option::None,
92 }
93 }
94 /// Access the DeleteBucket as a reference.
95 pub fn as_input(&self) -> &crate::operation::delete_bucket::builders::DeleteBucketInputBuilder {
96 &self.inner
97 }
98 /// Sends the request and returns the response.
99 ///
100 /// If an error occurs, an `SdkError` will be returned with additional details that
101 /// can be matched against.
102 ///
103 /// By default, any retryable failures will be retried twice. Retry behavior
104 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
105 /// set when configuring the client.
106 pub async fn send(
107 self,
108 ) -> ::std::result::Result<
109 crate::operation::delete_bucket::DeleteBucketOutput,
110 ::aws_smithy_runtime_api::client::result::SdkError<
111 crate::operation::delete_bucket::DeleteBucketError,
112 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
113 >,
114 > {
115 let input = self
116 .inner
117 .build()
118 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
119 let runtime_plugins = crate::operation::delete_bucket::DeleteBucket::operation_runtime_plugins(
120 self.handle.runtime_plugins.clone(),
121 &self.handle.conf,
122 self.config_override,
123 );
124 crate::operation::delete_bucket::DeleteBucket::orchestrate(&runtime_plugins, input).await
125 }
126
127 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
128 pub fn customize(
129 self,
130 ) -> crate::client::customize::CustomizableOperation<
131 crate::operation::delete_bucket::DeleteBucketOutput,
132 crate::operation::delete_bucket::DeleteBucketError,
133 Self,
134 > {
135 crate::client::customize::CustomizableOperation::new(self)
136 }
137 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
138 self.set_config_override(::std::option::Option::Some(config_override.into()));
139 self
140 }
141
142 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
143 self.config_override = config_override;
144 self
145 }
146 /// <p>Specifies the bucket being deleted.</p>
147 /// <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>
148 pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
149 self.inner = self.inner.bucket(input.into());
150 self
151 }
152 /// <p>Specifies the bucket being deleted.</p>
153 /// <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>
154 pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
155 self.inner = self.inner.set_bucket(input);
156 self
157 }
158 /// <p>Specifies the bucket being deleted.</p>
159 /// <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>
160 pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
161 self.inner.get_bucket()
162 }
163 /// <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>
164 /// <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>
165 /// </note>
166 pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
167 self.inner = self.inner.expected_bucket_owner(input.into());
168 self
169 }
170 /// <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>
171 /// <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>
172 /// </note>
173 pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
174 self.inner = self.inner.set_expected_bucket_owner(input);
175 self
176 }
177 /// <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>
178 /// <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>
179 /// </note>
180 pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
181 self.inner.get_expected_bucket_owner()
182 }
183}