Struct aws_sdk_cognitoidentityprovider::types::builders::UserImportJobTypeBuilder

#[non_exhaustive]
pub struct UserImportJobTypeBuilder { /* private fields */ }

A builder for UserImportJobType.

Implementations

impl UserImportJobTypeBuilder

pub fn job_name(self, input: impl Into<String>) -> Self

The job name for the user import job.

pub fn set_job_name(self, input: Option<String>) -> Self

The job name for the user import job.

pub fn get_job_name(&self) -> &Option<String>

The job name for the user import job.

pub fn job_id(self, input: impl Into<String>) -> Self

The job ID for the user import job.

pub fn set_job_id(self, input: Option<String>) -> Self

The job ID for the user import job.

pub fn get_job_id(&self) -> &Option<String>

The job ID for the user import job.

pub fn user_pool_id(self, input: impl Into<String>) -> Self

The user pool ID for the user pool that the users are being imported into.

pub fn set_user_pool_id(self, input: Option<String>) -> Self

The user pool ID for the user pool that the users are being imported into.

pub fn get_user_pool_id(&self) -> &Option<String>

The user pool ID for the user pool that the users are being imported into.

pub fn pre_signed_url(self, input: impl Into<String>) -> Self

The pre-signed URL to be used to upload the .csv file.

pub fn set_pre_signed_url(self, input: Option<String>) -> Self

The pre-signed URL to be used to upload the .csv file.

pub fn get_pre_signed_url(&self) -> &Option<String>

The pre-signed URL to be used to upload the .csv file.

pub fn creation_date(self, input: DateTime) -> Self

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

pub fn set_creation_date(self, input: Option<DateTime>) -> Self

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

pub fn get_creation_date(&self) -> &Option<DateTime>

The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

pub fn start_date(self, input: DateTime) -> Self

The date when the user import job was started.

pub fn set_start_date(self, input: Option<DateTime>) -> Self

The date when the user import job was started.

pub fn get_start_date(&self) -> &Option<DateTime>

The date when the user import job was started.

pub fn completion_date(self, input: DateTime) -> Self

The date when the user import job was completed.

pub fn set_completion_date(self, input: Option<DateTime>) -> Self

The date when the user import job was completed.

pub fn get_completion_date(&self) -> &Option<DateTime>

The date when the user import job was completed.

pub fn status(self, input: UserImportJobStatusType) -> Self

The status of the user import job. One of the following:

• Created - The job was created but not started.

• Pending - A transition state. You have started the job, but it has not begun importing users yet.

• InProgress - The job has started, and users are being imported.

• Stopping - You have stopped the job, but the job has not stopped importing users yet.

• Stopped - You have stopped the job, and the job has stopped importing users.

• Succeeded - The job has completed successfully.

• Failed - The job has stopped due to an error.

• Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.

pub fn set_status(self, input: Option<UserImportJobStatusType>) -> Self

The status of the user import job. One of the following:

• Created - The job was created but not started.

• Pending - A transition state. You have started the job, but it has not begun importing users yet.

• InProgress - The job has started, and users are being imported.

• Stopping - You have stopped the job, but the job has not stopped importing users yet.

• Stopped - You have stopped the job, and the job has stopped importing users.

• Succeeded - The job has completed successfully.

• Failed - The job has stopped due to an error.

• Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.

pub fn get_status(&self) -> &Option<UserImportJobStatusType>

The status of the user import job. One of the following:

• Created - The job was created but not started.

• Pending - A transition state. You have started the job, but it has not begun importing users yet.

• InProgress - The job has started, and users are being imported.

• Stopping - You have stopped the job, but the job has not stopped importing users yet.

• Stopped - You have stopped the job, and the job has stopped importing users.

• Succeeded - The job has completed successfully.

• Failed - The job has stopped due to an error.

• Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job can't be started.

pub fn cloud_watch_logs_role_arn(self, input: impl Into<String>) -> Self

The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.

pub fn set_cloud_watch_logs_role_arn(self, input: Option<String>) -> Self

The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.

pub fn get_cloud_watch_logs_role_arn(&self) -> &Option<String>

The role Amazon Resource Name (ARN) for the Amazon CloudWatch Logging role for the user import job. For more information, see "Creating the CloudWatch Logs IAM Role" in the Amazon Cognito Developer Guide.

pub fn imported_users(self, input: i64) -> Self

The number of users that were successfully imported.

pub fn set_imported_users(self, input: Option<i64>) -> Self

The number of users that were successfully imported.

pub fn get_imported_users(&self) -> &Option<i64>

The number of users that were successfully imported.

pub fn skipped_users(self, input: i64) -> Self

The number of users that were skipped.

pub fn set_skipped_users(self, input: Option<i64>) -> Self

The number of users that were skipped.

pub fn get_skipped_users(&self) -> &Option<i64>

The number of users that were skipped.

pub fn failed_users(self, input: i64) -> Self

The number of users that couldn't be imported.

pub fn set_failed_users(self, input: Option<i64>) -> Self

The number of users that couldn't be imported.

pub fn get_failed_users(&self) -> &Option<i64>

The number of users that couldn't be imported.

pub fn completion_message(self, input: impl Into<String>) -> Self

The message returned when the user import job is completed.

pub fn set_completion_message(self, input: Option<String>) -> Self

The message returned when the user import job is completed.

pub fn get_completion_message(&self) -> &Option<String>

The message returned when the user import job is completed.

pub fn build(self) -> UserImportJobType

Consumes the builder and constructs a UserImportJobType.

Trait Implementations

impl Clone for UserImportJobTypeBuilder

fn clone(&self) -> UserImportJobTypeBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserImportJobTypeBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UserImportJobTypeBuilder

fn default() -> UserImportJobTypeBuilder

Returns the “default value” for a type.

impl PartialEq for UserImportJobTypeBuilder

fn eq(&self, other: &UserImportJobTypeBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserImportJobTypeBuilder