Skip to content

DomainStatus

Source code in docs_src/capo_cloudsearch/types/domain_status.py
class DomainStatus(TypedDict, closed=True):
    domain_id: "capo_cloudsearch.types.domain_id.DomainId"
    domain_name: "capo_cloudsearch.types.domain_name.DomainName"
    arn: NotRequired["capo_cloudsearch.types.arn.ARN"]
    created: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>True if the search domain is created. It can take several minutes to initialize a domain when <a>CreateDomain</a> is called. Newly created search domains are returned from <a>DescribeDomains</a> with a false value for Created until domain creation is complete.</p>"""
    deleted: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when <a>DeleteDomain</a> is called. Newly deleted search domains are returned from <a>DescribeDomains</a> with a true value for IsDeleted for several minutes until resource cleanup is complete.</p>"""
    doc_service: NotRequired["capo_cloudsearch.types.service_endpoint.ServiceEndpoint"]
    """<p>The service endpoint for updating documents in a search domain.</p>"""
    search_service: NotRequired[
        "capo_cloudsearch.types.service_endpoint.ServiceEndpoint"
    ]
    """<p>The service endpoint for requesting search results from a search domain.</p>"""
    requires_index_documents: "capo_cloudsearch.types.boolean.Boolean"
    """<p>True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration.</p>"""
    processing: NotRequired["capo_cloudsearch.types.boolean.Boolean"]
    """<p>True if processing is being done to activate the current domain configuration.</p>"""
    search_instance_type: NotRequired[
        "capo_cloudsearch.types.search_instance_type.SearchInstanceType"
    ]
    """<p>The instance type that is being used to process search requests.</p>"""
    search_partition_count: NotRequired[
        "capo_cloudsearch.types.partition_count.PartitionCount"
    ]
    """<p>The number of partitions across which the search index is spread.</p>"""
    search_instance_count: NotRequired[
        "capo_cloudsearch.types.instance_count.InstanceCount"
    ]
    """<p>The number of search instances that are available to process search requests.</p>"""
    limits: NotRequired["capo_cloudsearch.types.limits.Limits"]

arn instance-attribute

arn: NotRequired[ARN]

created instance-attribute

created: NotRequired[Boolean]

True if the search domain is created. It can take several minutes to initialize a domain when CreateDomain is called. Newly created search domains are returned from DescribeDomains with a false value for Created until domain creation is complete.

deleted instance-attribute

deleted: NotRequired[Boolean]

True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when DeleteDomain is called. Newly deleted search domains are returned from DescribeDomains with a true value for IsDeleted for several minutes until resource cleanup is complete.

doc_service instance-attribute

doc_service: NotRequired[ServiceEndpoint]

The service endpoint for updating documents in a search domain.

domain_id instance-attribute

domain_id: DomainId

domain_name instance-attribute

domain_name: DomainName

limits instance-attribute

limits: NotRequired[Limits]

processing instance-attribute

processing: NotRequired[Boolean]

True if processing is being done to activate the current domain configuration.

requires_index_documents instance-attribute

requires_index_documents: Boolean

True if IndexDocuments needs to be called to activate the current domain configuration.

search_instance_count instance-attribute

search_instance_count: NotRequired[InstanceCount]

The number of search instances that are available to process search requests.

search_instance_type instance-attribute

search_instance_type: NotRequired[SearchInstanceType]

The instance type that is being used to process search requests.

search_partition_count instance-attribute

search_partition_count: NotRequired[PartitionCount]

The number of partitions across which the search index is spread.

search_service instance-attribute

search_service: NotRequired[ServiceEndpoint]

The service endpoint for requesting search results from a search domain.