startUserImportJob method

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

Starts the user import.

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

Parameter jobId : The job ID for the user import job.

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

Implementation

Future<StartUserImportJobResponse> startUserImportJob({
  required String jobId,
  required String userPoolId,
}) async {
  ArgumentError.checkNotNull(jobId, 'jobId');
  _s.validateStringLength(
    'jobId',
    jobId,
    1,
    55,
    isRequired: true,
  );
  ArgumentError.checkNotNull(userPoolId, 'userPoolId');
  _s.validateStringLength(
    'userPoolId',
    userPoolId,
    1,
    55,
    isRequired: true,
  );
  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);
}