Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DescribeIndexFieldsCommand

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Domain Information in the Amazon CloudSearch Developer Guide.

example

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

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

DescribeIndexFieldsCommandInput for command's input shape.

see

DescribeIndexFieldsCommandOutput for command's response shape.

see

config for CloudSearchClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: DescribeIndexFieldsCommandInput

Readonly middlewareStack

Methods

Static getEndpointParameterInstructions