AWSCognitoIdentityProviderUserImportJobType Class Reference

Inherits from AWSModel : AWSMTLModel
Declared in AWSCognitoIdentityProviderModel.h
AWSCognitoIdentityProviderModel.m

Overview

The user import job type.

  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.

@property (nonatomic, strong) NSString *cloudWatchLogsRoleArn

Declared In

AWSCognitoIdentityProviderModel.h

  completionDate

The date when the user import job was completed.

@property (nonatomic, strong) NSDate *completionDate

Declared In

AWSCognitoIdentityProviderModel.h

  completionMessage

The message returned when the user import job is completed.

@property (nonatomic, strong) NSString *completionMessage

Declared In

AWSCognitoIdentityProviderModel.h

  creationDate

The date the user import job was created.

@property (nonatomic, strong) NSDate *creationDate

Declared In

AWSCognitoIdentityProviderModel.h

  failedUsers

The number of users that could not be imported.

@property (nonatomic, strong) NSNumber *failedUsers

Declared In

AWSCognitoIdentityProviderModel.h

  importedUsers

The number of users that were successfully imported.

@property (nonatomic, strong) NSNumber *importedUsers

Declared In

AWSCognitoIdentityProviderModel.h

  jobId

The job ID for the user import job.

@property (nonatomic, strong) NSString *jobId

Declared In

AWSCognitoIdentityProviderModel.h

  jobName

The job name for the user import job.

@property (nonatomic, strong) NSString *jobName

Declared In

AWSCognitoIdentityProviderModel.h

  preSignedUrl

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

@property (nonatomic, strong) NSString *preSignedUrl

Declared In

AWSCognitoIdentityProviderModel.h

  skippedUsers

The number of users that were skipped.

@property (nonatomic, strong) NSNumber *skippedUsers

Declared In

AWSCognitoIdentityProviderModel.h

  startDate

The date when the user import job was started.

@property (nonatomic, strong) NSDate *startDate

Declared In

AWSCognitoIdentityProviderModel.h

  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.

@property (nonatomic, assign) AWSCognitoIdentityProviderUserImportJobStatusType status

Declared In

AWSCognitoIdentityProviderModel.h

  userPoolId

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

@property (nonatomic, strong) NSString *userPoolId

Declared In

AWSCognitoIdentityProviderModel.h