deleteTerms method

Future<void> deleteTerms({
  1. required String termsId,
  2. required String userPoolId,
})

Deletes the terms documents with the requested ID from your app client.

Learn more

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

Parameter termsId : The ID of the terms documents that you want to delete.

Parameter userPoolId : The ID of the user pool that contains the terms documents that you want to delete.

Implementation

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