Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DescribeDomainsCommand

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

example

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

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

DescribeDomainsCommandInput for command's input shape.

see

DescribeDomainsCommandOutput for command's response shape.

see

config for CloudSearchClient's config shape.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly input

input: DescribeDomainsCommandInput

Readonly middlewareStack

middlewareStack: IMiddlewareStack<DescribeDomainsCommandInput, DescribeDomainsCommandOutput>

Methods

Static getEndpointParameterInstructions