Returns attributes for one or more collection groups, including capacity limits and the number of collections in each group. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Parameters:
-
ids
(Optional[CollectionGroupIds], default:
None
)
–
A list of collection group IDs. You can't provide names and IDs in the same request.
-
names
(Optional[CollectionGroupNames], default:
None
)
–
A list of collection group names. You can't provide names and IDs in the same request.
Raises:
Source code in docs_src/capo_opensearchserverless/_services/open_search_serverless.py
| def batch_get_collection_group(
self,
*,
config_overrides: Optional[OpenSearchServerlessClientConfig] = None,
ids: Optional[
"capo_opensearchserverless.types.collection_group_ids.CollectionGroupIds"
] = None,
names: Optional[
"capo_opensearchserverless.types.collection_group_names.CollectionGroupNames"
] = None,
) -> "capo_opensearchserverless.types.batch_get_collection_group_response.BatchGetCollectionGroupResponse":
"""<p>Returns attributes for one or more collection groups, including capacity limits and the number of collections in each group. 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:
ids: <p>A list of collection group IDs. You can't provide names and IDs in the same request.</p>
names: <p>A list of collection group names. You can't provide names and IDs in the same request.</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.batch_get_collection_group_request.BatchGetCollectionGroupRequest]",
) -> OperationResponse[
"capo_opensearchserverless.types.batch_get_collection_group_response.BatchGetCollectionGroupResponse"
]:
import capo_opensearchserverless._operations.open_search_serverless.batch_get_collection_group
output, http_response = (
capo_opensearchserverless._operations.open_search_serverless.batch_get_collection_group.batch_get_collection_group(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("BatchGetCollectionGroup")
)
input_: capo_opensearchserverless.types.batch_get_collection_group_request.BatchGetCollectionGroupRequest = {}
if ids is not None:
input_["ids"] = ids
if names is not None:
input_["names"] = names
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|