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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cloudsearch/types.rb

Overview

Note:

When making an API call, you may pass DescribeIndexFieldsRequest data as a 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`.

Constant Summary collapse

SENSITIVE =
[]

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)

1149
1150
1151
1152
1153
1154
1155
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1149

class DescribeIndexFieldsRequest < Struct.new(
  :domain_name,
  :field_names,
  :deployed)
  SENSITIVE = []
  include Aws::Structure
end

#domain_nameString

The name of the domain you want to describe.

Returns:

  • (String)

1149
1150
1151
1152
1153
1154
1155
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1149

class DescribeIndexFieldsRequest < Struct.new(
  :domain_name,
  :field_names,
  :deployed)
  SENSITIVE = []
  include Aws::Structure
end

#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>)

1149
1150
1151
1152
1153
1154
1155
# File 'lib/aws-sdk-cloudsearch/types.rb', line 1149

class DescribeIndexFieldsRequest < Struct.new(
  :domain_name,
  :field_names,
  :deployed)
  SENSITIVE = []
  include Aws::Structure
end