describeUserPoolClient method

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

Given an app client ID, returns configuration information. This operation is useful when you want to inspect an existing app client and programmatically replicate the configuration to another app client. For more information about app clients, see App clients.

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 clientId : The ID of the app client that you want to describe.

Parameter userPoolId : The ID of the user pool that contains the app client you want to describe.

Implementation

Future<DescribeUserPoolClientResponse> describeUserPoolClient({
  required String clientId,
  required String userPoolId,
}) async {
  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);
}