Describe Domains

cloudsearch_describe_domains

R Documentation

Gets information about the search domains owned by this account

Description

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.

Usage

cloudsearch_describe_domains(DomainNames)

Arguments

DomainNames

The names of the domains you want to include in the response.

Value

A list with the following syntax:

list(
  DomainStatusList = list(
    list(
      DomainId = "string",
      DomainName = "string",
      ARN = "string",
      Created = TRUE|FALSE,
      Deleted = TRUE|FALSE,
      DocService = list(
        Endpoint = "string"
      ),
      SearchService = list(
        Endpoint = "string"
      ),
      RequiresIndexDocuments = TRUE|FALSE,
      Processing = TRUE|FALSE,
      SearchInstanceType = "string",
      SearchPartitionCount = 123,
      SearchInstanceCount = 123,
      Limits = list(
        MaximumReplicationCount = 123,
        MaximumPartitionCount = 123
      )
    )
  )
)

Request syntax

svc$describe_domains(
  DomainNames = list(
    "string"
  )
)