Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a text field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes 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 Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide.
Parameters:
-
domain_name
(DomainName)
–
The name of the domain you want to describe.
-
analysis_scheme_names
(Optional[StandardNameList], default:
None
)
–
The analysis schemes 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/cloud_search.py
| def describe_analysis_schemes(
self,
domain_name: "capo_cloudsearch.types.domain_name.DomainName",
*,
config_overrides: Optional[CloudSearchClientConfig] = None,
analysis_scheme_names: Optional[
"capo_cloudsearch.types.standard_name_list.StandardNameList"
] = None,
deployed: Optional["capo_cloudsearch.types.boolean.Boolean"] = None,
) -> "capo_cloudsearch.types.describe_analysis_schemes_response.DescribeAnalysisSchemesResponse":
"""<p>Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes 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/configuring-analysis-schemes.html" target="_blank">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
Args:
domain_name: <p>The name of the domain you want to describe.</p>
analysis_scheme_names: <p>The analysis schemes 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.
"""
def _handler(
req: "OperationRequest[capo_cloudsearch.types.describe_analysis_schemes_request.DescribeAnalysisSchemesRequest]",
) -> OperationResponse[
"capo_cloudsearch.types.describe_analysis_schemes_response.DescribeAnalysisSchemesResponse"
]:
import capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_analysis_schemes
output, http_response = (
capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_analysis_schemes.describe_analysis_schemes(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeAnalysisSchemes")
)
input_: capo_cloudsearch.types.describe_analysis_schemes_request.DescribeAnalysisSchemesRequest = {
"domain_name": domain_name
}
if analysis_scheme_names is not None:
input_["analysis_scheme_names"] = analysis_scheme_names
if deployed is not None:
input_["deployed"] = deployed
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|