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.
Parameters:
-
index_id
(IndexId)
–
The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.
-
data_source_id
(Optional[DataSourceId], default:
None
)
–
The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.
-
ordering_id
(PrincipalOrderingId)
–
The timestamp identifier used for the latest PUT or DELETE action for mapping users to their groups.
-
next_token
(Optional[NextToken], default:
None
)
–
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.
-
max_results
(Optional[MaxResultsIntegerForListPrincipalsRequest], default:
None
)
–
The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.
Raises:
-
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.
-
ConflictException
–
A conflict occurred with the request. Please fix any inconsistences with your resources and try again.
-
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 for help.
-
ResourceNotFoundException
–
The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.
-
ThrottlingException
–
The request was denied due to request throttling. Please reduce the number of requests and try again.
-
ValidationException
–
The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.
-
UnknownServiceError
–
The service returned an error code this client does not model.
Source code in docs_src/capo_kendra/_services/kendra.py
| def list_groups_older_than_ordering_id(
self,
index_id: "capo_kendra.types.index_id.IndexId",
ordering_id: "capo_kendra.types.principal_ordering_id.PrincipalOrderingId",
*,
config_overrides: Optional[kendraClientConfig] = None,
data_source_id: Optional[
"capo_kendra.types.data_source_id.DataSourceId"
] = None,
next_token: Optional["capo_kendra.types.next_token.NextToken"] = None,
max_results: Optional[
"capo_kendra.types.max_results_integer_for_list_principals_request.MaxResultsIntegerForListPrincipalsRequest"
] = None,
) -> "capo_kendra.types.list_groups_older_than_ordering_id_response.ListGroupsOlderThanOrderingIdResponse":
"""<p>Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.</p> <p> <code>ListGroupsOlderThanOrderingId</code> is currently not supported in the Amazon Web Services GovCloud (US-West) region.</p>
Args:
index_id: <p>The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.</p>
data_source_id: <p>The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.</p>
ordering_id: <p>The timestamp identifier used for the latest <code>PUT</code> or <code>DELETE</code> action for mapping users to their groups.</p>
next_token: <p> 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. </p>
max_results: <p> The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier. </p>
Raises:
capo_kendra.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.</p>
capo_kendra.errors.conflict_exception.ConflictException: <p>A conflict occurred with the request. Please fix any inconsistences with your resources and try again.</p>
capo_kendra.errors.internal_server_exception.InternalServerException: <p>An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
capo_kendra.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.</p>
capo_kendra.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Please reduce the number of requests and try again.</p>
capo_kendra.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.</p>
capo_kendra.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_kendra.types.list_groups_older_than_ordering_id_request.ListGroupsOlderThanOrderingIdRequest]",
) -> OperationResponse[
"capo_kendra.types.list_groups_older_than_ordering_id_response.ListGroupsOlderThanOrderingIdResponse"
]:
import capo_kendra._operations.aws_kendra_frontend_service.list_groups_older_than_ordering_id
output, http_response = (
capo_kendra._operations.aws_kendra_frontend_service.list_groups_older_than_ordering_id.list_groups_older_than_ordering_id(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListGroupsOlderThanOrderingId")
)
input_: capo_kendra.types.list_groups_older_than_ordering_id_request.ListGroupsOlderThanOrderingIdRequest = {
"index_id": index_id,
"ordering_id": ordering_id,
}
if data_source_id is not None:
input_["data_source_id"] = data_source_id
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|