Returns a list of collection groups. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Parameters:
-
next_token
(Optional[str], default:
None
)
–
If your initial ListCollectionGroups operation returns a nextToken, you can include the returned nextToken in subsequent ListCollectionGroups operations, which returns results in the next page.
-
max_results
(Optional[int], default:
None
)
–
The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.
Raises:
Source code in docs_src/capo_opensearchserverless/_services/open_search_serverless.py
| def list_collection_groups(
self,
*,
config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
next_token: Optional[str] = None,
max_results: Optional[int] = None,
) -> "capo_opensearchserverless.types.list_collection_groups_response.ListCollectionGroupsResponse":
"""<p>Returns a list of collection groups. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/serverless-manage.html">Creating and managing Amazon OpenSearch Serverless collections</a>.</p>
Args:
next_token: <p>If your initial <code>ListCollectionGroups</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListCollectionGroups</code> operations, which returns results in the next page.</p>
max_results: <p>The maximum number of results to return. Default is 20. You can use <code>nextToken</code> to get the next page of results.</p>
Raises:
capo_opensearchserverless.errors.internal_server_exception.InternalServerException: <p>Thrown when an error internal to the service occurs while processing a request.</p>
capo_opensearchserverless.errors.validation_exception.ValidationException: <p>Thrown when the HTTP request contains invalid input or is missing required input.</p>
capo_opensearchserverless.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_opensearchserverless.types.list_collection_groups_request.ListCollectionGroupsRequest]",
) -> OperationResponse[
"capo_opensearchserverless.types.list_collection_groups_response.ListCollectionGroupsResponse"
]:
import capo_opensearchserverless._operations.open_search_serverless.list_collection_groups
output, http_response = (
capo_opensearchserverless._operations.open_search_serverless.list_collection_groups.list_collection_groups(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListCollectionGroups")
)
input_: capo_opensearchserverless.types.list_collection_groups_request.ListCollectionGroupsRequest = {}
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
|