Skip to content
AWS for Query.Farm

aws.cloudsearch.describe_expressions

Example SQL Queries

SELECT * FROM
aws.cloudsearch.describe_expressions
WHERE
"domain_name" = 'VALUE';

Description

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.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

The name of the domain you want to describe.

VARCHAR
deployed Input Column

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

BOOLEAN
expression_names Input Column

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

VARCHAR[]
Show child fields
expression_names[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
expressions

The expressions configured for the domain.

STRUCT(
    "options" STRUCT(
        "expression_name" VARCHAR,
        "expression_value" VARCHAR
    ),
    "status" STRUCT(
        "creation_date" TIMESTAMP_S,
        "update_date" TIMESTAMP_S,
        "update_version" BIGINT,
        "state" VARCHAR,
        "pending_deletion" BOOLEAN
    )
)[]
Show child fields
expressions[]
Show child fields
expressions[].options

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

Show child fields
expressions[].options.expression_name

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

expressions[].options.expression_value

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.

expressions[].status

The status of domain configuration option.

Show child fields
expressions[].status.creation_date

A timestamp for when this option was created.

expressions[].status.pending_deletion

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

expressions[].status.state

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.
expressions[].status.update_date

A timestamp for when this option was last updated.

expressions[].status.update_version

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