adminGetUser method

Future<AdminGetUserResponse> adminGetUser({ required String userPoolId, required String username, })

Gets the specified user by user name in a user pool as an administrator. Works on any user.

Calling this action requires developer credentials.

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

Parameter userPoolId : The user pool ID for the user pool where you want to get information about the user.

Parameter username : The user name of the user you wish to retrieve.

Implementation

Future<AdminGetUserResponse> adminGetUser({
  required String userPoolId,
  required String username,
}) async {
  ArgumentError.checkNotNull(userPoolId, 'userPoolId');
  _s.validateStringLength(
    'userPoolId',
    userPoolId,
    1,
    55,
    isRequired: true,
  );
  ArgumentError.checkNotNull(username, 'username');
  _s.validateStringLength(
    'username',
    username,
    1,
    128,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.AdminGetUser'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'UserPoolId': userPoolId,
      'Username': username,
    },
  );

  return AdminGetUserResponse.fromJson(jsonResponse.body);
}