You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CloudSearch::Types::DescribeIndexFieldsRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeIndexFieldsRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  domain_name: "DomainName", # required
  field_names: ["DynamicFieldName"],
  deployed: false,
}

Container for the parameters to the DescribeIndexFields operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Instance Attribute Summary collapse

Instance Attribute Details

#deployedBoolean

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

Returns:

  • (Boolean)

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

#domain_nameString

The name of the domain you want to describe.

Returns:

  • (String)

    The name of the domain you want to describe.

#field_namesArray<String>

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

Returns:

  • (Array<String>)

    A list of the index fields you want to describe.