Skip to content

delete_domain async

delete_domain(
    domain_name: DomainName,
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
) -> DeleteDomainResponse

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.

Parameters:

  • domain_name (DomainName) –

    The name of the domain you want to permanently delete.

Raises:

Source code in docs_src/capo_cloudsearch/_services/async_cloud_search.py
async def delete_domain(
    self,
    domain_name: "capo_cloudsearch.types.domain_name.DomainName",
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
) -> "capo_cloudsearch.types.delete_domain_response.DeleteDomainResponse":
    """<p>Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html" target="_blank">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>

    Args:
        domain_name: <p>The name of the domain you want to permanently delete.</p>

    Raises:
        capo_cloudsearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_cloudsearch.errors.internal_exception.InternalException: <p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>.</p>
        capo_cloudsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudsearch.types.delete_domain_request.DeleteDomainRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudsearch.types.delete_domain_response.DeleteDomainResponse"
    ]:
        import capo_cloudsearch._operations.a9_search_cloud_config_service2013.delete_domain

        (
            output,
            http_response,
        ) = await capo_cloudsearch._operations.a9_search_cloud_config_service2013.delete_domain.async_delete_domain(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteDomain")
    )
    input_: capo_cloudsearch.types.delete_domain_request.DeleteDomainRequest = {
        "domain_name": domain_name
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output