describeUserPoolDomain method

Future<DescribeUserPoolDomainResponse> describeUserPoolDomain({
  1. required String domain,
})

Given a user pool domain name, returns information about the domain configuration.

Learn more

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

Parameter domain : The domain that you want to describe. For custom domains, this is the fully-qualified domain name, such as auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, such as auth.

Implementation

Future<DescribeUserPoolDomainResponse> describeUserPoolDomain({
  required String domain,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.DescribeUserPoolDomain'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Domain': domain,
    },
  );

  return DescribeUserPoolDomainResponse.fromJson(jsonResponse.body);
}