aws_sdk_s3control/operation/delete_access_point/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_access_point::_delete_access_point_output::DeleteAccessPointOutputBuilder;
3
4pub use crate::operation::delete_access_point::_delete_access_point_input::DeleteAccessPointInputBuilder;
5
6impl crate::operation::delete_access_point::builders::DeleteAccessPointInputBuilder {
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_access_point::DeleteAccessPointOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::delete_access_point::DeleteAccessPointError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.delete_access_point();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DeleteAccessPoint`.
24///
25/// <p>Deletes the specified access point.</p>
26/// <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived by using the access point ARN, see the <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html#API_control_DeleteAccessPoint_Examples">Examples</a> section.</p>
27/// <p>The following actions are related to <code>DeleteAccessPoint</code>:</p>
28/// <ul>
29/// <li>
30/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html">CreateAccessPoint</a></p></li>
31/// <li>
32/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html">GetAccessPoint</a></p></li>
33/// <li>
34/// <p><a href="https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html">ListAccessPoints</a></p></li>
35/// </ul><important>
36/// <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>
37/// </important>
38#[derive(::std::clone::Clone, ::std::fmt::Debug)]
39pub struct DeleteAccessPointFluentBuilder {
40 handle: ::std::sync::Arc<crate::client::Handle>,
41 inner: crate::operation::delete_access_point::builders::DeleteAccessPointInputBuilder,
42 config_override: ::std::option::Option<crate::config::Builder>,
43}
44impl
45 crate::client::customize::internal::CustomizableSend<
46 crate::operation::delete_access_point::DeleteAccessPointOutput,
47 crate::operation::delete_access_point::DeleteAccessPointError,
48 > for DeleteAccessPointFluentBuilder
49{
50 fn send(
51 self,
52 config_override: crate::config::Builder,
53 ) -> crate::client::customize::internal::BoxFuture<
54 crate::client::customize::internal::SendResult<
55 crate::operation::delete_access_point::DeleteAccessPointOutput,
56 crate::operation::delete_access_point::DeleteAccessPointError,
57 >,
58 > {
59 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
60 }
61}
62impl DeleteAccessPointFluentBuilder {
63 /// Creates a new `DeleteAccessPointFluentBuilder`.
64 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
65 Self {
66 handle,
67 inner: ::std::default::Default::default(),
68 config_override: ::std::option::Option::None,
69 }
70 }
71 /// Access the DeleteAccessPoint as a reference.
72 pub fn as_input(&self) -> &crate::operation::delete_access_point::builders::DeleteAccessPointInputBuilder {
73 &self.inner
74 }
75 /// Sends the request and returns the response.
76 ///
77 /// If an error occurs, an `SdkError` will be returned with additional details that
78 /// can be matched against.
79 ///
80 /// By default, any retryable failures will be retried twice. Retry behavior
81 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
82 /// set when configuring the client.
83 pub async fn send(
84 self,
85 ) -> ::std::result::Result<
86 crate::operation::delete_access_point::DeleteAccessPointOutput,
87 ::aws_smithy_runtime_api::client::result::SdkError<
88 crate::operation::delete_access_point::DeleteAccessPointError,
89 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
90 >,
91 > {
92 let input = self
93 .inner
94 .build()
95 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
96 let runtime_plugins = crate::operation::delete_access_point::DeleteAccessPoint::operation_runtime_plugins(
97 self.handle.runtime_plugins.clone(),
98 &self.handle.conf,
99 self.config_override,
100 );
101 crate::operation::delete_access_point::DeleteAccessPoint::orchestrate(&runtime_plugins, input).await
102 }
103
104 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
105 pub fn customize(
106 self,
107 ) -> crate::client::customize::CustomizableOperation<
108 crate::operation::delete_access_point::DeleteAccessPointOutput,
109 crate::operation::delete_access_point::DeleteAccessPointError,
110 Self,
111 > {
112 crate::client::customize::CustomizableOperation::new(self)
113 }
114 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
115 self.set_config_override(::std::option::Option::Some(config_override.into()));
116 self
117 }
118
119 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
120 self.config_override = config_override;
121 self
122 }
123 /// <p>The Amazon Web Services account ID for the account that owns the specified access point.</p>
124 pub fn account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
125 self.inner = self.inner.account_id(input.into());
126 self
127 }
128 /// <p>The Amazon Web Services account ID for the account that owns the specified access point.</p>
129 pub fn set_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
130 self.inner = self.inner.set_account_id(input);
131 self
132 }
133 /// <p>The Amazon Web Services account ID for the account that owns the specified access point.</p>
134 pub fn get_account_id(&self) -> &::std::option::Option<::std::string::String> {
135 self.inner.get_account_id()
136 }
137 /// <p>The name of the access point you want to delete.</p>
138 /// <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
139 /// <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<region>
140 /// :
141 /// <account-id>
142 /// :outpost/
143 /// <outpost-id>
144 /// /accesspoint/
145 /// <my-accesspoint-name></my-accesspoint-name>
146 /// </outpost-id>
147 /// </account-id>
148 /// </region></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded.</p>
149 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150 self.inner = self.inner.name(input.into());
151 self
152 }
153 /// <p>The name of the access point you want to delete.</p>
154 /// <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
155 /// <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<region>
156 /// :
157 /// <account-id>
158 /// :outpost/
159 /// <outpost-id>
160 /// /accesspoint/
161 /// <my-accesspoint-name></my-accesspoint-name>
162 /// </outpost-id>
163 /// </account-id>
164 /// </region></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded.</p>
165 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
166 self.inner = self.inner.set_name(input);
167 self
168 }
169 /// <p>The name of the access point you want to delete.</p>
170 /// <p>For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.</p>
171 /// <p>For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the access point accessed in the format <code>arn:aws:s3-outposts:<region>
172 /// :
173 /// <account-id>
174 /// :outpost/
175 /// <outpost-id>
176 /// /accesspoint/
177 /// <my-accesspoint-name></my-accesspoint-name>
178 /// </outpost-id>
179 /// </account-id>
180 /// </region></code>. For example, to access the access point <code>reports-ap</code> through Outpost <code>my-outpost</code> owned by account <code>123456789012</code> in Region <code>us-west-2</code>, use the URL encoding of <code>arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/accesspoint/reports-ap</code>. The value must be URL encoded.</p>
181 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
182 self.inner.get_name()
183 }
184}