describeUserPoolClient method

Future<DescribeUserPoolClientResponse> describeUserPoolClient({
  1. required String clientId,
  2. required String userPoolId,
})

Client method for returning the configuration information and metadata of the specified user pool app client.

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

Parameter clientId : The app client ID of the app associated with the user pool.

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

Implementation

Future<DescribeUserPoolClientResponse> describeUserPoolClient({
  required String clientId,
  required String userPoolId,
}) async {
  ArgumentError.checkNotNull(clientId, 'clientId');
  _s.validateStringLength(
    'clientId',
    clientId,
    1,
    128,
    isRequired: true,
  );
  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.DescribeUserPoolClient'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'ClientId': clientId,
      'UserPoolId': userPoolId,
    },
  );

  return DescribeUserPoolClientResponse.fromJson(jsonResponse.body);
}