Describe Index Fields

cloudsearch_describe_index_fields

R Documentation

Gets information about the index fields configured for the search domain

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.

Usage

cloudsearch_describe_index_fields(DomainName, FieldNames, Deployed)

Arguments

DomainName

[required] The name of the domain you want to describe.

FieldNames

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

Deployed

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

Value

A list with the following syntax:

list(
  IndexFields = list(
    list(
      Options = list(
        IndexFieldName = "string",
        IndexFieldType = "int"|"double"|"literal"|"text"|"date"|"latlon"|"int-array"|"double-array"|"literal-array"|"text-array"|"date-array",
        IntOptions = list(
          DefaultValue = 123,
          SourceField = "string",
          FacetEnabled = TRUE|FALSE,
          SearchEnabled = TRUE|FALSE,
          ReturnEnabled = TRUE|FALSE,
          SortEnabled = TRUE|FALSE
        ),
        DoubleOptions = list(
          DefaultValue = 123.0,
          SourceField = "string",
          FacetEnabled = TRUE|FALSE,
          SearchEnabled = TRUE|FALSE,
          ReturnEnabled = TRUE|FALSE,
          SortEnabled = TRUE|FALSE
        ),
        LiteralOptions = list(
          DefaultValue = "string",
          SourceField = "string",
          FacetEnabled = TRUE|FALSE,
          SearchEnabled = TRUE|FALSE,
          ReturnEnabled = TRUE|FALSE,
          SortEnabled = TRUE|FALSE
        ),
        TextOptions = list(
          DefaultValue = "string",
          SourceField = "string",
          ReturnEnabled = TRUE|FALSE,
          SortEnabled = TRUE|FALSE,
          HighlightEnabled = TRUE|FALSE,
          AnalysisScheme = "string"
        ),
        DateOptions = list(
          DefaultValue = "string",
          SourceField = "string",
          FacetEnabled = TRUE|FALSE,
          SearchEnabled = TRUE|FALSE,
          ReturnEnabled = TRUE|FALSE,
          SortEnabled = TRUE|FALSE
        ),
        LatLonOptions = list(
          DefaultValue = "string",
          SourceField = "string",
          FacetEnabled = TRUE|FALSE,
          SearchEnabled = TRUE|FALSE,
          ReturnEnabled = TRUE|FALSE,
          SortEnabled = TRUE|FALSE
        ),
        IntArrayOptions = list(
          DefaultValue = 123,
          SourceFields = "string",
          FacetEnabled = TRUE|FALSE,
          SearchEnabled = TRUE|FALSE,
          ReturnEnabled = TRUE|FALSE
        ),
        DoubleArrayOptions = list(
          DefaultValue = 123.0,
          SourceFields = "string",
          FacetEnabled = TRUE|FALSE,
          SearchEnabled = TRUE|FALSE,
          ReturnEnabled = TRUE|FALSE
        ),
        LiteralArrayOptions = list(
          DefaultValue = "string",
          SourceFields = "string",
          FacetEnabled = TRUE|FALSE,
          SearchEnabled = TRUE|FALSE,
          ReturnEnabled = TRUE|FALSE
        ),
        TextArrayOptions = list(
          DefaultValue = "string",
          SourceFields = "string",
          ReturnEnabled = TRUE|FALSE,
          HighlightEnabled = TRUE|FALSE,
          AnalysisScheme = "string"
        ),
        DateArrayOptions = list(
          DefaultValue = "string",
          SourceFields = "string",
          FacetEnabled = TRUE|FALSE,
          SearchEnabled = TRUE|FALSE,
          ReturnEnabled = TRUE|FALSE
        )
      ),
      Status = list(
        CreationDate = as.POSIXct(
          "2015-01-01"
        ),
        UpdateDate = as.POSIXct(
          "2015-01-01"
        ),
        UpdateVersion = 123,
        State = "RequiresIndexDocuments"|"Processing"|"Active"|"FailedToValidate",
        PendingDeletion = TRUE|FALSE
      )
    )
  )
)

Request syntax

svc$describe_index_fields(
  DomainName = "string",
  FieldNames = list(
    "string"
  ),
  Deployed = TRUE|FALSE
)