UserImportJobType

public struct UserImportJobType : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • 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.

    Declaration

    Swift

    public let cloudWatchLogsRoleArn: String?

  • The date when the user import job was completed.

    Declaration

    Swift

    public let completionDate: TimeStamp?

  • The message returned when the user import job is completed.

    Declaration

    Swift

    public let completionMessage: String?

  • The date the user import job was created.

    Declaration

    Swift

    public let creationDate: TimeStamp?

  • The number of users that could not be imported.

    Declaration

    Swift

    public let failedUsers: Int64?

  • The number of users that were successfully imported.

    Declaration

    Swift

    public let importedUsers: Int64?

  • The job ID for the user import job.

    Declaration

    Swift

    public let jobId: String?

  • The job name for the user import job.

    Declaration

    Swift

    public let jobName: String?

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

    Declaration

    Swift

    public let preSignedUrl: String?

  • The number of users that were skipped.

    Declaration

    Swift

    public let skippedUsers: Int64?

  • The date when the user import job was started.

    Declaration

    Swift

    public let startDate: TimeStamp?

  • 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.

    Declaration

    Swift

    public let status: UserImportJobStatusType?

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

    Declaration

    Swift

    public let userPoolId: String?

  • Undocumented

    Declaration

    Swift

    public init(cloudWatchLogsRoleArn: String? = nil, completionDate: TimeStamp? = nil, completionMessage: String? = nil, creationDate: TimeStamp? = nil, failedUsers: Int64? = nil, importedUsers: Int64? = nil, jobId: String? = nil, jobName: String? = nil, preSignedUrl: String? = nil, skippedUsers: Int64? = nil, startDate: TimeStamp? = nil, status: UserImportJobStatusType? = nil, userPoolId: String? = nil)