Skip to content

Instructs your user pool to stop a running job that's importing users from a CSV file that contains their usernames and attributes

Description

Instructs your user pool to stop a running job that's importing users from a CSV file that contains their usernames and attributes. For more information about importing users from a CSV file, see Importing users from a CSV file.

Usage

cognitoidentityprovider_stop_user_import_job(UserPoolId, JobId)

Arguments

  • UserPoolId

    [required] The ID of the user pool that you want to stop.

  • JobId

    [required] The ID of a running 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",
    PasswordHashingAlgorithm = "BCRYPT"|"SCRYPT"|"ARGON2ID"|"PBKDF2_SHA256"
  )
)

Request syntax

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