Skip to content

List User Import Jobs

cognitoidentityprovider_list_user_import_jobs R Documentation

Lists user import jobs for a user pool

Description

Lists user import jobs for a user pool.

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_list_user_import_jobs(UserPoolId, MaxResults,
  PaginationToken)

Arguments

UserPoolId

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

MaxResults

[required] The maximum number of import jobs you want the request to return.

PaginationToken

This API operation returns a limited number of results. The pagination token is an identifier that you can present in an additional API request with the same parameters. When you include the pagination token, Amazon Cognito returns the next set of items after the current list. Subsequent requests return a new pagination token. By use of this token, you can paginate through the full list of items.

Value

A list with the following syntax: 

list(
  UserImportJobs = list(
    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"
    )
  ),
  PaginationToken = "string"
)

Request syntax

svc$list_user_import_jobs(
  UserPoolId = "string",
  MaxResults = 123,
  PaginationToken = "string"
)