updateDeviceStatus method

Future<void> updateDeviceStatus({ required String accessToken, required String deviceKey, DeviceRememberedStatusType? deviceRememberedStatus, })

Updates the device status.

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

Parameter accessToken : The access token.

Parameter deviceKey : The device key.

Parameter deviceRememberedStatus : The status of whether a device is remembered.

Implementation

Future<void> updateDeviceStatus({
  required String accessToken,
  required String deviceKey,
  DeviceRememberedStatusType? deviceRememberedStatus,
}) async {
  ArgumentError.checkNotNull(accessToken, 'accessToken');
  ArgumentError.checkNotNull(deviceKey, 'deviceKey');
  _s.validateStringLength(
    'deviceKey',
    deviceKey,
    1,
    55,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.UpdateDeviceStatus'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'AccessToken': accessToken,
      'DeviceKey': deviceKey,
      if (deviceRememberedStatus != null)
        'DeviceRememberedStatus': deviceRememberedStatus.toValue(),
    },
  );
}