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.
Parameters:
-
domain_names
(Optional[DomainNameList], default:
None
)
–
The names of the domains you want to include in the response.
Raises:
Source code in docs_src/capo_cloudsearch/_services/cloud_search.py
| def describe_domains(
self,
*,
config_overrides: Optional[CloudSearchClientConfig] = None,
domain_names: Optional[
"capo_cloudsearch.types.domain_name_list.DomainNameList"
] = None,
) -> "capo_cloudsearch.types.describe_domains_response.DescribeDomainsResponse":
"""<p>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 <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&q.parser=structured&size=0</code>. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html" target="_blank">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
Args:
domain_names: <p>The names of the domains you want to include in the response.</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.
"""
def _handler(
req: "OperationRequest[capo_cloudsearch.types.describe_domains_request.DescribeDomainsRequest]",
) -> OperationResponse[
"capo_cloudsearch.types.describe_domains_response.DescribeDomainsResponse"
]:
import capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_domains
output, http_response = (
capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_domains.describe_domains(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDomains")
)
input_: capo_cloudsearch.types.describe_domains_request.DescribeDomainsRequest = {}
if domain_names is not None:
input_["domain_names"] = domain_names
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|