AccessPoliciesStatus

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

AnalyticsElasticsearchSearch

Properties

Name Type Description
Options object
Status object
View JSON Schema on GitHub

JSON Schema

openapi-access-policies-status-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-schema/openapi-access-policies-status-schema.json",
  "title": "AccessPoliciesStatus",
  "description": "The configured access rules for the domain's document and search endpoints, and the current status of those rules.",
  "type": "object",
  "properties": {
    "Options": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PolicyDocument"
        },
        {
          "description": "The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See <a href=\"http://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/es-createupdatedomains.html#es-createdomain-configure-access-policies\" target=\"_blank\"> Configuring Access Policies</a>for more information."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OptionStatus"
        },
        {
          "description": "The status of the access policy for the Elasticsearch domain. See <code>OptionStatus</code> for the status information that's included. "
        }
      ]
    }
  },
  "required": [
    "Options",
    "Status"
  ]
}