startUserImportJob method

Future<StartUserImportJobResponse> startUserImportJob({
  1. required String jobId,
  2. required String userPoolId,
})

Instructs your user pool to start 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.

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

Parameter jobId : The ID of a user import job that you previously created.

Parameter userPoolId : The ID of the user pool that you want to start importing users into.

Implementation

Future<StartUserImportJobResponse> startUserImportJob({
  required String jobId,
  required String userPoolId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.StartUserImportJob'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'JobId': jobId,
      'UserPoolId': userPoolId,
    },
  );

  return StartUserImportJobResponse.fromJson(jsonResponse.body);
}