listGroupsOlderThanOrderingId method

Future<ListGroupsOlderThanOrderingIdResponse> listGroupsOlderThanOrderingId({
  1. required String indexId,
  2. required int orderingId,
  3. String? dataSourceId,
  4. int? maxResults,
  5. String? nextToken,
})

Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.

ListGroupsOlderThanOrderingId is currently not supported in the Amazon Web Services GovCloud (US-West) region.

May throw AccessDeniedException. May throw ConflictException. May throw InternalServerException. May throw ResourceNotFoundException. May throw ThrottlingException. May throw ValidationException.

Parameter indexId : The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.

Parameter orderingId : The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.

Parameter dataSourceId : The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.

Parameter maxResults : The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.

Parameter nextToken : If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier.

Implementation

Future<ListGroupsOlderThanOrderingIdResponse> listGroupsOlderThanOrderingId({
  required String indexId,
  required int orderingId,
  String? dataSourceId,
  int? maxResults,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'orderingId',
    orderingId,
    0,
    32535158400000,
    isRequired: true,
  );
  _s.validateNumRange(
    'maxResults',
    maxResults,
    1,
    10,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AWSKendraFrontendService.ListGroupsOlderThanOrderingId'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'IndexId': indexId,
      'OrderingId': orderingId,
      if (dataSourceId != null) 'DataSourceId': dataSourceId,
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return ListGroupsOlderThanOrderingIdResponse.fromJson(jsonResponse.body);
}