Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class UserImportJobType

java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.UserImportJobType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UserImportJobType.Builder,UserImportJobType>
@Generated("software.amazon.awssdk:codegen") public final class UserImportJobType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserImportJobType.Builder,UserImportJobType>

A user import job in a user pool. Describes the status of user import with a CSV file. For more information, see Importing users into user pools from a CSV file.

See Also:

  • Method Details

    • jobName

      public final String jobName()

      The friendly name of the user import job.

      Returns:
      The friendly name of the user import job.

    • jobId

      public final String jobId()

      The ID of the user import job.

      Returns:
      The ID of the user import job.

    • userPoolId

      public final String userPoolId()

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

      Returns:
      The ID of the user pool that the users are being imported into.

    • preSignedUrl

      public final String preSignedUrl()

      The pre-signed URL target for uploading the CSV file.

      Returns:
      The pre-signed URL target for uploading the CSV file.

    • creationDate

      public final Instant creationDate()

      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

      Returns:
      The date and time when the item was created. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

    • startDate

      public final Instant startDate()

      The date when the user import job was started.

      Returns:
      The date when the user import job was started.

    • completionDate

      public final Instant completionDate()

      The date when the user import job was completed.

      Returns:
      The date when the user import job was completed.

    • status

      public final 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 can't 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 statusAsString().

      Returns:
      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 can't be started.

      See Also:

    • statusAsString

      public final String statusAsString()

      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 can't 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 statusAsString().

      Returns:
      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 can't be started.

      See Also:

    • cloudWatchLogsRoleArn

      public final String cloudWatchLogsRoleArn()

      The role Amazon Resource Name (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:
      The role Amazon Resource Name (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.

    • importedUsers

      public final Long importedUsers()

      The number of users that were successfully imported.

      Returns:
      The number of users that were successfully imported.

    • skippedUsers

      public final Long skippedUsers()

      The number of users that were skipped.

      Returns:
      The number of users that were skipped.

    • failedUsers

      public final Long failedUsers()

      The number of users that couldn't be imported.

      Returns:
      The number of users that couldn't be imported.

    • completionMessage

      public final String completionMessage()

      The message returned when the user import job is completed.

      Returns:
      The message returned when the user import job is completed.

    • toBuilder

      public UserImportJobType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UserImportJobType.Builder,UserImportJobType>

    • builder

      public static UserImportJobType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UserImportJobType.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo