Skip to content

CollectionSummary

Source code in docs_src/capo_opensearchserverless/types/collection_summary.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
class CollectionSummary(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>"""
    arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the collection.</p>"""
    kms_key_arn: NotRequired["str"]
    """<p>The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.</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.

id instance-attribute 

id: NotRequired[CollectionId]

The unique identifier of the collection.

kms_key_arn instance-attribute 

kms_key_arn: NotRequired[str]

The ARN of the Amazon Web Services Key Management Service key used to encrypt the collection.

name instance-attribute 

name: NotRequired[CollectionName]

The name of the collection.

status instance-attribute 

status: NotRequired[CollectionStatus]

The current status of the collection.