Describe Domain Endpoint Options

cloudsearch_describe_domain_endpoint_options

R Documentation

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS¶

Description¶

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Usage¶

cloudsearch_describe_domain_endpoint_options(DomainName, Deployed)

Arguments¶

DomainName: [required] A string that represents the name of a domain.
Deployed: Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to false.

Value¶

A list with the following syntax:

list(
  DomainEndpointOptions = list(
    Options = list(
      EnforceHTTPS = TRUE|FALSE,
      TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"|"Policy-Min-TLS-1-2-2019-07"
    ),
    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_domain_endpoint_options(
  DomainName = "string",
  Deployed = TRUE|FALSE
)