listMemberships method

Future<ListMembershipsOutput> listMemberships({ int? maxResults, String? nextToken, MembershipStatus? status, })

Lists all memberships resources within the caller's account.

May throw AccessDeniedException. May throw InternalServerException. May throw ThrottlingException. May throw ValidationException.

Parameter maxResults : The maximum number of results that are returned for an API request call. The service chooses a default number if you don't set one. The service might return a nextToken even if the maxResults value has not been met.

Parameter nextToken : The pagination token that's used to fetch the next set of results.

Parameter status : A filter which will return only memberships in the specified status.

Implementation

Future<ListMembershipsOutput> listMemberships({
  int? maxResults,
  String? nextToken,
  MembershipStatus? status,
}) async {
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    100,
  );
  final $query = <String, List<String>>{
    if (maxResults != null) 'maxResults': [maxResults.toString()],
    if (nextToken != null) 'nextToken': [nextToken],
    if (status != null) 'status': [status.value],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri: '/memberships',
    queryParams: $query,
    exceptionFnMap: _exceptionFns,
  );
  return ListMembershipsOutput.fromJson(response);
}