Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

BatchGetCollectionGroup

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


{
   "ids": [ "string" ],
   "names": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ids

A list of collection group IDs. You can't provide names and IDs in the same request.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 3. Maximum length of 40.

Pattern: [a-z0-9]{3,40}

Required: No

names

A list of collection group names. You can't provide names and IDs in the same request.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 3. Maximum length of 32.

Pattern: [a-z][a-z0-9-]+

Required: No

Response Syntax


{
   "collectionGroupDetails": [ 
      { 
         "arn": "string",
         "capacityLimits": { 
            "maxIndexingCapacityInOCU": number,
            "maxSearchCapacityInOCU": number,
            "minIndexingCapacityInOCU": number,
            "minSearchCapacityInOCU": number
         },
         "createdDate": number,
         "description": "string",
         "id": "string",
         "name": "string",
         "numberOfCollections": number,
         "standbyReplicas": "string",
         "tags": [ 
            { 
               "key": "string",
               "value": "string"
            }
         ]
      }
   ],
   "collectionGroupErrorDetails": [ 
      { 
         "errorCode": "string",
         "errorMessage": "string",
         "id": "string",
         "name": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

collectionGroupDetails

Details about each collection group.

Type: Array of CollectionGroupDetail objects

collectionGroupErrorDetails

Error information for the request.

Type: Array of CollectionGroupErrorDetail objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

Thrown when an error internal to the service occurs while processing a request.

HTTP Status Code: 500

ValidationException

Thrown when the HTTP request contains invalid input or is missing required input.

HTTP Status Code: 400