

# ListGroupsOlderThanOrderingId


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

 `ListGroupsOlderThanOrderingId` is currently not supported in the AWS GovCloud (US-West) region.

## Request Syntax


```
{
   "DataSourceId": "string",
   "IndexId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "OrderingId": number
}
```

## Request Parameters


For information about the parameters that are common to all actions, see [Common Parameters](CommonParameters.md).

The request accepts the following data in JSON format.

 ** [DataSourceId](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **   <a name="kendra-ListGroupsOlderThanOrderingId-request-DataSourceId"></a>
The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9_-]*`   
Required: No

 ** [IndexId](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **   <a name="kendra-ListGroupsOlderThanOrderingId-request-IndexId"></a>
The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.  
Type: String  
Length Constraints: Fixed length of 36.  
Pattern: `[a-zA-Z0-9][a-zA-Z0-9-]*`   
Required: Yes

 ** [MaxResults](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **   <a name="kendra-ListGroupsOlderThanOrderingId-request-MaxResults"></a>
 The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.   
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 10.  
Required: No

 ** [NextToken](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **   <a name="kendra-ListGroupsOlderThanOrderingId-request-NextToken"></a>
 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.  
Required: No

 ** [OrderingId](#API_ListGroupsOlderThanOrderingId_RequestSyntax) **   <a name="kendra-ListGroupsOlderThanOrderingId-request-OrderingId"></a>
The timestamp identifier used for the latest `PUT` or `DELETE` action for mapping users to their groups.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 32535158400000.  
Required: Yes

## Response Syntax


```
{
   "GroupsSummaries": [ 
      { 
         "GroupId": "string",
         "OrderingId": number
      }
   ],
   "NextToken": "string"
}
```

## Response Elements


If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [GroupsSummaries](#API_ListGroupsOlderThanOrderingId_ResponseSyntax) **   <a name="kendra-ListGroupsOlderThanOrderingId-response-GroupsSummaries"></a>
 Summary information for list of groups that are mapped to users before a given ordering or timestamp identifier.   
Type: Array of [GroupSummary](API_GroupSummary.md) objects

 ** [NextToken](#API_ListGroupsOlderThanOrderingId_ResponseSyntax) **   <a name="kendra-ListGroupsOlderThanOrderingId-response-NextToken"></a>
 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 800.

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** AccessDeniedException **   
You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.  
HTTP Status Code: 400

 ** ConflictException **   
A conflict occurred with the request. Please fix any inconsistences with your resources and try again.  
HTTP Status Code: 400

 ** InternalServerException **   
An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact [Support](http://aws.amazon.com/contact-us/) for help.  
HTTP Status Code: 500

 ** ResourceNotFoundException **   
The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.  
HTTP Status Code: 400

 ** ThrottlingException **   
The request was denied due to request throttling. Please reduce the number of requests and try again.  
HTTP Status Code: 400

 ** ValidationException **   
The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.  
HTTP Status Code: 400

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/kendra-2019-02-03/ListGroupsOlderThanOrderingId) 