Describe User Import Job

cognitoidentityprovider_describe_user_import_job

R Documentation

Describes a user import job

Description

Describes a user import job. For more information about user CSV import, see Importing users from a CSV file.

Usage

cognitoidentityprovider_describe_user_import_job(UserPoolId, JobId)

Arguments

UserPoolId

[required] The ID of the user pool that's associated with the import job.

JobId

[required] The Id of the user import job that you want to describe.

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$describe_user_import_job(
  UserPoolId = "string",
  JobId = "string"
)