describeUserPool method

Future<DescribeUserPoolResponse> describeUserPool({
  1. required String userPoolId,
})

Returns the configuration information and metadata of the specified user pool.

May throw ResourceNotFoundException. May throw InvalidParameterException. May throw TooManyRequestsException. May throw NotAuthorizedException. May throw UserPoolTaggingException. May throw InternalErrorException.

Parameter userPoolId : The user pool ID for the user pool you want to describe.

Implementation

Future<DescribeUserPoolResponse> describeUserPool({
  required String userPoolId,
}) async {
  ArgumentError.checkNotNull(userPoolId, 'userPoolId');
  _s.validateStringLength(
    'userPoolId',
    userPoolId,
    1,
    55,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityProviderService.DescribeUserPool'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'UserPoolId': userPoolId,
    },
  );

  return DescribeUserPoolResponse.fromJson(jsonResponse.body);
}