Skip to content
AWS for Query.Farm

aws.cloudsearch.describe_domains

Example SQL Queries

SELECT * FROM
aws.cloudsearch.describe_domains;

Description

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

Table Definition

Column NameColumn Data Type
domain_names Input Column

The names of the domains you want to include in the response.

VARCHAR[]
Show child fields
domain_names[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
domain_status_list

A list that contains the status of each requested domain.

STRUCT(
    "domain_id" VARCHAR,
    "domain_name" VARCHAR,
    "arn" VARCHAR,
    "created" BOOLEAN,
    "deleted" BOOLEAN,
    "doc_service" STRUCT(
        "endpoint" VARCHAR
    ),
    "search_service" STRUCT(
        "endpoint" VARCHAR
    ),
    "requires_index_documents" BOOLEAN,
    "processing" BOOLEAN,
    "search_instance_type" VARCHAR,
    "search_partition_count" BIGINT,
    "search_instance_count" BIGINT,
    "limits" STRUCT(
        "maximum_replication_count" BIGINT,
        "maximum_partition_count" BIGINT
    )
)[]
Show child fields
domain_status_list[]
Show child fields
domain_status_list[].arn

The Amazon Resource Name (ARN) of the search domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

domain_status_list[].created

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.

domain_status_list[].deleted

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.

domain_status_list[].doc_service

The service endpoint for updating documents in a search domain.

Show child fields
domain_status_list[].doc_service.endpoint

The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.

domain_status_list[].domain_id

An internally generated unique identifier for a domain.

domain_status_list[].domain_name

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

domain_status_list[].limits
Show child fields
domain_status_list[].limits.maximum_partition_count
domain_status_list[].limits.maximum_replication_count
domain_status_list[].processing

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

domain_status_list[].requires_index_documents

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

domain_status_list[].search_instance_count

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

domain_status_list[].search_instance_type

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

domain_status_list[].search_partition_count

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

domain_status_list[].search_service

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

Show child fields
domain_status_list[].search_service.endpoint

The endpoint to which service requests can be submitted. For example, search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com or doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com.