aws_sdk_cloudcontrol/operation/list_resources/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::list_resources::_list_resources_output::ListResourcesOutputBuilder;
3
4pub use crate::operation::list_resources::_list_resources_input::ListResourcesInputBuilder;
5
6impl crate::operation::list_resources::builders::ListResourcesInputBuilder {
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::list_resources::ListResourcesOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::list_resources::ListResourcesError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.list_resources();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `ListResources`.
24///
25/// <p>Returns information about the specified resources. For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-list.html">Discovering resources</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p>
26/// <p>You can use this action to return information about existing resources in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.</p>
27#[derive(::std::clone::Clone, ::std::fmt::Debug)]
28pub struct ListResourcesFluentBuilder {
29    handle: ::std::sync::Arc<crate::client::Handle>,
30    inner: crate::operation::list_resources::builders::ListResourcesInputBuilder,
31    config_override: ::std::option::Option<crate::config::Builder>,
32}
33impl
34    crate::client::customize::internal::CustomizableSend<
35        crate::operation::list_resources::ListResourcesOutput,
36        crate::operation::list_resources::ListResourcesError,
37    > for ListResourcesFluentBuilder
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::list_resources::ListResourcesOutput,
45            crate::operation::list_resources::ListResourcesError,
46        >,
47    > {
48        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
49    }
50}
51impl ListResourcesFluentBuilder {
52    /// Creates a new `ListResourcesFluentBuilder`.
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 ListResources as a reference.
61    pub fn as_input(&self) -> &crate::operation::list_resources::builders::ListResourcesInputBuilder {
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::list_resources::ListResourcesOutput,
76        ::aws_smithy_runtime_api::client::result::SdkError<
77            crate::operation::list_resources::ListResourcesError,
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::list_resources::ListResources::operation_runtime_plugins(
86            self.handle.runtime_plugins.clone(),
87            &self.handle.conf,
88            self.config_override,
89        );
90        crate::operation::list_resources::ListResources::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::list_resources::ListResourcesOutput,
98        crate::operation::list_resources::ListResourcesError,
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    /// Create a paginator for this request
113    ///
114    /// Paginators are used by calling [`send().await`](crate::operation::list_resources::paginator::ListResourcesPaginator::send) which returns a [`PaginationStream`](aws_smithy_async::future::pagination_stream::PaginationStream).
115    pub fn into_paginator(self) -> crate::operation::list_resources::paginator::ListResourcesPaginator {
116        crate::operation::list_resources::paginator::ListResourcesPaginator::new(self.handle, self.inner)
117    }
118    /// <p>The name of the resource type.</p>
119    pub fn type_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
120        self.inner = self.inner.type_name(input.into());
121        self
122    }
123    /// <p>The name of the resource type.</p>
124    pub fn set_type_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125        self.inner = self.inner.set_type_name(input);
126        self
127    }
128    /// <p>The name of the resource type.</p>
129    pub fn get_type_name(&self) -> &::std::option::Option<::std::string::String> {
130        self.inner.get_type_name()
131    }
132    /// <p>For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.</p>
133    pub fn type_version_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134        self.inner = self.inner.type_version_id(input.into());
135        self
136    }
137    /// <p>For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.</p>
138    pub fn set_type_version_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139        self.inner = self.inner.set_type_version_id(input);
140        self
141    }
142    /// <p>For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.</p>
143    pub fn get_type_version_id(&self) -> &::std::option::Option<::std::string::String> {
144        self.inner.get_type_version_id()
145    }
146    /// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the <code> <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers">handlers</a> </code> section of the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">resource type definition schema</a>.</p>
147    /// <p>If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.</p>
148    /// <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions">Specifying credentials</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p>
149    pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
150        self.inner = self.inner.role_arn(input.into());
151        self
152    }
153    /// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the <code> <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers">handlers</a> </code> section of the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">resource type definition schema</a>.</p>
154    /// <p>If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.</p>
155    /// <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions">Specifying credentials</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p>
156    pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
157        self.inner = self.inner.set_role_arn(input);
158        self
159    }
160    /// <p>The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the <code> <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html#schema-properties-handlers">handlers</a> </code> section of the <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">resource type definition schema</a>.</p>
161    /// <p>If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.</p>
162    /// <p>For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations.html#resource-operations-permissions">Specifying credentials</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p>
163    pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
164        self.inner.get_role_arn()
165    }
166    /// <p>If the previous paginated request didn't return all of the remaining results, the response object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
167    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
168        self.inner = self.inner.next_token(input.into());
169        self
170    }
171    /// <p>If the previous paginated request didn't return all of the remaining results, the response object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
172    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
173        self.inner = self.inner.set_next_token(input);
174        self
175    }
176    /// <p>If the previous paginated request didn't return all of the remaining results, the response object's <code>NextToken</code> parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's <code>NextToken</code> parameter. If there are no remaining results, the previous response object's <code>NextToken</code> parameter is set to <code>null</code>.</p>
177    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
178        self.inner.get_next_token()
179    }
180    /// <p>Reserved.</p>
181    pub fn max_results(mut self, input: i32) -> Self {
182        self.inner = self.inner.max_results(input);
183        self
184    }
185    /// <p>Reserved.</p>
186    pub fn set_max_results(mut self, input: ::std::option::Option<i32>) -> Self {
187        self.inner = self.inner.set_max_results(input);
188        self
189    }
190    /// <p>Reserved.</p>
191    pub fn get_max_results(&self) -> &::std::option::Option<i32> {
192        self.inner.get_max_results()
193    }
194    /// <p>The resource model to use to select the resources to return.</p>
195    pub fn resource_model(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
196        self.inner = self.inner.resource_model(input.into());
197        self
198    }
199    /// <p>The resource model to use to select the resources to return.</p>
200    pub fn set_resource_model(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
201        self.inner = self.inner.set_resource_model(input);
202        self
203    }
204    /// <p>The resource model to use to select the resources to return.</p>
205    pub fn get_resource_model(&self) -> &::std::option::Option<::std::string::String> {
206        self.inner.get_resource_model()
207    }
208}