describeIdentityPool method

Future<IdentityPool> describeIdentityPool({
  1. required String identityPoolId,
})

Gets details about a particular identity pool, including the pool name, ID description, creation date, and current number of users.

You must use Amazon Web Services developer credentials to call this operation.

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

Parameter identityPoolId : An identity pool ID in the format REGION:GUID.

Implementation

Future<IdentityPool> describeIdentityPool({
  required String identityPoolId,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSCognitoIdentityService.DescribeIdentityPool'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'IdentityPoolId': identityPoolId,
    },
  );

  return IdentityPool.fromJson(jsonResponse.body);
}