You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::UserImportJobType

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

The user import job type.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_logs_role_arn ⇒ String

The role 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.

Returns:

  • (String) —

    The role ARN for the Amazon CloudWatch Logging role for the user import job.

#completion_date ⇒ Time

The date when the user import job was completed.

Returns:

  • (Time) —

    The date when the user import job was completed.

#completion_message ⇒ String

The message returned when the user import job is completed.

Returns:

  • (String) —

    The message returned when the user import job is completed.

#creation_date ⇒ Time

The date the user import job was created.

Returns:

  • (Time) —

    The date the user import job was created.

#failed_users ⇒ Integer

The number of users that could not be imported.

Returns:

  • (Integer) —

    The number of users that could not be imported.

#imported_users ⇒ Integer

The number of users that were successfully imported.

Returns:

  • (Integer) —

    The number of users that were successfully imported.

#job_id ⇒ String

The job ID for the user import job.

Returns:

  • (String) —

    The job ID for the user import job.

#job_name ⇒ String

The job name for the user import job.

Returns:

  • (String) —

    The job name for the user import job.

#pre_signed_url ⇒ String

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

Returns:

  • (String) —

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

#skipped_users ⇒ Integer

The number of users that were skipped.

Returns:

  • (Integer) —

    The number of users that were skipped.

#start_date ⇒ Time

The date when the user import job was started.

Returns:

  • (Time) —

    The date when the user import job was started.

#status ⇒ String

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 cannot be started.

    Possible values:

    • Created
    • Pending
    • InProgress
    • Stopping
    • Expired
    • Stopped
    • Failed
    • Succeeded

Returns:

  • (String) —

    The status of the user import job.

#user_pool_id ⇒ String

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

Returns:

  • (String) —

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