List User Import Jobs

cognitoidentityprovider_list_user_import_jobs

R Documentation

Given a user pool ID, returns user import jobs and their details

Description

Given a user pool ID, returns user import jobs and their details. Import jobs are retained in user pool configuration so that you can stage, stop, start, review, and delete them. For more information about user import, see Importing users from a CSV file.

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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_list_user_import_jobs(UserPoolId, MaxResults,
  PaginationToken)

Arguments

UserPoolId	[required] The ID of the user pool where you want to list import jobs.
MaxResults	[required] The maximum number of import jobs that you want Amazon Cognito to return in the response.
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"
)