deleteUserPoolReplica method
Deletes a secondary replica user pool. You can only delete replicas that are in the INACTIVE status. This operation must be called from the primary Region.
Learn more
- Signing Amazon Web Services API Requests
- Using the Amazon Cognito user pools API and user pool endpoints
May throw InternalErrorException.
May throw InvalidParameterException.
May throw NotAuthorizedException.
May throw OperationNotEnabledException.
May throw ResourceNotFoundException.
May throw TooManyRequestsException.
Parameter regionName :
The Amazon Web Services Region of the replica to delete.
Parameter userPoolId :
The ID of the user pool that contains the replica to delete.
Implementation
Future<DeleteUserPoolReplicaResponse> deleteUserPoolReplica({
required String regionName,
required String userPoolId,
}) async {
final headers = <String, String>{
'Content-Type': 'application/x-amz-json-1.1',
'X-Amz-Target': 'AWSCognitoIdentityProviderService.DeleteUserPoolReplica'
};
final jsonResponse = await _protocol.send(
method: 'POST',
requestUri: '/',
exceptionFnMap: _exceptionFns,
// TODO queryParams
headers: headers,
payload: {
'RegionName': regionName,
'UserPoolId': userPoolId,
},
);
return DeleteUserPoolReplicaResponse.fromJson(jsonResponse.body);
}