OpenSearchServiceServerless / Client / update_collection
update_collection#
- OpenSearchServiceServerless.Client.update_collection(**kwargs)#
Updates an OpenSearch Serverless collection.
See also: AWS API Documentation
Request Syntax
response = client.update_collection( clientToken='string', description='string', id='string' )
- Parameters:
clientToken (string) –
Unique, case-sensitive identifier to ensure idempotency of the request.
This field is autopopulated if not provided.
description (string) – A description of the collection.
id (string) –
[REQUIRED]
The unique identifier of the collection.
- Return type:
dict
- Returns:
Response Syntax
{ 'updateCollectionDetail': { 'arn': 'string', 'createdDate': 123, 'description': 'string', 'id': 'string', 'lastModifiedDate': 123, 'name': 'string', 'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED', 'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH' } }
Response Structure
(dict) –
updateCollectionDetail (dict) –
Details about the updated collection.
arn (string) –
The Amazon Resource Name (ARN) of the collection.
createdDate (integer) –
The date and time when the collection was created.
description (string) –
The description of the collection.
id (string) –
The unique identifier of the collection.
lastModifiedDate (integer) –
The date and time when the collection was last modified.
name (string) –
The name of the collection.
status (string) –
The current status of the collection.
type (string) –
The collection type.
Exceptions