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(
    id='string',
    description='string',
    clientToken='string'
)
Parameters:

  • id (string) –

    [REQUIRED]

    The unique identifier of the collection.

  • description (string) – A description of the collection.

  • clientToken (string) –

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

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'updateCollectionDetail': {
        'id': 'string',
        'name': 'string',
        'status': 'CREATING'|'DELETING'|'ACTIVE'|'FAILED',
        'type': 'SEARCH'|'TIMESERIES'|'VECTORSEARCH',
        'description': 'string',
        'arn': 'string',
        'createdDate': 123,
        'lastModifiedDate': 123
    }
}

Response Structure

  • (dict) –

    • updateCollectionDetail (dict) –

      Details about the updated collection.

      • id (string) –

        The unique identifier of the collection.

      • name (string) –

        The name of the collection.

      • status (string) –

        The current status of the collection.

      • type (string) –

        The collection type.

      • description (string) –

        The description of the collection.

      • arn (string) –

        The Amazon Resource Name (ARN) of the collection.

      • createdDate (integer) –

        The date and time when the collection was created.

      • lastModifiedDate (integer) –

        The date and time when the collection was last modified.

Exceptions