ListGroupsOlderThanOrderingIdCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KendraClient, ListGroupsOlderThanOrderingIdCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, ListGroupsOlderThanOrderingIdCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // ListGroupsOlderThanOrderingIdRequest
  IndexId: "STRING_VALUE", // required
  DataSourceId: "STRING_VALUE",
  OrderingId: Number("long"), // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListGroupsOlderThanOrderingIdCommand(input);
const response = await client.send(command);
// { // ListGroupsOlderThanOrderingIdResponse
//   GroupsSummaries: [ // ListOfGroupSummaries
//     { // GroupSummary
//       GroupId: "STRING_VALUE",
//       OrderingId: Number("long"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListGroupsOlderThanOrderingIdCommand Input

See ListGroupsOlderThanOrderingIdCommandInput for more details

Parameter
Type
Description
IndexId
Required
string | undefined

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

OrderingId
Required
number | undefined

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

DataSourceId
string | undefined

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

MaxResults
number | undefined

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

NextToken
string | undefined

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.

ListGroupsOlderThanOrderingIdCommand Output

See ListGroupsOlderThanOrderingIdCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
GroupsSummaries
GroupSummary[] | undefined

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

NextToken
string | undefined

If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

ConflictException
client

A conflict occurred with the request. Please fix any inconsistences with your resources and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to request throttling. Please reduce the number of requests and try again.

ValidationException
client

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

KendraServiceException
Base exception class for all service exceptions from Kendra service.