Skip to content

define_expression async 

define_expression(
    domain_name: DomainName,
    expression: Expression,
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
) -> DefineExpressionResponse

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Raises:

Source code in docs_src/capo_cloudsearch/_services/async_cloud_search.py 
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
async def define_expression(
    self,
    domain_name: "capo_cloudsearch.types.domain_name.DomainName",
    expression: "capo_cloudsearch.types.expression.Expression",
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
) -> "capo_cloudsearch.types.define_expression_response.DefineExpressionResponse":
    """<p>Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. 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>

    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.invalid_type_exception.InvalidTypeException: <p>The request was rejected because it specified an invalid type definition.</p>
        capo_cloudsearch.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because a resource limit has already been met.</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.validation_exception.ValidationException: <p>The request was rejected because it has invalid parameters.</p>
        capo_cloudsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudsearch.types.define_expression_request.DefineExpressionRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudsearch.types.define_expression_response.DefineExpressionResponse"
    ]:
        import capo_cloudsearch._operations.a9_search_cloud_config_service2013.define_expression

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DefineExpression")
    )
    input_: capo_cloudsearch.types.define_expression_request.DefineExpressionRequest = {
        "domain_name": domain_name,
        "expression": expression,
    }

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