aws_sdk_cognitoidentityprovider/client/
get_csv_header.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetCSVHeader`](crate::operation::get_csv_header::builders::GetCSVHeaderFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`user_pool_id(impl Into<String>)`](crate::operation::get_csv_header::builders::GetCSVHeaderFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::get_csv_header::builders::GetCSVHeaderFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool that you want to import users into.</p><br>
7    /// - On success, responds with [`GetCsvHeaderOutput`](crate::operation::get_csv_header::GetCsvHeaderOutput) with field(s):
8    ///   - [`user_pool_id(Option<String>)`](crate::operation::get_csv_header::GetCsvHeaderOutput::user_pool_id): <p>The ID of the requested user pool.</p>
9    ///   - [`csv_header(Option<Vec::<String>>)`](crate::operation::get_csv_header::GetCsvHeaderOutput::csv_header): <p>A comma-separated list of attributes from your user pool. Save this output to a <code>.csv</code> file and populate it with the attributes of the users that you want to import.</p>
10    /// - On failure, responds with [`SdkError<GetCSVHeaderError>`](crate::operation::get_csv_header::GetCSVHeaderError)
11    pub fn get_csv_header(&self) -> crate::operation::get_csv_header::builders::GetCSVHeaderFluentBuilder {
12        crate::operation::get_csv_header::builders::GetCSVHeaderFluentBuilder::new(self.handle.clone())
13    }
14}