Amazon Directory Service Directory Service Directory Data Access API

The Directory Service Directory Data Access API from Amazon Directory Service — 3 operation(s) for directory service directory data access.

Operations 3

POST /#DescribeDirectoryDataAccess Describe Directory Data Access #
POST /#DisableDirectoryDataAccess Disable Directory Data Access #
POST /#EnableDirectoryDataAccess Enable Directory Data Access #

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-directory-service:amazon-directory-service-directory-data-access-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-directory-service-directory-data-access-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: AWS Directory Service Directory Data Access API
  version: '2015-04-16'
  description: Generated from AWS's published Smithy model for AWS Directory Service. 3 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://ds.{region}.amazonaws.com
  variables:
    region:
      default: us-east-1
security:
- sigv4: []
tags:
- name: Directory Data Access
paths:
  /#DescribeDirectoryDataAccess:
    post:
      operationId: DescribeDirectoryDataAccess
      summary: Describe Directory Data Access
      description: Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeDirectoryDataAccessResult'
        '400':
          description: AccessDeniedException; ClientException; DirectoryDoesNotExistException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.DescribeDirectoryDataAccess
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeDirectoryDataAccessRequest'
      tags:
      - Directory Data Access
  /#DisableDirectoryDataAccess:
    post:
      operationId: DisableDirectoryDataAccess
      summary: Disable Directory Data Access
      description: Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DisableDirectoryDataAccessResult'
        '400':
          description: AccessDeniedException; ClientException; DirectoryDoesNotExistException; DirectoryInDesiredStateException; DirectoryUnavailableException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.DisableDirectoryDataAccess
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DisableDirectoryDataAccessRequest'
      tags:
      - Directory Data Access
  /#EnableDirectoryDataAccess:
    post:
      operationId: EnableDirectoryDataAccess
      summary: Enable Directory Data Access
      description: Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/EnableDirectoryDataAccessResult'
        '400':
          description: AccessDeniedException; ClientException; DirectoryDoesNotExistException; DirectoryInDesiredStateException; DirectoryUnavailableException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/AccessDeniedException'
        '500':
          description: ServiceException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ServiceException'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.EnableDirectoryDataAccess
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/EnableDirectoryDataAccessRequest'
      tags:
      - Directory Data Access
components:
  schemas:
    DisableDirectoryDataAccessRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The directory identifier.
      required:
      - DirectoryId
    DescribeDirectoryDataAccessResult:
      type: object
      properties:
        DataAccessStatus:
          type: string
          enum:
          - Disabled
          - Disabling
          - Enabled
          - Enabling
          - Failed
          description: The current status of data access through the Directory Service Data API.
    DescribeDirectoryDataAccessRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The directory identifier.
      required:
      - DirectoryId
    DisableDirectoryDataAccessResult:
      type: object
      properties: {}
    EnableDirectoryDataAccessRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The directory identifier.
      required:
      - DirectoryId
    AccessDeniedException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    EnableDirectoryDataAccessResult:
      type: object
      properties: {}
    ServiceException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
  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: ds
x-provenance:
  method: harvested
  publisher: Amazon Web Services
  source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/directory-service/service/2015-04-16/directory-service-2015-04-16.json
  note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)