aws_sdk_cognitoidentityprovider/operation/get_csv_header/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::get_csv_header::_get_csv_header_output::GetCsvHeaderOutputBuilder;
3
4pub use crate::operation::get_csv_header::_get_csv_header_input::GetCsvHeaderInputBuilder;
5
6impl crate::operation::get_csv_header::builders::GetCsvHeaderInputBuilder {
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_csv_header::GetCsvHeaderOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::get_csv_header::GetCSVHeaderError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.get_csv_header();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `GetCSVHeader`.
24///
25/// <p>Given a user pool ID, generates a comma-separated value (CSV) list populated with available user attributes in the user pool. This list is the header for the CSV file that determines the users in a user import job. Save the content of <code>CSVHeader</code> in the response as a <code>.csv</code> file and populate it with the usernames and attributes of users that you want to import. For more information about CSV user import, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-using-import-tool.html">Importing users from a CSV file</a>.</p><note>
26/// <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.</p>
27/// <p class="title"><b>Learn more</b></p>
28/// <ul>
29/// <li>
30/// <p><a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a></p></li>
31/// <li>
32/// <p><a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a></p></li>
33/// </ul>
34/// </note>
35#[derive(::std::clone::Clone, ::std::fmt::Debug)]
36pub struct GetCSVHeaderFluentBuilder {
37    handle: ::std::sync::Arc<crate::client::Handle>,
38    inner: crate::operation::get_csv_header::builders::GetCsvHeaderInputBuilder,
39    config_override: ::std::option::Option<crate::config::Builder>,
40}
41impl
42    crate::client::customize::internal::CustomizableSend<
43        crate::operation::get_csv_header::GetCsvHeaderOutput,
44        crate::operation::get_csv_header::GetCSVHeaderError,
45    > for GetCSVHeaderFluentBuilder
46{
47    fn send(
48        self,
49        config_override: crate::config::Builder,
50    ) -> crate::client::customize::internal::BoxFuture<
51        crate::client::customize::internal::SendResult<
52            crate::operation::get_csv_header::GetCsvHeaderOutput,
53            crate::operation::get_csv_header::GetCSVHeaderError,
54        >,
55    > {
56        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
57    }
58}
59impl GetCSVHeaderFluentBuilder {
60    /// Creates a new `GetCSVHeaderFluentBuilder`.
61    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
62        Self {
63            handle,
64            inner: ::std::default::Default::default(),
65            config_override: ::std::option::Option::None,
66        }
67    }
68    /// Access the GetCSVHeader as a reference.
69    pub fn as_input(&self) -> &crate::operation::get_csv_header::builders::GetCsvHeaderInputBuilder {
70        &self.inner
71    }
72    /// Sends the request and returns the response.
73    ///
74    /// If an error occurs, an `SdkError` will be returned with additional details that
75    /// can be matched against.
76    ///
77    /// By default, any retryable failures will be retried twice. Retry behavior
78    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
79    /// set when configuring the client.
80    pub async fn send(
81        self,
82    ) -> ::std::result::Result<
83        crate::operation::get_csv_header::GetCsvHeaderOutput,
84        ::aws_smithy_runtime_api::client::result::SdkError<
85            crate::operation::get_csv_header::GetCSVHeaderError,
86            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
87        >,
88    > {
89        let input = self
90            .inner
91            .build()
92            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
93        let runtime_plugins = crate::operation::get_csv_header::GetCSVHeader::operation_runtime_plugins(
94            self.handle.runtime_plugins.clone(),
95            &self.handle.conf,
96            self.config_override,
97        );
98        crate::operation::get_csv_header::GetCSVHeader::orchestrate(&runtime_plugins, input).await
99    }
100
101    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
102    pub fn customize(
103        self,
104    ) -> crate::client::customize::CustomizableOperation<
105        crate::operation::get_csv_header::GetCsvHeaderOutput,
106        crate::operation::get_csv_header::GetCSVHeaderError,
107        Self,
108    > {
109        crate::client::customize::CustomizableOperation::new(self)
110    }
111    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
112        self.set_config_override(::std::option::Option::Some(config_override.into()));
113        self
114    }
115
116    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
117        self.config_override = config_override;
118        self
119    }
120    /// <p>The ID of the user pool that you want to import users into.</p>
121    pub fn user_pool_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
122        self.inner = self.inner.user_pool_id(input.into());
123        self
124    }
125    /// <p>The ID of the user pool that you want to import users into.</p>
126    pub fn set_user_pool_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
127        self.inner = self.inner.set_user_pool_id(input);
128        self
129    }
130    /// <p>The ID of the user pool that you want to import users into.</p>
131    pub fn get_user_pool_id(&self) -> &::std::option::Option<::std::string::String> {
132        self.inner.get_user_pool_id()
133    }
134}
aws_sdk_cognitoidentityprovider/operation/get_csv_header/builders.rs

aws_sdk_cognitoidentityprovider/operation/get_csv_header/
builders.rs
