Skip to content

CreateCollectionDetail

Source code in docs_src/capo_opensearchserverless/types/create_collection_detail.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
class CreateCollectionDetail(TypedDict, closed=True):
    id: NotRequired["capo_opensearchserverless.types.collection_id.CollectionId"]
    """<p>The unique identifier of the collection.</p>"""
    name: NotRequired["capo_opensearchserverless.types.collection_name.CollectionName"]
    """<p>The name of the collection.</p>"""
    status: NotRequired[
        "capo_opensearchserverless.types.collection_status.CollectionStatus"
    ]
    """<p>The current status of the collection.</p>"""
    type: NotRequired["capo_opensearchserverless.types.collection_type.CollectionType"]
    """<p>The type of collection.</p>"""
    description: NotRequired["str"]
    """<p>A description of the collection.</p>"""
    arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the collection.</p>"""
    kms_key_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.</p>"""
    standby_replicas: NotRequired[
        "capo_opensearchserverless.types.standby_replicas.StandbyReplicas"
    ]
    """<p>Creates details about an OpenSearch Serverless collection.</p>"""
    deletion_protection: NotRequired[
        "capo_opensearchserverless.types.deletion_protection.DeletionProtection"
    ]
    """<p>Indicates whether deletion protection is <code>ENABLED</code> or <code>DISABLED</code> for the collection.</p>"""
    vector_options: NotRequired[
        "capo_opensearchserverless.types.vector_options.VectorOptions"
    ]
    """<p>Configuration options for vector search capabilities in the collection.</p>"""
    created_date: NotRequired["int"]
    """<p>The Epoch time when the collection was created.</p>"""
    last_modified_date: NotRequired["int"]
    """<p>The date and time when the collection was last modified.</p>"""
    collection_group_name: NotRequired[
        "capo_opensearchserverless.types.collection_group_name.CollectionGroupName"
    ]
    """<p>The name of the collection group that contains this collection.</p>"""

arn instance-attribute 

arn: NotRequired[str]

The Amazon Resource Name (ARN) of the collection.

collection_group_name instance-attribute 

collection_group_name: NotRequired[CollectionGroupName]

The name of the collection group that contains this collection.

created_date instance-attribute 

created_date: NotRequired[int]

The Epoch time when the collection was created.

deletion_protection instance-attribute 

deletion_protection: NotRequired[DeletionProtection]

Indicates whether deletion protection is ENABLED or DISABLED for the collection.

description instance-attribute 

description: NotRequired[str]

A description of the collection.

id instance-attribute 

id: NotRequired[CollectionId]

The unique identifier of the collection.

kms_key_arn instance-attribute 

kms_key_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

last_modified_date instance-attribute 

last_modified_date: NotRequired[int]

The date and time when the collection was last modified.

name instance-attribute 

name: NotRequired[CollectionName]

The name of the collection.

standby_replicas instance-attribute 

standby_replicas: NotRequired[StandbyReplicas]

Creates details about an OpenSearch Serverless collection.

status instance-attribute 

status: NotRequired[CollectionStatus]

The current status of the collection.

type instance-attribute 

type: NotRequired[CollectionType]

The type of collection.

vector_options instance-attribute 

vector_options: NotRequired[VectorOptions]

Configuration options for vector search capabilities in the collection.