Start User Import Job

cognitoidentityprovider_start_user_import_job

R Documentation

Starts the user import

Description

Starts the user import.

Usage

cognitoidentityprovider_start_user_import_job(UserPoolId, JobId)

Arguments

UserPoolId

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

JobId

[required] The job ID for the user import job.

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"
  )
)

Request syntax

svc$start_user_import_job(
  UserPoolId = "string",
  JobId = "string"
)