CloudSearch / Client / describe_domains

describe_domains#

CloudSearch.Client.describe_domains(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_domains(
    DomainNames=[
        'string',
    ]
)
Parameters:

DomainNames (list) –

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

  • (string) –

    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).

Return type:

dict

Returns:

Response Syntax

{
    'DomainStatusList': [
        {
            'DomainId': 'string',
            'DomainName': 'string',
            'ARN': 'string',
            'Created': True|False,
            'Deleted': True|False,
            'DocService': {
                'Endpoint': 'string'
            },
            'SearchService': {
                'Endpoint': 'string'
            },
            'RequiresIndexDocuments': True|False,
            'Processing': True|False,
            'SearchInstanceType': 'string',
            'SearchPartitionCount': 123,
            'SearchInstanceCount': 123,
            'Limits': {
                'MaximumReplicationCount': 123,
                'MaximumPartitionCount': 123
            }
        },
    ]
}

Response Structure

  • (dict) –

    The result of a DescribeDomains request. Contains the status of the domains specified in the request or all domains owned by the account.

    • DomainStatusList (list) –

      A list that contains the status of each requested domain.

      • (dict) –

        The current status of the search domain.

        • DomainId (string) –

          An internally generated unique identifier for a domain.

        • DomainName (string) –

          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).

        • ARN (string) –

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

        • Created (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 (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.

        • DocService (dict) –

          The service endpoint for updating documents in a search domain.

          • Endpoint (string) –

            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.

        • SearchService (dict) –

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

          • Endpoint (string) –

            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.

        • RequiresIndexDocuments (boolean) –

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

        • Processing (boolean) –

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

        • SearchInstanceType (string) –

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

        • SearchPartitionCount (integer) –

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

        • SearchInstanceCount (integer) –

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

        • Limits (dict) –

          • MaximumReplicationCount (integer) –

          • MaximumPartitionCount (integer) –

Exceptions