Amazon OpenSearch Service API Opensearch Access Policy API

The Opensearch Access Policy API from Amazon OpenSearch Service API — 5 operation(s) for opensearch access policy.

GitHub OpenAPI

Operations 5

POST /#CreateAccessPolicy Create Access Policy #
POST /#GetAccessPolicy Get Access Policy #
POST /#UpdateAccessPolicy Update Access Policy #
POST /#DeleteAccessPolicy Delete Access Policy #
POST /#ListAccessPolicies List Access Policies #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-opensearch:amazon-opensearch-access-policy-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

amazon-opensearch-access-policy-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Amazon OpenSearch Service Access Policy API
  version: '2021-01-01'
  description: Generated from AWS's published Smithy model for Amazon OpenSearch Service. 5 operation(s).
  contact:
    name: Amazon Web Services
    url: https://aws.amazon.com/contact-us/
  license:
    name: Apache 2.0
    identifier: Apache-2.0
    url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://aoss.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
paths:
  /#CreateAccessPolicy:
    post:
      operationId: CreateAccessPolicy
      summary: Create Access Policy
      description: Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and
        the resources within them, and allow a user to access that data irrespective of the access mechanism or network source.
        For more information, see Data access control for Amazon OpenSearch Serverless.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/CreateAccessPolicyResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '402':
          description: ServiceQuotaExceededException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossServiceQuotaExceededException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.CreateAccessPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/CreateAccessPolicyRequest'
      tags:
      - Access Policy
  /#GetAccessPolicy:
    post:
      operationId: GetAccessPolicy
      summary: Get Access Policy
      description: Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon
        OpenSearch Serverless.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/GetAccessPolicyResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.GetAccessPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/GetAccessPolicyRequest'
      tags:
      - Access Policy
  /#UpdateAccessPolicy:
    post:
      operationId: UpdateAccessPolicy
      summary: Update Access Policy
      description: Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon
        OpenSearch Serverless.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/UpdateAccessPolicyResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.UpdateAccessPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/UpdateAccessPolicyRequest'
      tags:
      - Access Policy
  /#DeleteAccessPolicy:
    post:
      operationId: DeleteAccessPolicy
      summary: Delete Access Policy
      description: Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon
        OpenSearch Serverless.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/DeleteAccessPolicyResponse'
        '409':
          description: ConflictException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossConflictException'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '404':
          description: ResourceNotFoundException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossResourceNotFoundException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.DeleteAccessPolicy
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/DeleteAccessPolicyRequest'
      tags:
      - Access Policy
  /#ListAccessPolicies:
    post:
      operationId: ListAccessPolicies
      summary: List Access Policies
      description: Returns information about a list of OpenSearch Serverless access policies.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/ListAccessPoliciesResponse'
        '500':
          description: InternalServerException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/InternalServerException'
        '400':
          description: ValidationException
          content:
            application/x-amz-json-1.0:
              schema:
                $ref: '#/components/schemas/AossValidationException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - OpenSearchServerless.ListAccessPolicies
      requestBody:
        required: true
        content:
          application/x-amz-json-1.0:
            schema:
              $ref: '#/components/schemas/ListAccessPoliciesRequest'
      tags:
      - Access Policy
components:
  securitySchemes:
    sigv4:
      type: apiKey
      in: header
      name: Authorization
      description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
        request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
      x-aws-sigv4:
        signingName: aoss
  schemas:
    AccessPolicyDetail:
      type: object
      properties:
        type:
          type: string
          description: The type of access policy.
        name:
          type: string
          description: The name of the policy.
        policyVersion:
          type: string
          description: The version of the policy.
        description:
          type: string
          description: The description of the policy.
        policy:
          type: object
          description: The JSON policy document without any whitespaces.
        createdDate:
          type: integer
          description: The date the policy was created.
        lastModifiedDate:
          type: integer
          description: The timestamp of when the policy was last modified.
    AccessPolicySummary:
      type: object
      properties:
        type:
          type: string
          description: The type of access policy. Currently, the only available type is data.
        name:
          type: string
          description: The name of the access policy.
        policyVersion:
          type: string
          description: The version of the policy.
        description:
          type: string
          description: The description of the access policy.
        createdDate:
          type: integer
          description: The Epoch time when the access policy was created.
        lastModifiedDate:
          type: integer
          description: The date and time when the collection was last modified.
    AossConflictException:
      type: object
      properties:
        message:
          type: string
    AossResourceNotFoundException:
      type: object
      properties:
        message:
          type: string
    AossServiceQuotaExceededException:
      type: object
      properties:
        message:
          type: string
          description: Description of the error.
        resourceId:
          type: string
          description: Identifier of the resource affected.
        resourceType:
          type: string
          description: Type of the resource affected.
        serviceCode:
          type: string
          description: Service Quotas requirement to identify originating service.
        quotaCode:
          type: string
          description: Service Quotas requirement to identify originating quota.
      required:
      - message
      - serviceCode
    AossValidationException:
      type: object
      properties:
        message:
          type: string
    CreateAccessPolicyRequest:
      type: object
      properties:
        type:
          type: string
          description: The type of policy.
        name:
          type: string
          description: The name of the policy.
        description:
          type: string
          description: A description of the policy. Typically used to store information about the permissions defined in the
            policy.
        policy:
          type: string
          description: The JSON policy document to use as the content for the policy.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - type
      - name
      - policy
    CreateAccessPolicyResponse:
      type: object
      properties:
        accessPolicyDetail:
          $ref: '#/components/schemas/AccessPolicyDetail'
    DeleteAccessPolicyRequest:
      type: object
      properties:
        type:
          type: string
          description: The type of policy.
        name:
          type: string
          description: The name of the policy to delete.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - type
      - name
    DeleteAccessPolicyResponse:
      type: object
      properties: {}
    GetAccessPolicyRequest:
      type: object
      properties:
        type:
          type: string
          description: Tye type of policy. Currently, the only supported value is data.
        name:
          type: string
          description: The name of the access policy.
      required:
      - type
      - name
    GetAccessPolicyResponse:
      type: object
      properties:
        accessPolicyDetail:
          $ref: '#/components/schemas/AccessPolicyDetail'
    InternalServerException:
      type: object
      properties:
        message:
          type: string
    ListAccessPoliciesRequest:
      type: object
      properties:
        type:
          type: string
          description: The type of access policy.
        resource:
          type: array
          items:
            type: string
          description: Resource filters (can be collections or indexes) that policies can apply to.
        nextToken:
          type: string
          description: If your initial ListAccessPolicies operation returns a nextToken, you can include the returned nextToken
            in subsequent ListAccessPolicies operations, which returns results in the next page.
        maxResults:
          type: integer
          description: An optional parameter that specifies the maximum number of results to return. You can use nextToken
            to get the next page of results. The default is 20.
      required:
      - type
    ListAccessPoliciesResponse:
      type: object
      properties:
        accessPolicySummaries:
          type: array
          items:
            $ref: '#/components/schemas/AccessPolicySummary'
          description: Details about the requested access policies.
        nextToken:
          type: string
          description: When nextToken is returned, there are more results available. The value of nextToken is a unique pagination
            token for each page. Make the call again using the returned token to retrieve the next page.
    UpdateAccessPolicyRequest:
      type: object
      properties:
        type:
          type: string
          description: The type of policy.
        name:
          type: string
          description: The name of the policy.
        policyVersion:
          type: string
          description: The version of the policy being updated.
        description:
          type: string
          description: A description of the policy. Typically used to store information about the permissions defined in the
            policy.
        policy:
          type: string
          description: The JSON policy document to use as the content for the policy.
        clientToken:
          type: string
          description: Unique, case-sensitive identifier to ensure idempotency of the request.
      required:
      - type
      - name
      - policyVersion
    UpdateAccessPolicyResponse:
      type: object
      properties:
        accessPolicyDetail:
          $ref: '#/components/schemas/AccessPolicyDetail'
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/3cd98287b471c106254abd89279cc87308d38bfd/models/opensearchserverless/service/2021-11-01/opensearchserverless-2021-11-01.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)