@Generated(value="software.amazon.awssdk:codegen") public class UserImportJobType extends Object implements StructuredPojo, ToCopyableBuilder<UserImportJobType.Builder,UserImportJobType>
The user import job type.
Modifier and Type | Class and Description |
---|---|
static interface |
UserImportJobType.Builder |
Modifier and Type | Method and Description |
---|---|
static UserImportJobType.Builder |
builder() |
String |
cloudWatchLogsRoleArn()
The role ARN for the Amazon CloudWatch Logging role for the user import job.
|
Instant |
completionDate()
The date when the user import job was completed.
|
String |
completionMessage()
The message returned when the user import job is completed.
|
Instant |
creationDate()
The date the user import job was created.
|
boolean |
equals(Object obj) |
Long |
failedUsers()
The number of users that could not be imported.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Long |
importedUsers()
The number of users that were successfully imported.
|
String |
jobId()
The job ID for the user import job.
|
String |
jobName()
The job name for the user import job.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
String |
preSignedUrl()
The pre-signed URL to be used to upload the
.csv file. |
static Class<? extends UserImportJobType.Builder> |
serializableBuilderClass() |
Long |
skippedUsers()
The number of users that were skipped.
|
Instant |
startDate()
The date when the user import job was started.
|
UserImportJobStatusType |
status()
The status of the user import job.
|
String |
statusString()
The status of the user import job.
|
UserImportJobType.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
String |
userPoolId()
The user pool ID for the user pool that the users are being imported into.
|
copy
public String jobName()
The job name for the user import job.
public String jobId()
The job ID for the user import job.
public String userPoolId()
The user pool ID for the user pool that the users are being imported into.
public String preSignedUrl()
The pre-signed URL to be used to upload the .csv
file.
.csv
file.public Instant creationDate()
The date the user import job was created.
public Instant startDate()
The date when the user import job was started.
public Instant completionDate()
The date when the user import job was completed.
public 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.
If the service returns an enum value that is not available in the current SDK version, status
will
return UserImportJobStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from statusString()
.
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
public String statusString()
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.
If the service returns an enum value that is not available in the current SDK version, status
will
return UserImportJobStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from statusString()
.
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
public 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.
public Long importedUsers()
The number of users that were successfully imported.
public Long skippedUsers()
The number of users that were skipped.
public Long failedUsers()
The number of users that could not be imported.
public String completionMessage()
The message returned when the user import job is completed.
public UserImportJobType.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UserImportJobType.Builder,UserImportJobType>
public static UserImportJobType.Builder builder()
public static Class<? extends UserImportJobType.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.