adminUpdateDeviceStatus method

Future<void> adminUpdateDeviceStatus({ required String deviceKey, required String userPoolId, required String username, DeviceRememberedStatusType? deviceRememberedStatus, })

Updates the device status as an administrator.

Calling this action requires developer credentials.

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

Parameter deviceKey : The device key.

Parameter userPoolId : The user pool ID.

Parameter username : The user name.

Parameter deviceRememberedStatus : The status indicating whether a device has been remembered or not.

Implementation

Future<void> adminUpdateDeviceStatus({
  required String deviceKey,
  required String userPoolId,
  required String username,
  DeviceRememberedStatusType? deviceRememberedStatus,
}) async {
  ArgumentError.checkNotNull(deviceKey, 'deviceKey');
  _s.validateStringLength(
    'deviceKey',
    deviceKey,
    1,
    55,
    isRequired: true,
  );
  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.AdminUpdateDeviceStatus'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'DeviceKey': deviceKey,
      'UserPoolId': userPoolId,
      'Username': username,
      if (deviceRememberedStatus != null)
        'DeviceRememberedStatus': deviceRememberedStatus.toValue(),
    },
  );
}