Amazon Cognito Identity Provider
API Reference (API Version 2016-04-18)

UserImportJobType

The user import job type.

Contents

CloudWatchLogsRoleArn

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.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?

Required: No

CompletionDate

The date when the user import job was completed.

Type: Timestamp

Required: No

CompletionMessage

The message returned when the user import job is completed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w]+

Required: No

CreationDate

The date the user import job was created.

Type: Timestamp

Required: No

FailedUsers

The number of users that could not be imported.

Type: Long

Required: No

ImportedUsers

The number of users that were successfully imported.

Type: Long

Required: No

JobId

The job ID for the user import job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: import-[0-9a-zA-Z-]+

Required: No

JobName

The job name for the user import job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\w\s+=,.@-]+

Required: No

PreSignedUrl

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

SkippedUsers

The number of users that were skipped.

Type: Long

Required: No

StartDate

The date when the user import job was started.

Type: Timestamp

Required: No

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.

Type: String

Valid Values: Created | Pending | InProgress | Stopping | Expired | Stopped | Failed | Succeeded

Required: No

UserPoolId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 55.

Pattern: [\w-]+_[0-9a-zA-Z]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: