aws_sdk_iot/operation/test_authorization/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::test_authorization::_test_authorization_output::TestAuthorizationOutputBuilder;
3
4pub use crate::operation::test_authorization::_test_authorization_input::TestAuthorizationInputBuilder;
5
6impl crate::operation::test_authorization::builders::TestAuthorizationInputBuilder {
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::test_authorization::TestAuthorizationOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::test_authorization::TestAuthorizationError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.test_authorization();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `TestAuthorization`.
24///
25/// <p>Tests if a specified principal is authorized to perform an IoT action on a specified resource. Use this to test and debug the authorization behavior of devices that connect to the IoT device gateway.</p>
26/// <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">TestAuthorization</a> action.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct TestAuthorizationFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::test_authorization::builders::TestAuthorizationInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::test_authorization::TestAuthorizationOutput,
36        crate::operation::test_authorization::TestAuthorizationError,
37    > for TestAuthorizationFluentBuilder
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::test_authorization::TestAuthorizationOutput,
45            crate::operation::test_authorization::TestAuthorizationError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl TestAuthorizationFluentBuilder {
52    /// Creates a new `TestAuthorizationFluentBuilder`.
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 TestAuthorization as a reference.
61    pub fn as_input(&self) -> &crate::operation::test_authorization::builders::TestAuthorizationInputBuilder {
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::test_authorization::TestAuthorizationOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::test_authorization::TestAuthorizationError,
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::test_authorization::TestAuthorization::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::test_authorization::TestAuthorization::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::test_authorization::TestAuthorizationOutput,
98        crate::operation::test_authorization::TestAuthorizationError,
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>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>
113    pub fn principal(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
114        self.inner = self.inner.principal(input.into());
115        self
116    }
117    /// <p>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>
118    pub fn set_principal(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
119        self.inner = self.inner.set_principal(input);
120        self
121    }
122    /// <p>The principal. Valid principals are CertificateArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:cert/<i>certificateId</i>), thingGroupArn (arn:aws:iot:<i>region</i>:<i>accountId</i>:thinggroup/<i>groupName</i>) and CognitoId (<i>region</i>:<i>id</i>).</p>
123    pub fn get_principal(&self) -> &::std::option::Option<::std::string::String> {
124        self.inner.get_principal()
125    }
126    /// <p>The Cognito identity pool ID.</p>
127    pub fn cognito_identity_pool_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
128        self.inner = self.inner.cognito_identity_pool_id(input.into());
129        self
130    }
131    /// <p>The Cognito identity pool ID.</p>
132    pub fn set_cognito_identity_pool_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
133        self.inner = self.inner.set_cognito_identity_pool_id(input);
134        self
135    }
136    /// <p>The Cognito identity pool ID.</p>
137    pub fn get_cognito_identity_pool_id(&self) -> &::std::option::Option<::std::string::String> {
138        self.inner.get_cognito_identity_pool_id()
139    }
140    ///
141    /// Appends an item to `authInfos`.
142    ///
143    /// To override the contents of this collection use [`set_auth_infos`](Self::set_auth_infos).
144    ///
145    /// <p>A list of authorization info objects. Simulating authorization will create a response for each <code>authInfo</code> object in the list.</p>
146    pub fn auth_infos(mut self, input: crate::types::AuthInfo) -> Self {
147        self.inner = self.inner.auth_infos(input);
148        self
149    }
150    /// <p>A list of authorization info objects. Simulating authorization will create a response for each <code>authInfo</code> object in the list.</p>
151    pub fn set_auth_infos(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::AuthInfo>>) -> Self {
152        self.inner = self.inner.set_auth_infos(input);
153        self
154    }
155    /// <p>A list of authorization info objects. Simulating authorization will create a response for each <code>authInfo</code> object in the list.</p>
156    pub fn get_auth_infos(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::AuthInfo>> {
157        self.inner.get_auth_infos()
158    }
159    /// <p>The MQTT client ID.</p>
160    pub fn client_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
161        self.inner = self.inner.client_id(input.into());
162        self
163    }
164    /// <p>The MQTT client ID.</p>
165    pub fn set_client_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
166        self.inner = self.inner.set_client_id(input);
167        self
168    }
169    /// <p>The MQTT client ID.</p>
170    pub fn get_client_id(&self) -> &::std::option::Option<::std::string::String> {
171        self.inner.get_client_id()
172    }
173    ///
174    /// Appends an item to `policyNamesToAdd`.
175    ///
176    /// To override the contents of this collection use [`set_policy_names_to_add`](Self::set_policy_names_to_add).
177    ///
178    /// <p>When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.</p>
179    pub fn policy_names_to_add(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
180        self.inner = self.inner.policy_names_to_add(input.into());
181        self
182    }
183    /// <p>When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.</p>
184    pub fn set_policy_names_to_add(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
185        self.inner = self.inner.set_policy_names_to_add(input);
186        self
187    }
188    /// <p>When testing custom authorization, the policies specified here are treated as if they are attached to the principal being authorized.</p>
189    pub fn get_policy_names_to_add(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
190        self.inner.get_policy_names_to_add()
191    }
192    ///
193    /// Appends an item to `policyNamesToSkip`.
194    ///
195    /// To override the contents of this collection use [`set_policy_names_to_skip`](Self::set_policy_names_to_skip).
196    ///
197    /// <p>When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.</p>
198    pub fn policy_names_to_skip(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
199        self.inner = self.inner.policy_names_to_skip(input.into());
200        self
201    }
202    /// <p>When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.</p>
203    pub fn set_policy_names_to_skip(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
204        self.inner = self.inner.set_policy_names_to_skip(input);
205        self
206    }
207    /// <p>When testing custom authorization, the policies specified here are treated as if they are not attached to the principal being authorized.</p>
208    pub fn get_policy_names_to_skip(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
209        self.inner.get_policy_names_to_skip()
210    }
211}
aws_sdk_iot/operation/test_authorization/builders.rs

aws_sdk_iot/operation/test_authorization/
builders.rs
