OpenSearchServiceServerless / Client / list_collection_groups

list_collection_groups¶

OpenSearchServiceServerless.Client.list_collection_groups(**kwargs)¶

Returns a list of collection groups. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Request Syntax

response = client.list_collection_groups(
    nextToken='string',
    maxResults=123
)

Parameters:

nextToken (string) – 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.
maxResults (integer) – The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'collectionGroupSummaries': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'numberOfCollections': 123,
            'createdDate': 123,
            'capacityLimits': {
                'maxIndexingCapacityInOCU': ...,
                'maxSearchCapacityInOCU': ...,
                'minIndexingCapacityInOCU': ...,
                'minSearchCapacityInOCU': ...
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- collectionGroupSummaries (list) –
  
  Details about each collection group.
  - (dict) –
    
    Summary information about a collection group.
    - id (string) –
      
      The unique identifier of the collection group.
    - arn (string) –
      
      The Amazon Resource Name (ARN) of the collection group.
    - name (string) –
      
      The name of the collection group.
    - numberOfCollections (integer) –
      
      The number of collections within the collection group.
    - createdDate (integer) –
      
      The Epoch time when the collection group was created.
    - capacityLimits (dict) –
      
      Capacity limits for a collection group. These limits define the minimum and maximum OpenSearch Compute Units (OCUs) for indexing and search operations that can be used by collections in the group.
      - maxIndexingCapacityInOCU (float) –
        
        The maximum indexing capacity for collections in the group.
      - maxSearchCapacityInOCU (float) –
        
        The maximum search capacity for collections in the group.
      - minIndexingCapacityInOCU (float) –
        
        The minimum indexing capacity for collections in the group.
      - minSearchCapacityInOCU (float) –
        
        The minimum search capacity for collections in the group.
- nextToken (string) –
  
  When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Exceptions

OpenSearchServiceServerless.Client.exceptions.InternalServerException
OpenSearchServiceServerless.Client.exceptions.ValidationException