Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

UpdateCollectionGroup

Updates the description and capacity limits of a collection group.

Request Syntax


{
   "capacityLimits": { 
      "maxIndexingCapacityInOCU": number,
      "maxSearchCapacityInOCU": number,
      "minIndexingCapacityInOCU": number,
      "minSearchCapacityInOCU": number
   },
   "clientToken": "string",
   "description": "string",
   "id": "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.

capacityLimits

Updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).

Type: CollectionGroupCapacityLimits object

Required: No

clientToken

Unique, case-sensitive identifier to ensure idempotency of the request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No

description

A new description for the collection group.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Required: No

id

The unique identifier of the collection group to update.

Type: String

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

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

Required: Yes

Response Syntax


{
   "updateCollectionGroupDetail": { 
      "arn": "string",
      "capacityLimits": { 
         "maxIndexingCapacityInOCU": number,
         "maxSearchCapacityInOCU": number,
         "minIndexingCapacityInOCU": number,
         "minSearchCapacityInOCU": number
      },
      "createdDate": number,
      "description": "string",
      "id": "string",
      "lastModifiedDate": number,
      "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.

updateCollectionGroupDetail

Details about the updated collection group.

Type: UpdateCollectionGroupDetail object

Errors

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

ConflictException

When creating a resource, thrown when a resource with the same name already exists or is being created.

HTTP Status Code: 400

InternalServerException

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

HTTP Status Code: 500

ServiceQuotaExceededException

Thrown when you attempt to create more resources than the service allows based on service quotas.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400