listUserImportJobs method

Future<ListUserImportJobsResponse> listUserImportJobs({ required int maxResults, required String userPoolId, String? paginationToken, })

Lists the user import jobs.

May throw ResourceNotFoundException. May throw InvalidParameterException. May throw TooManyRequestsException. May throw NotAuthorizedException. May throw InternalErrorException.

Parameter maxResults : The maximum number of import jobs you want the request to return.

Parameter userPoolId : The user pool ID for the user pool that the users are being imported into.

Parameter paginationToken : An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.

Implementation

Future<ListUserImportJobsResponse> listUserImportJobs({
  required int maxResults,
  required String userPoolId,
  String? paginationToken,
}) async {
  ArgumentError.checkNotNull(maxResults, 'maxResults');
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    60,
    isRequired: true,
  );
  ArgumentError.checkNotNull(userPoolId, 'userPoolId');
  _s.validateStringLength(
    'userPoolId',
    userPoolId,
    1,
    55,
    isRequired: true,
  );
  _s.validateStringLength(
    'paginationToken',
    paginationToken,
    1,
    1152921504606846976,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.ListUserImportJobs'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'MaxResults': maxResults,
      'UserPoolId': userPoolId,
      if (paginationToken != null) 'PaginationToken': paginationToken,
    },
  );

  return ListUserImportJobsResponse.fromJson(jsonResponse.body);
}