list_groups_older_than_ordering_id

kendra.Client.list_groups_older_than_ordering_id(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.list_groups_older_than_ordering_id(
    IndexId='string',
    DataSourceId='string',
    OrderingId=123,
    NextToken='string',
    MaxResults=123
)

Parameters

• IndexId (string) --

  [REQUIRED]

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

• DataSourceId (string) -- The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.
• OrderingId (integer) --

  [REQUIRED]

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

• NextToken (string) -- 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.
• MaxResults (integer) -- The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.

Return type

dict

Returns

Response Syntax

{
    'GroupsSummaries': [
        {
            'GroupId': 'string',
            'OrderingId': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • GroupsSummaries (list) --

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

    • (dict) --

      Summary information for groups.

      • GroupId (string) --

        The identifier of the group you want group summary information on.

      • OrderingId (integer) --

        The timestamp identifier used for the latest PUT or DELETE action.

  • NextToken (string) --

    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.

Exceptions

• kendra.Client.exceptions.ValidationException
• kendra.Client.exceptions.ResourceNotFoundException
• kendra.Client.exceptions.AccessDeniedException
• kendra.Client.exceptions.ThrottlingException
• kendra.Client.exceptions.ConflictException
• kendra.Client.exceptions.InternalServerException