listEntitlements method

Future<ListEntitlementsResponse> listEntitlements({ int? maxResults, String? nextToken, })

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

May throw ServiceUnavailableException. May throw TooManyRequestsException. May throw BadRequestException. May throw InternalServerErrorException.

Parameter maxResults : The maximum number of results to return per API request. For example, you submit a ListEntitlements request with MaxResults set at 5. Although 20 items match your request, the service returns no more than the first 5 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value. If MaxResults is not included in the request, the service defaults to pagination with a maximum of 20 results per page.

Parameter nextToken : The token that identifies which batch of results that you want to see. For example, you submit a ListEntitlements request with MaxResults set at 5. The service returns the first batch of results (up to 5) and a NextToken value. To see the next batch of results, you can submit the ListEntitlements request a second time and specify the NextToken value.

Implementation

Future<ListEntitlementsResponse> listEntitlements({
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    1000,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/v1/entitlements',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListEntitlementsResponse.fromJson(response);
}