CloudSearch / Client / delete_domain

delete_domain

CloudSearch.Client.delete_domain(**kwargs)

Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.delete_domain(
    DomainName='string'
)

Parameters:

DomainName (string) –

[REQUIRED]

The name of the domain you want to permanently delete.

Return type:

dict

Returns:

Response Syntax

{
    'DomainStatus': {
        '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 DeleteDomain request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.

  • DomainStatus (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

• CloudSearch.Client.exceptions.BaseException

• CloudSearch.Client.exceptions.InternalException