Amazon OpenSearch Service API · JSON Structure

Openapi Access Policies Status Structure

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

Type: object Properties: 2 Required: 2
AnalyticsElasticsearchSearch

AccessPoliciesStatus is a JSON Structure definition published by Amazon OpenSearch Service API, describing 2 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Options Status

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-structure/openapi-access-policies-status-structure.json",
  "name": "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"
  ]
}