Describe Availability Options

cloudsearch_describe_availability_options

R Documentation

Gets the availability options configured for a domain¶

Description¶

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

Usage¶

cloudsearch_describe_availability_options(DomainName, Deployed)

Arguments¶

DomainName

[required] The name of the domain you want to describe.

Deployed

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Value¶

A list with the following syntax:

list(
  AvailabilityOptions = list(
    Options = TRUE|FALSE,
    Status = list(
      CreationDate = as.POSIXct(
        "2015-01-01"
      ),
      UpdateDate = as.POSIXct(
        "2015-01-01"
      ),
      UpdateVersion = 123,
      State = "RequiresIndexDocuments"|"Processing"|"Active"|"FailedToValidate",
      PendingDeletion = TRUE|FALSE
    )
  )
)

Request syntax¶

svc$describe_availability_options(
  DomainName = "string",
  Deployed = TRUE|FALSE
)