aws_sdk_transfer/operation/describe_access/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::describe_access::_describe_access_output::DescribeAccessOutputBuilder;
3
4pub use crate::operation::describe_access::_describe_access_input::DescribeAccessInputBuilder;
5
6impl crate::operation::describe_access::builders::DescribeAccessInputBuilder {
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::describe_access::DescribeAccessOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::describe_access::DescribeAccessError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.describe_access();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `DescribeAccess`.
24///
25/// <p>Describes the access that is assigned to the specific file transfer protocol-enabled server, as identified by its <code>ServerId</code> property and its <code>ExternalId</code>.</p>
26/// <p>The response from this call returns the properties of the access that is associated with the <code>ServerId</code> value that was specified.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct DescribeAccessFluentBuilder {
29 handle: ::std::sync::Arc<crate::client::Handle>,
30 inner: crate::operation::describe_access::builders::DescribeAccessInputBuilder,
31 config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34 crate::client::customize::internal::CustomizableSend<
35 crate::operation::describe_access::DescribeAccessOutput,
36 crate::operation::describe_access::DescribeAccessError,
37 > for DescribeAccessFluentBuilder
38{
39 fn send(
40 self,
41 config_override: crate::config::Builder,
42 ) -> crate::client::customize::internal::BoxFuture<
43 crate::client::customize::internal::SendResult<
44 crate::operation::describe_access::DescribeAccessOutput,
45 crate::operation::describe_access::DescribeAccessError,
46 >,
47 > {
48 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49 }
50}
51impl DescribeAccessFluentBuilder {
52 /// Creates a new `DescribeAccessFluentBuilder`.
53 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
54 Self {
55 handle,
56 inner: ::std::default::Default::default(),
57 config_override: ::std::option::Option::None,
58 }
59 }
60 /// Access the DescribeAccess as a reference.
61 pub fn as_input(&self) -> &crate::operation::describe_access::builders::DescribeAccessInputBuilder {
62 &self.inner
63 }
64 /// Sends the request and returns the response.
65 ///
66 /// If an error occurs, an `SdkError` will be returned with additional details that
67 /// can be matched against.
68 ///
69 /// By default, any retryable failures will be retried twice. Retry behavior
70 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
71 /// set when configuring the client.
72 pub async fn send(
73 self,
74 ) -> ::std::result::Result<
75 crate::operation::describe_access::DescribeAccessOutput,
76 ::aws_smithy_runtime_api::client::result::SdkError<
77 crate::operation::describe_access::DescribeAccessError,
78 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
79 >,
80 > {
81 let input = self
82 .inner
83 .build()
84 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
85 let runtime_plugins = crate::operation::describe_access::DescribeAccess::operation_runtime_plugins(
86 self.handle.runtime_plugins.clone(),
87 &self.handle.conf,
88 self.config_override,
89 );
90 crate::operation::describe_access::DescribeAccess::orchestrate(&runtime_plugins, input).await
91 }
92
93 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
94 pub fn customize(
95 self,
96 ) -> crate::client::customize::CustomizableOperation<
97 crate::operation::describe_access::DescribeAccessOutput,
98 crate::operation::describe_access::DescribeAccessError,
99 Self,
100 > {
101 crate::client::customize::CustomizableOperation::new(self)
102 }
103 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
104 self.set_config_override(::std::option::Option::Some(config_override.into()));
105 self
106 }
107
108 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
109 self.config_override = config_override;
110 self
111 }
112 /// <p>A system-assigned unique identifier for a server that has this access assigned.</p>
113 pub fn server_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114 self.inner = self.inner.server_id(input.into());
115 self
116 }
117 /// <p>A system-assigned unique identifier for a server that has this access assigned.</p>
118 pub fn set_server_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119 self.inner = self.inner.set_server_id(input);
120 self
121 }
122 /// <p>A system-assigned unique identifier for a server that has this access assigned.</p>
123 pub fn get_server_id(&self) -> &::std::option::Option<::std::string::String> {
124 self.inner.get_server_id()
125 }
126 /// <p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p>
127 /// <p><code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code></p>
128 /// <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
129 /// <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>
130 pub fn external_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
131 self.inner = self.inner.external_id(input.into());
132 self
133 }
134 /// <p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p>
135 /// <p><code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code></p>
136 /// <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
137 /// <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>
138 pub fn set_external_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139 self.inner = self.inner.set_external_id(input);
140 self
141 }
142 /// <p>A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.</p>
143 /// <p><code>Get-ADGroup -Filter {samAccountName -like "<i>YourGroupName</i>*"} -Properties * | Select SamAccountName,ObjectSid</code></p>
144 /// <p>In that command, replace <i>YourGroupName</i> with the name of your Active Directory group.</p>
145 /// <p>The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-</p>
146 pub fn get_external_id(&self) -> &::std::option::Option<::std::string::String> {
147 self.inner.get_external_id()
148 }
149}