Skip to content

Gets information about the access policies that control access to the domain's document and search endpoints

Description

Gets information about the access policies that control access to the domain's document and search endpoints. 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 Access for a Search Domain in the Amazon CloudSearch Developer Guide.

Usage

cloudsearch_describe_service_access_policies(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(
  AccessPolicies = list(
    Options = "string",
    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_service_access_policies(
  DomainName = "string",
  Deployed = TRUE|FALSE
)