Skip to content
AWS for Query.Farm

aws.cloudsearch.describe_index_fields

Example SQL Queries

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

Description

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields 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 Getting Domain Information 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
field_names Input Column

A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.

VARCHAR[]
Show child fields
field_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
index_fields

The index fields configured for the domain.

STRUCT(
    "options" STRUCT(
        "index_field_name" VARCHAR,
        "index_field_type" VARCHAR,
        "int_options" STRUCT(
            "default_value" BIGINT,
            "source_field" VARCHAR,
            "facet_enabled" BOOLEAN,
            "search_enabled" BOOLEAN,
            "return_enabled" BOOLEAN,
            "sort_enabled" BOOLEAN
        ),
        "double_options" STRUCT(
            "default_value" DOUBLE,
            "source_field" VARCHAR,
            "facet_enabled" BOOLEAN,
            "search_enabled" BOOLEAN,
            "return_enabled" BOOLEAN,
            "sort_enabled" BOOLEAN
        ),
        "literal_options" STRUCT(
            "default_value" VARCHAR,
            "source_field" VARCHAR,
            "facet_enabled" BOOLEAN,
            "search_enabled" BOOLEAN,
            "return_enabled" BOOLEAN,
            "sort_enabled" BOOLEAN
        ),
        "text_options" STRUCT(
            "default_value" VARCHAR,
            "source_field" VARCHAR,
            "return_enabled" BOOLEAN,
            "sort_enabled" BOOLEAN,
            "highlight_enabled" BOOLEAN,
            "analysis_scheme" VARCHAR
        ),
        "date_options" STRUCT(
            "default_value" VARCHAR,
            "source_field" VARCHAR,
            "facet_enabled" BOOLEAN,
            "search_enabled" BOOLEAN,
            "return_enabled" BOOLEAN,
            "sort_enabled" BOOLEAN
        ),
        "lat_lon_options" STRUCT(
            "default_value" VARCHAR,
            "source_field" VARCHAR,
            "facet_enabled" BOOLEAN,
            "search_enabled" BOOLEAN,
            "return_enabled" BOOLEAN,
            "sort_enabled" BOOLEAN
        ),
        "int_array_options" STRUCT(
            "default_value" BIGINT,
            "source_fields" VARCHAR,
            "facet_enabled" BOOLEAN,
            "search_enabled" BOOLEAN,
            "return_enabled" BOOLEAN
        ),
        "double_array_options" STRUCT(
            "default_value" DOUBLE,
            "source_fields" VARCHAR,
            "facet_enabled" BOOLEAN,
            "search_enabled" BOOLEAN,
            "return_enabled" BOOLEAN
        ),
        "literal_array_options" STRUCT(
            "default_value" VARCHAR,
            "source_fields" VARCHAR,
            "facet_enabled" BOOLEAN,
            "search_enabled" BOOLEAN,
            "return_enabled" BOOLEAN
        ),
        "text_array_options" STRUCT(
            "default_value" VARCHAR,
            "source_fields" VARCHAR,
            "return_enabled" BOOLEAN,
            "highlight_enabled" BOOLEAN,
            "analysis_scheme" VARCHAR
        ),
        "date_array_options" STRUCT(
            "default_value" VARCHAR,
            "source_fields" VARCHAR,
            "facet_enabled" BOOLEAN,
            "search_enabled" BOOLEAN,
            "return_enabled" BOOLEAN
        )
    ),
    "status" STRUCT(
        "creation_date" TIMESTAMP_S,
        "update_date" TIMESTAMP_S,
        "update_version" BIGINT,
        "state" VARCHAR,
        "pending_deletion" BOOLEAN
    )
)[]
Show child fields
index_fields[]
Show child fields
index_fields[].options

Configuration information for a field in the index, including its name, type, and options. The supported options depend on the IndexFieldType.

Show child fields
index_fields[].options.date_array_options

Options for a field that contains an array of dates. Present if IndexFieldType specifies the field is of type date-array. All options are enabled by default.

Show child fields
index_fields[].options.date_array_options.default_value

A value to use for the field if the field isn't specified for a document.

index_fields[].options.date_array_options.facet_enabled

Whether facet information can be returned for the field.

index_fields[].options.date_array_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.date_array_options.search_enabled

Whether the contents of the field are searchable.

index_fields[].options.date_array_options.source_fields

A list of source fields to map to the field.

index_fields[].options.date_options

Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if IndexFieldType specifies the field is of type date. All options are enabled by default.

Show child fields
index_fields[].options.date_options.default_value

A value to use for the field if the field isn't specified for a document.

index_fields[].options.date_options.facet_enabled

Whether facet information can be returned for the field.

index_fields[].options.date_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.date_options.search_enabled

Whether the contents of the field are searchable.

index_fields[].options.date_options.sort_enabled

Whether the field can be used to sort the search results.

index_fields[].options.date_options.source_field

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

index_fields[].options.double_array_options

Options for a field that contains an array of double-precision 64-bit floating point values. Present if IndexFieldType specifies the field is of type double-array. All options are enabled by default.

Show child fields
index_fields[].options.double_array_options.default_value

A value to use for the field if the field isn't specified for a document.

index_fields[].options.double_array_options.facet_enabled

Whether facet information can be returned for the field.

index_fields[].options.double_array_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.double_array_options.search_enabled

Whether the contents of the field are searchable.

index_fields[].options.double_array_options.source_fields

A list of source fields to map to the field.

index_fields[].options.double_options

Options for a double-precision 64-bit floating point field. Present if IndexFieldType specifies the field is of type double. All options are enabled by default.

Show child fields
index_fields[].options.double_options.default_value

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

index_fields[].options.double_options.facet_enabled

Whether facet information can be returned for the field.

index_fields[].options.double_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.double_options.search_enabled

Whether the contents of the field are searchable.

index_fields[].options.double_options.sort_enabled

Whether the field can be used to sort the search results.

index_fields[].options.double_options.source_field

The name of the source field to map to the field.

index_fields[].options.index_field_name

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

index_fields[].options.index_field_type

The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

index_fields[].options.int_array_options

Options for a field that contains an array of 64-bit signed integers. Present if IndexFieldType specifies the field is of type int-array. All options are enabled by default.

Show child fields
index_fields[].options.int_array_options.default_value

A value to use for the field if the field isn't specified for a document.

index_fields[].options.int_array_options.facet_enabled

Whether facet information can be returned for the field.

index_fields[].options.int_array_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.int_array_options.search_enabled

Whether the contents of the field are searchable.

index_fields[].options.int_array_options.source_fields

A list of source fields to map to the field.

index_fields[].options.int_options

Options for a 64-bit signed integer field. Present if IndexFieldType specifies the field is of type int. All options are enabled by default.

Show child fields
index_fields[].options.int_options.default_value

A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.

index_fields[].options.int_options.facet_enabled

Whether facet information can be returned for the field.

index_fields[].options.int_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.int_options.search_enabled

Whether the contents of the field are searchable.

index_fields[].options.int_options.sort_enabled

Whether the field can be used to sort the search results.

index_fields[].options.int_options.source_field

The name of the source field to map to the field.

index_fields[].options.lat_lon_options

Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if IndexFieldType specifies the field is of type latlon. All options are enabled by default.

Show child fields
index_fields[].options.lat_lon_options.default_value

A value to use for the field if the field isn't specified for a document.

index_fields[].options.lat_lon_options.facet_enabled

Whether facet information can be returned for the field.

index_fields[].options.lat_lon_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.lat_lon_options.search_enabled

Whether the contents of the field are searchable.

index_fields[].options.lat_lon_options.sort_enabled

Whether the field can be used to sort the search results.

index_fields[].options.lat_lon_options.source_field

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

index_fields[].options.literal_array_options

Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array. All options are enabled by default.

Show child fields
index_fields[].options.literal_array_options.default_value

A value to use for the field if the field isn't specified for a document.

index_fields[].options.literal_array_options.facet_enabled

Whether facet information can be returned for the field.

index_fields[].options.literal_array_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.literal_array_options.search_enabled

Whether the contents of the field are searchable.

index_fields[].options.literal_array_options.source_fields

A list of source fields to map to the field.

index_fields[].options.literal_options

Options for literal field. Present if IndexFieldType specifies the field is of type literal. All options are enabled by default.

Show child fields
index_fields[].options.literal_options.default_value

A value to use for the field if the field isn't specified for a document.

index_fields[].options.literal_options.facet_enabled

Whether facet information can be returned for the field.

index_fields[].options.literal_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.literal_options.search_enabled

Whether the contents of the field are searchable.

index_fields[].options.literal_options.sort_enabled

Whether the field can be used to sort the search results.

index_fields[].options.literal_options.source_field

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

index_fields[].options.text_array_options

Options for a field that contains an array of text strings. Present if IndexFieldType specifies the field is of type text-array. A text-array field is always searchable. All options are enabled by default.

Show child fields
index_fields[].options.text_array_options.analysis_scheme

The name of an analysis scheme for a text-array field.

index_fields[].options.text_array_options.default_value

A value to use for the field if the field isn't specified for a document.

index_fields[].options.text_array_options.highlight_enabled

Whether highlights can be returned for the field.

index_fields[].options.text_array_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.text_array_options.source_fields

A list of source fields to map to the field.

index_fields[].options.text_options

Options for text field. Present if IndexFieldType specifies the field is of type text. A text field is always searchable. All options are enabled by default.

Show child fields
index_fields[].options.text_options.analysis_scheme

The name of an analysis scheme for a text field.

index_fields[].options.text_options.default_value

A value to use for the field if the field isn't specified for a document.

index_fields[].options.text_options.highlight_enabled

Whether highlights can be returned for the field.

index_fields[].options.text_options.return_enabled

Whether the contents of the field can be returned in the search results.

index_fields[].options.text_options.sort_enabled

Whether the field can be used to sort the search results.

index_fields[].options.text_options.source_field

A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.

Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.

The name score is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

index_fields[].status

The status of domain configuration option.

Show child fields
index_fields[].status.creation_date

A timestamp for when this option was created.

index_fields[].status.pending_deletion

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

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

A timestamp for when this option was last updated.

index_fields[].status.update_version

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