CloudSearch / Client / define_expression

define_expression#

CloudSearch.Client.define_expression(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.define_expression(
    DomainName='string',
    Expression={
        'ExpressionName': 'string',
        'ExpressionValue': 'string'
    }
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • Expression (dict) –

    [REQUIRED]

    A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

    • ExpressionName (string) – [REQUIRED]

      Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

    • ExpressionValue (string) – [REQUIRED]

      The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Return type:

dict

Returns:

Response Syntax

{
    'Expression': {
        'Options': {
            'ExpressionName': 'string',
            'ExpressionValue': 'string'
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

  • (dict) –

    The result of a DefineExpression request. Contains the status of the newly-configured expression.

    • Expression (dict) –

      The value of an Expression and its current status.

      • Options (dict) –

        The expression that is evaluated for sorting while processing a search request.

        • ExpressionName (string) –

          Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).

        • ExpressionValue (string) –

          The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

      • Status (dict) –

        The status of domain configuration option.

        • CreationDate (datetime) –

          A timestamp for when this option was created.

        • UpdateDate (datetime) –

          A timestamp for when this option was last updated.

        • UpdateVersion (integer) –

          A unique integer that indicates when this option was last updated.

        • State (string) –

          The state of processing a change to an option. Possible values:

          • RequiresIndexDocuments: the option’s latest value will not be deployed until IndexDocuments has been called and indexing is complete.

          • Processing: the option’s latest value is in the process of being activated.

          • Active: the option’s latest value is completely deployed.

          • FailedToValidate: the option value is not compatible with the domain’s data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.

        • PendingDeletion (boolean) –

          Indicates that the option will be deleted once processing is complete.

Exceptions