aws_sdk_cognitoidentityprovider/client/create_user_import_job.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 [`CreateUserImportJob`](crate::operation::create_user_import_job::builders::CreateUserImportJobFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`job_name(impl Into<String>)`](crate::operation::create_user_import_job::builders::CreateUserImportJobFluentBuilder::job_name) / [`set_job_name(Option<String>)`](crate::operation::create_user_import_job::builders::CreateUserImportJobFluentBuilder::set_job_name):<br>required: **true**<br><p>A friendly name for the user import job.</p><br>
7 /// - [`user_pool_id(impl Into<String>)`](crate::operation::create_user_import_job::builders::CreateUserImportJobFluentBuilder::user_pool_id) / [`set_user_pool_id(Option<String>)`](crate::operation::create_user_import_job::builders::CreateUserImportJobFluentBuilder::set_user_pool_id):<br>required: **true**<br><p>The ID of the user pool that you want to import users into.</p><br>
8 /// - [`cloud_watch_logs_role_arn(impl Into<String>)`](crate::operation::create_user_import_job::builders::CreateUserImportJobFluentBuilder::cloud_watch_logs_role_arn) / [`set_cloud_watch_logs_role_arn(Option<String>)`](crate::operation::create_user_import_job::builders::CreateUserImportJobFluentBuilder::set_cloud_watch_logs_role_arn):<br>required: **true**<br><p>You must specify an IAM role that has permission to log import-job results to Amazon CloudWatch Logs. This parameter is the ARN of that role.</p><br>
9 /// - On success, responds with [`CreateUserImportJobOutput`](crate::operation::create_user_import_job::CreateUserImportJobOutput) with field(s):
10 /// - [`user_import_job(Option<UserImportJobType>)`](crate::operation::create_user_import_job::CreateUserImportJobOutput::user_import_job): <p>The details of the user import job. Includes logging destination, status, and the Amazon S3 pre-signed URL for CSV upload.</p>
11 /// - On failure, responds with [`SdkError<CreateUserImportJobError>`](crate::operation::create_user_import_job::CreateUserImportJobError)
12 pub fn create_user_import_job(&self) -> crate::operation::create_user_import_job::builders::CreateUserImportJobFluentBuilder {
13 crate::operation::create_user_import_job::builders::CreateUserImportJobFluentBuilder::new(self.handle.clone())
14 }
15}