OpenSearchServiceServerless / Client / batch_get_collection_group

batch_get_collection_group¶

OpenSearchServiceServerless.Client.batch_get_collection_group(**kwargs)¶

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.

Request Syntax

response = client.batch_get_collection_group(
    ids=[
        'string',
    ],
    names=[
        'string',
    ]
)

Parameters:

ids (list) –
A list of collection group IDs. You can’t provide names and IDs in the same request.
- (string) –
names (list) –
A list of collection group names. You can’t provide names and IDs in the same request.
- (string) –

Return type:

dict

Returns:

Response Syntax

{
    'collectionGroupDetails': [
        {
            'id': 'string',
            'arn': 'string',
            'name': 'string',
            'standbyReplicas': 'ENABLED'|'DISABLED',
            'description': 'string',
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'createdDate': 123,
            'capacityLimits': {
                'maxIndexingCapacityInOCU': ...,
                'maxSearchCapacityInOCU': ...,
                'minIndexingCapacityInOCU': ...,
                'minSearchCapacityInOCU': ...
            },
            'numberOfCollections': 123
        },
    ],
    'collectionGroupErrorDetails': [
        {
            'id': 'string',
            'name': 'string',
            'errorMessage': 'string',
            'errorCode': 'string'
        },
    ]
}

Response Structure

(dict) –
- collectionGroupDetails (list) –
  
  Details about each collection group.
  - (dict) –
    
    Details 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.
    - standbyReplicas (string) –
      
      Indicates whether standby replicas are used for the collection group.
    - description (string) –
      
      The description of the collection group.
    - tags (list) –
      
      A map of key-value pairs associated with the collection group.
      - (dict) –
        
        A map of key-value pairs associated to an OpenSearch Serverless resource.
        
        key (string) –
        
        The key to use in the tag.
        
        value (string) –
        
        The value of the tag.
    - createdDate (integer) –
      
      The Epoch time when the collection group was created.
    - capacityLimits (dict) –
      
      The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
      - 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.
    - numberOfCollections (integer) –
      
      The number of collections associated with the collection group.
- collectionGroupErrorDetails (list) –
  
  Error information for the request.
  - (dict) –
    
    Error details for a collection group operation.
    - id (string) –
      
      If the request contains collection group IDs, the response includes the IDs provided in the request.
    - name (string) –
      
      If the request contains collection group names, the response includes the names provided in the request.
    - errorMessage (string) –
      
      A description of the error. For example, The specified Collection Group is not found.
    - errorCode (string) –
      
      The error code for the request. For example, NOT_FOUND.

Exceptions

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