public static interface UserImportJobType.Builder extends CopyableBuilder<UserImportJobType.Builder,UserImportJobType>
Modifier and Type | Method and Description |
---|---|
UserImportJobType.Builder |
cloudWatchLogsRoleArn(String cloudWatchLogsRoleArn)
The role ARN for the Amazon CloudWatch Logging role for the user import job.
|
UserImportJobType.Builder |
completionDate(Instant completionDate)
The date when the user import job was completed.
|
UserImportJobType.Builder |
completionMessage(String completionMessage)
The message returned when the user import job is completed.
|
UserImportJobType.Builder |
creationDate(Instant creationDate)
The date the user import job was created.
|
UserImportJobType.Builder |
failedUsers(Long failedUsers)
The number of users that could not be imported.
|
UserImportJobType.Builder |
importedUsers(Long importedUsers)
The number of users that were successfully imported.
|
UserImportJobType.Builder |
jobId(String jobId)
The job ID for the user import job.
|
UserImportJobType.Builder |
jobName(String jobName)
The job name for the user import job.
|
UserImportJobType.Builder |
preSignedUrl(String preSignedUrl)
The pre-signed URL to be used to upload the
.csv file. |
UserImportJobType.Builder |
skippedUsers(Long skippedUsers)
The number of users that were skipped.
|
UserImportJobType.Builder |
startDate(Instant startDate)
The date when the user import job was started.
|
UserImportJobType.Builder |
status(String status)
The status of the user import job.
|
UserImportJobType.Builder |
status(UserImportJobStatusType status)
The status of the user import job.
|
UserImportJobType.Builder |
userPoolId(String userPoolId)
The user pool ID for the user pool that the users are being imported into.
|
copy
applyMutation, build
UserImportJobType.Builder jobName(String jobName)
The job name for the user import job.
jobName
- The job name for the user import job.UserImportJobType.Builder jobId(String jobId)
The job ID for the user import job.
jobId
- The job ID for the user import job.UserImportJobType.Builder userPoolId(String userPoolId)
The user pool ID for the user pool that the users are being imported into.
userPoolId
- The user pool ID for the user pool that the users are being imported into.UserImportJobType.Builder preSignedUrl(String preSignedUrl)
The pre-signed URL to be used to upload the .csv
file.
preSignedUrl
- The pre-signed URL to be used to upload the .csv
file.UserImportJobType.Builder creationDate(Instant creationDate)
The date the user import job was created.
creationDate
- The date the user import job was created.UserImportJobType.Builder startDate(Instant startDate)
The date when the user import job was started.
startDate
- The date when the user import job was started.UserImportJobType.Builder completionDate(Instant completionDate)
The date when the user import job was completed.
completionDate
- The date when the user import job was completed.UserImportJobType.Builder status(String 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.
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.
UserImportJobStatusType
,
UserImportJobStatusType
UserImportJobType.Builder status(UserImportJobStatusType 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.
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.
UserImportJobStatusType
,
UserImportJobStatusType
UserImportJobType.Builder cloudWatchLogsRoleArn(String 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.
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.UserImportJobType.Builder importedUsers(Long importedUsers)
The number of users that were successfully imported.
importedUsers
- The number of users that were successfully imported.UserImportJobType.Builder skippedUsers(Long skippedUsers)
The number of users that were skipped.
skippedUsers
- The number of users that were skipped.UserImportJobType.Builder failedUsers(Long failedUsers)
The number of users that could not be imported.
failedUsers
- The number of users that could not be imported.UserImportJobType.Builder completionMessage(String completionMessage)
The message returned when the user import job is completed.
completionMessage
- The message returned when the user import job is completed.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.