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
- Struct
- Aws::CloudSearch::Types::DescribeIndexFieldsRequest
- Defined in:
- (unknown)
Overview
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
-
#deployed ⇒ Boolean
Whether to display the deployed configuration (
true
) or include any pending changes (false
). -
#domain_name ⇒ String
The name of the domain you want to describe.
-
#field_names ⇒ Array<String>
A list of the index fields you want to describe.
Instance Attribute Details
#deployed ⇒ Boolean
Whether to display the deployed configuration (true
) or include any
pending changes (false
). Defaults to false
.
#domain_name ⇒ String
The name of the domain you want to describe.
#field_names ⇒ Array<String>
A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.