Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions 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 Expressions in the Amazon CloudSearch Developer Guide.
Parameters:
-
domain_name
(DomainName)
–
The name of the domain you want to describe.
-
expression_names
(Optional[StandardNameList], default:
None
)
–
Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.
-
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_expressions(
self,
domain_name: "capo_cloudsearch.types.domain_name.DomainName",
*,
config_overrides: Optional[CloudSearchClientConfig] = None,
expression_names: Optional[
"capo_cloudsearch.types.standard_name_list.StandardNameList"
] = None,
deployed: Optional["capo_cloudsearch.types.boolean.Boolean"] = None,
) -> "capo_cloudsearch.types.describe_expressions_response.DescribeExpressionsResponse":
"""<p>Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions 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-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
Args:
domain_name: <p>The name of the domain you want to describe.</p>
expression_names: <p>Limits the <code><a>DescribeExpressions</a></code> response to the specified expressions. If not specified, all expressions are shown.</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_expressions_request.DescribeExpressionsRequest]",
) -> OperationResponse[
"capo_cloudsearch.types.describe_expressions_response.DescribeExpressionsResponse"
]:
import capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_expressions
output, http_response = (
capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_expressions.describe_expressions(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeExpressions")
)
input_: capo_cloudsearch.types.describe_expressions_request.DescribeExpressionsRequest = {
"domain_name": domain_name
}
if expression_names is not None:
input_["expression_names"] = expression_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
|