class Aws::CognitoIdentityProvider::Types::UserImportJobType
The user import job type.
@!attribute [rw] job_name
The job name for the user import job. @return [String]
@!attribute [rw] job_id
The job ID for the user import job. @return [String]
@!attribute [rw] user_pool_id
The user pool ID for the user pool that the users are being imported into. @return [String]
@!attribute [rw] pre_signed_url
The pre-signed URL to be used to upload the `.csv` file. @return [String]
@!attribute [rw] creation_date
The date the user import job was created. @return [Time]
@!attribute [rw] start_date
The date when the user import job was started. @return [Time]
@!attribute [rw] completion_date
The date when the user import job was completed. @return [Time]
@!attribute [rw] status
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. @return [String]
@!attribute [rw] cloud_watch_logs_role_arn
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. @return [String]
@!attribute [rw] imported_users
The number of users that were successfully imported. @return [Integer]
@!attribute [rw] skipped_users
The number of users that were skipped. @return [Integer]
@!attribute [rw] failed_users
The number of users that could not be imported. @return [Integer]
@!attribute [rw] completion_message
The message returned when the user import job is completed. @return [String]
@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/UserImportJobType AWS API Documentation
Constants
- SENSITIVE