aws_sdk_s3/operation/get_bucket_ownership_controls/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_bucket_ownership_controls::_get_bucket_ownership_controls_output::GetBucketOwnershipControlsOutputBuilder;
3
4pub use crate::operation::get_bucket_ownership_controls::_get_bucket_ownership_controls_input::GetBucketOwnershipControlsInputBuilder;
5
6impl crate::operation::get_bucket_ownership_controls::builders::GetBucketOwnershipControlsInputBuilder {
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::get_bucket_ownership_controls::GetBucketOwnershipControlsOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControlsError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_bucket_ownership_controls();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetBucketOwnershipControls`.
24///
25/// <note>
26/// <p>This operation is not supported for directory buckets.</p>
27/// </note>
28/// <p>Retrieves <code>OwnershipControls</code> for an Amazon S3 bucket. To use this operation, you must have the <code>s3:GetBucketOwnershipControls</code> permission. For more information about Amazon S3 permissions, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html">Specifying permissions in a policy</a>.</p><note>
29/// <p>A bucket doesn't have <code>OwnershipControls</code> settings in the following cases:</p>
30/// <ul>
31/// <li>
32/// <p>The bucket was created before the <code>BucketOwnerEnforced</code> ownership setting was introduced and you've never explicitly applied this value</p></li>
33/// <li>
34/// <p>You've manually deleted the bucket ownership control value using the <code>DeleteBucketOwnershipControls</code> API operation.</p></li>
35/// </ul>
36/// <p>By default, Amazon S3 sets <code>OwnershipControls</code> for all newly created buckets.</p>
37/// </note>
38/// <p>For information about Amazon S3 Object Ownership, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html">Using Object Ownership</a>.</p>
39/// <p>The following operations are related to <code>GetBucketOwnershipControls</code>:</p>
40/// <ul>
41/// <li>
42/// <p><code>PutBucketOwnershipControls</code></p></li>
43/// <li>
44/// <p><code>DeleteBucketOwnershipControls</code></p></li>
45/// </ul><important>
46/// <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>
47/// </important>
48#[derive(::std::clone::Clone, ::std::fmt::Debug)]
49pub struct GetBucketOwnershipControlsFluentBuilder {
50    handle: ::std::sync::Arc<crate::client::Handle>,
51    inner: crate::operation::get_bucket_ownership_controls::builders::GetBucketOwnershipControlsInputBuilder,
52    config_override: ::std::option::Option<crate::config::Builder>,
53}
54impl
55    crate::client::customize::internal::CustomizableSend<
56        crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControlsOutput,
57        crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControlsError,
58    > for GetBucketOwnershipControlsFluentBuilder
59{
60    fn send(
61        self,
62        config_override: crate::config::Builder,
63    ) -> crate::client::customize::internal::BoxFuture<
64        crate::client::customize::internal::SendResult<
65            crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControlsOutput,
66            crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControlsError,
67        >,
68    > {
69        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
70    }
71}
72impl GetBucketOwnershipControlsFluentBuilder {
73    /// Creates a new `GetBucketOwnershipControlsFluentBuilder`.
74    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
75        Self {
76            handle,
77            inner: ::std::default::Default::default(),
78            config_override: ::std::option::Option::None,
79        }
80    }
81    /// Access the GetBucketOwnershipControls as a reference.
82    pub fn as_input(&self) -> &crate::operation::get_bucket_ownership_controls::builders::GetBucketOwnershipControlsInputBuilder {
83        &self.inner
84    }
85    /// Sends the request and returns the response.
86    ///
87    /// If an error occurs, an `SdkError` will be returned with additional details that
88    /// can be matched against.
89    ///
90    /// By default, any retryable failures will be retried twice. Retry behavior
91    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
92    /// set when configuring the client.
93    pub async fn send(
94        self,
95    ) -> ::std::result::Result<
96        crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControlsOutput,
97        ::aws_smithy_runtime_api::client::result::SdkError<
98            crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControlsError,
99            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
100        >,
101    > {
102        let input = self
103            .inner
104            .build()
105            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
106        let runtime_plugins = crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControls::operation_runtime_plugins(
107            self.handle.runtime_plugins.clone(),
108            &self.handle.conf,
109            self.config_override,
110        );
111        crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControls::orchestrate(&runtime_plugins, input).await
112    }
113
114    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
115    pub fn customize(
116        self,
117    ) -> crate::client::customize::CustomizableOperation<
118        crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControlsOutput,
119        crate::operation::get_bucket_ownership_controls::GetBucketOwnershipControlsError,
120        Self,
121    > {
122        crate::client::customize::CustomizableOperation::new(self)
123    }
124    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
125        self.set_config_override(::std::option::Option::Some(config_override.into()));
126        self
127    }
128
129    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
130        self.config_override = config_override;
131        self
132    }
133    /// <p>The name of the Amazon S3 bucket whose <code>OwnershipControls</code> you want to retrieve.</p>
134    pub fn bucket(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
135        self.inner = self.inner.bucket(input.into());
136        self
137    }
138    /// <p>The name of the Amazon S3 bucket whose <code>OwnershipControls</code> you want to retrieve.</p>
139    pub fn set_bucket(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
140        self.inner = self.inner.set_bucket(input);
141        self
142    }
143    /// <p>The name of the Amazon S3 bucket whose <code>OwnershipControls</code> you want to retrieve.</p>
144    pub fn get_bucket(&self) -> &::std::option::Option<::std::string::String> {
145        self.inner.get_bucket()
146    }
147    /// <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>
148    pub fn expected_bucket_owner(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
149        self.inner = self.inner.expected_bucket_owner(input.into());
150        self
151    }
152    /// <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>
153    pub fn set_expected_bucket_owner(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
154        self.inner = self.inner.set_expected_bucket_owner(input);
155        self
156    }
157    /// <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>
158    pub fn get_expected_bucket_owner(&self) -> &::std::option::Option<::std::string::String> {
159        self.inner.get_expected_bucket_owner()
160    }
161}
aws_sdk_s3/operation/get_bucket_ownership_controls/builders.rs

aws_sdk_s3/operation/get_bucket_ownership_controls/
builders.rs
