CollectionDetail ¶

class CollectionDetail(TypedDict, closed=True):
    id: NotRequired["capo_opensearchserverless.types.collection_id.CollectionId"]
    """<p>A unique identifier for 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 ARN of the Amazon Web Services KMS key used to encrypt the collection.</p>"""
    standby_replicas: NotRequired[
        "capo_opensearchserverless.types.standby_replicas.StandbyReplicas"
    ]
    """<p>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_endpoint: NotRequired["str"]
    """<p>Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.</p>"""
    dashboard_endpoint: NotRequired["str"]
    """<p>Collection-specific endpoint used to access OpenSearch Dashboards.</p>"""
    fips_endpoints: NotRequired[
        "capo_opensearchserverless.types.fips_endpoints.FipsEndpoints"
    ]
    """<p>FIPS-compliant endpoints for the collection. These endpoints use FIPS 140-3 validated cryptographic modules and are required for federal government workloads that must comply with FedRAMP security standards.</p>"""
    failure_code: NotRequired["str"]
    """<p>A failure code associated with the request.</p>"""
    failure_message: NotRequired["str"]
    """<p>A message associated with the failure code.</p>"""
    collection_group_name: NotRequired[
        "capo_opensearchserverless.types.collection_group_name.CollectionGroupName"
    ]
    """<p>The name of the collection group that contains this collection.</p>"""