Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.
Parameters:
-
domain_name
(DomainName)
–
The name of the domain you want to describe.
-
suggester_names
(Optional[StandardNameList], default:
None
)
–
The suggesters you want to describe.
-
deployed
(Optional[Boolean], default:
None
)
–
Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.
Raises:
Source code in docs_src/capo_cloudsearch/_services/async_cloud_search.py
| async def describe_suggesters(
self,
domain_name: "capo_cloudsearch.types.domain_name.DomainName",
*,
config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
suggester_names: Optional[
"capo_cloudsearch.types.standard_name_list.StandardNameList"
] = None,
deployed: Optional["capo_cloudsearch.types.boolean.Boolean"] = None,
) -> (
"capo_cloudsearch.types.describe_suggesters_response.DescribeSuggestersResponse"
):
"""<p>Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html" target="_blank">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
Args:
domain_name: <p>The name of the domain you want to describe.</p>
suggester_names: <p>The suggesters you want to describe.</p>
deployed: <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</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.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because it attempted to reference a resource that does not exist.</p>
capo_cloudsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
async def _handler(
req: "AsyncOperationRequest[capo_cloudsearch.types.describe_suggesters_request.DescribeSuggestersRequest]",
) -> AsyncOperationResponse[
"capo_cloudsearch.types.describe_suggesters_response.DescribeSuggestersResponse"
]:
import capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_suggesters
(
output,
http_response,
) = await capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_suggesters.async_describe_suggesters(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeSuggesters")
)
input_: capo_cloudsearch.types.describe_suggesters_request.DescribeSuggestersRequest = {
"domain_name": domain_name
}
if suggester_names is not None:
input_["suggester_names"] = suggester_names
if deployed is not None:
input_["deployed"] = deployed
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|