CloudSearch / Client / describe_expressions

describe_expressions#

CloudSearch.Client.describe_expressions(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_expressions(
    DomainName='string',
    ExpressionNames=[
        'string',
    ],
    Deployed=True|False
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of the domain you want to describe.

  • ExpressionNames (list) –

    Limits the DescribeExpressions response to the specified expressions. If not specified, all expressions are shown.

    • (string) –

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

  • Deployed (boolean) – Whether to display the deployed configuration ( true) or include any pending changes ( false). Defaults to false.

Return type:

dict

Returns:

Response Syntax

{
    'Expressions': [
        {
            '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 DescribeExpressions request. Contains the expressions configured for the domain specified in the request.

    • Expressions (list) –

      The expressions configured for the domain.

      • (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