Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DefineIndexFieldCommand

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the IndexFieldType. If the field exists, the new configuration replaces the old one. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.

example

Use a bare-bones client and the command you need to make an API call.

import { CloudSearchClient, DefineIndexFieldCommand } from "@aws-sdk/client-cloudsearch"; // ES Modules import
// const { CloudSearchClient, DefineIndexFieldCommand } = require("@aws-sdk/client-cloudsearch"); // CommonJS import
const client = new CloudSearchClient(config);
const command = new DefineIndexFieldCommand(input);
const response = await client.send(command);
see

DefineIndexFieldCommandInput for command's input shape.

see

DefineIndexFieldCommandOutput for command's response shape.

see

config for CloudSearchClient's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: DefineIndexFieldCommandInput

Readonly middlewareStack