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

Class: Aws::CloudSearch::Types::DeleteIndexFieldRequest

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

Overview

Note:

When making an API call, you may pass DeleteIndexFieldRequest data as a hash:

{
  domain_name: "DomainName", # required
  index_field_name: "DynamicFieldName", # required
}

Container for the parameters to the DeleteIndexField operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Returns:

  • (String)


792
793
794
795
796
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 792

class DeleteIndexFieldRequest < Struct.new(
  :domain_name,
  :index_field_name)
  include Aws::Structure
end

#index_field_nameString

The name of the index field your want to remove from the domain's indexing options.

Returns:

  • (String)


792
793
794
795
796
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 792

class DeleteIndexFieldRequest < Struct.new(
  :domain_name,
  :index_field_name)
  include Aws::Structure
end