UpdateCollection
Updates an OpenSearch Serverless collection.
Request Syntax
{
"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.
- 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 description of the collection.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1000.
Required: No
- id
-
The unique identifier of the collection.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 40.
Pattern:
^[a-z0-9]{3,40}$Required: Yes
Response Syntax
{
"updateCollectionDetail": {
"arn": "string",
"createdDate": number,
"description": "string",
"id": "string",
"lastModifiedDate": number,
"name": "string",
"status": "string",
"type": "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.
- updateCollectionDetail
-
Details about the updated collection.
Type: UpdateCollectionDetail 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. When deleting a resource, thrown when the resource is not in the ACTIVE or FAILED state.
HTTP Status Code: 400
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
