Creates a user import job¶

Description¶

Creates a user import job. You can import users into user pools from a comma-separated values (CSV) file without adding Amazon Cognito MAU costs to your Amazon Web Services bill.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

Usage¶

cognitoidentityprovider_create_user_import_job(JobName, UserPoolId,
  CloudWatchLogsRoleArn, PasswordHashingAlgorithm)

Arguments¶

JobName

[required] A friendly name for the user import job.
UserPoolId

[required] The ID of the user pool that you want to import users into.
CloudWatchLogsRoleArn

[required] You must specify an IAM role that has permission to log import-job results to Amazon CloudWatch Logs. This parameter is the ARN of that role.
PasswordHashingAlgorithm

The password hashing algorithm used to generate the hashes in the CSV file for this import job.

Valid values: BCRYPT | SCRYPT | ARGON2ID | PBKDF2_SHA256

Value¶

A list with the following syntax:

list(
  UserImportJob = list(
    JobName = "string",
    JobId = "string",
    UserPoolId = "string",
    PreSignedUrl = "string",
    CreationDate = as.POSIXct(
      "2015-01-01"
    ),
    StartDate = as.POSIXct(
      "2015-01-01"
    ),
    CompletionDate = as.POSIXct(
      "2015-01-01"
    ),
    Status = "Created"|"Pending"|"InProgress"|"Stopping"|"Expired"|"Stopped"|"Failed"|"Succeeded",
    CloudWatchLogsRoleArn = "string",
    ImportedUsers = 123,
    SkippedUsers = 123,
    FailedUsers = 123,
    CompletionMessage = "string",
    PasswordHashingAlgorithm = "BCRYPT"|"SCRYPT"|"ARGON2ID"|"PBKDF2_SHA256"
  )
)

Request syntax¶

svc$create_user_import_job(
  JobName = "string",
  UserPoolId = "string",
  CloudWatchLogsRoleArn = "string",
  PasswordHashingAlgorithm = "BCRYPT"|"SCRYPT"|"ARGON2ID"|"PBKDF2_SHA256"
)