AWSCognitoIdentityProviderUserImportJobType

Objective-C

@interface AWSCognitoIdentityProviderUserImportJobType

Swift

class AWSCognitoIdentityProviderUserImportJobType

The user import job type.

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable cloudWatchLogsRoleArn;

    Swift

    var cloudWatchLogsRoleArn: String? { get set }

  • The date when the user import job was completed.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable completionDate;

    Swift

    var completionDate: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable completionMessage;

    Swift

    var completionMessage: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable creationDate;

    Swift

    var creationDate: Date? { get set }

  • The number of users that couldn’t be imported.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable failedUsers;

    Swift

    var failedUsers: NSNumber? { get set }

  • The number of users that were successfully imported.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable importedUsers;

    Swift

    var importedUsers: NSNumber? { get set }

  • The job ID for the user import job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobId;

    Swift

    var jobId: String? { get set }

  • The job name for the user import job.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable jobName;

    Swift

    var jobName: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable preSignedUrl;

    Swift

    var preSignedUrl: String? { get set }

  • The number of users that were skipped.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable skippedUsers;

    Swift

    var skippedUsers: NSNumber? { get set }

  • The date when the user import job was started.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startDate;

    Swift

    var startDate: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSCognitoIdentityProviderUserImportJobStatusType status;

    Swift

    var status: AWSCognitoIdentityProviderUserImportJobStatusType { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable userPoolId;

    Swift

    var userPoolId: String? { get set }