Amazon Directory Service

Amazon Directory Service Directory Service Operations API

The Directory Service Operations API from Amazon Directory Service — 3 operation(s) for directory service operations.

GitHub OpenAPI

Operations 3

POST /#CreateHybridAD Create Hybrid AD #
POST /#UpdateHybridAD Update Hybrid AD #
POST /#DescribeHybridADUpdate Describe Hybrid ADUpdate #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/amazon-directory-service/openapi/amazon-directory-service-operations-api-openapi.yml

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-operations-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.

GitHub Google LinkedIn

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

OpenAPI Specification

amazon-directory-service-operations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: AWS Directory Service Operations API
  version: '2015-04-16'
  description: Generated from AWS's published Smithy model for AWS Directory Service. 7 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: Operations
paths:
  /#CreateHybridAD:
    post:
      operationId: CreateHybridAD
      summary: Create Hybrid AD
      description: Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services. You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you use this operation. Updates are applied asynchronously. Use DescribeDirectories to monitor the progress of directory creation.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/CreateHybridADResult'
        '400':
          description: ADAssessmentLimitExceededException; ClientException; DirectoryLimitExceededException; EntityDoesNotExistException; InvalidParameterException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ADAssessmentLimitExceededException'
        '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.CreateHybridAD
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/CreateHybridADRequest'
      tags:
      - Operations
  /#UpdateHybridAD:
    post:
      operationId: UpdateHybridAD
      summary: Update Hybrid AD
      description: Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings. Updates are applied asynchronously. Use DescribeHybridADUpdate to monitor the progress of configuration changes. The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410]. You must provide at least one update to UpdateHybridADRequest$HybridAdministratorAccountUpdate or UpdateHybridADRequest$SelfManagedInstancesSettings.
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/UpdateHybridADResult'
        '400':
          description: ADAssessmentLimitExceededException; ClientException; DirectoryDoesNotExistException; InvalidParameterException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ADAssessmentLimitExceededException'
        '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.UpdateHybridAD
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/UpdateHybridADRequest'
      tags:
      - Operations
  /#DescribeHybridADUpdate:
    post:
      operationId: DescribeHybridADUpdate
      summary: Describe Hybrid ADUpdate
      description: Retrieves information about update activities for a hybrid directory. This operation provides details about configuration changes, administrator account updates, and self-managed instance settings (IDs and DNS IPs).
      responses:
        '200':
          description: Success
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/DescribeHybridADUpdateResult'
        '400':
          description: ClientException; DirectoryDoesNotExistException; InvalidNextTokenException; InvalidParameterException; UnsupportedOperationException
          content:
            application/x-amz-json-1.1:
              schema:
                $ref: '#/components/schemas/ClientException'
        '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.DescribeHybridADUpdate
      requestBody:
        required: true
        content:
          application/x-amz-json-1.1:
            schema:
              $ref: '#/components/schemas/DescribeHybridADUpdateRequest'
      tags:
      - Operations
components:
  schemas:
    HybridUpdateActivities:
      type: object
      properties:
        SelfManagedInstances:
          type: array
          items:
            $ref: '#/components/schemas/HybridUpdateInfoEntry'
          description: A list of update activities related to the self-managed instances with SSM in the self-managed instances with SSM hybrid directory configuration.
        HybridAdministratorAccount:
          type: array
          items:
            $ref: '#/components/schemas/HybridUpdateInfoEntry'
          description: A list of update activities related to hybrid directory administrator account changes.
    UpdateHybridADResult:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier of the updated hybrid directory.
        AssessmentId:
          type: string
          description: The identifier of the assessment performed to validate the update configuration. This assessment ensures the updated settings are compatible with your environment.
    UpdateHybridADRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier of the hybrid directory to update.
        HybridAdministratorAccountUpdate:
          $ref: '#/components/schemas/HybridAdministratorAccountUpdate'
        SelfManagedInstancesSettings:
          $ref: '#/components/schemas/HybridCustomerInstancesSettings'
      required:
      - DirectoryId
    HybridCustomerInstancesSettings:
      type: object
      properties:
        CustomerDnsIps:
          type: array
          items:
            type: string
          description: The IP addresses of the DNS servers or domain controllers in your self-managed AD environment.
        InstanceIds:
          type: array
          items:
            type: string
          description: The identifiers of the self-managed instances with SSM used in hybrid directory.
      required:
      - CustomerDnsIps
      - InstanceIds
    HybridUpdateInfoEntry:
      type: object
      properties:
        Status:
          type: string
          enum:
          - Updated
          - Updating
          - UpdateFailed
          description: The current status of the update activity. Valid values include UPDATED, UPDATING, and UPDATE_FAILED.
        StatusReason:
          type: string
          description: A human-readable description of the update status, including any error details or progress information.
        InitiatedBy:
          type: string
          description: Specifies if the update was initiated by the customer or Amazon Web Services.
        NewValue:
          $ref: '#/components/schemas/HybridUpdateValue'
        PreviousValue:
          $ref: '#/components/schemas/HybridUpdateValue'
        StartTime:
          type: string
          format: date-time
          description: The date and time when the update activity was initiated.
        LastUpdatedDateTime:
          type: string
          format: date-time
          description: The date and time when the update activity status was last updated.
        AssessmentId:
          type: string
          description: The identifier of the assessment performed to validate this update configuration.
    DescribeHybridADUpdateResult:
      type: object
      properties:
        UpdateActivities:
          $ref: '#/components/schemas/HybridUpdateActivities'
        NextToken:
          type: string
          description: If not null, more results are available. Pass this value for the NextToken parameter in a subsequent request to retrieve the next set of items.
    HybridAdministratorAccountUpdate:
      type: object
      properties:
        SecretArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials for the AD administrator user, and enables hybrid domain controllers to join the managed AD domain. For example: {"customerAdAdminDomainUsername":"carlos_salazar","customerAdAdminDomainPassword":"ExamplePassword123!"}.'
      required:
      - SecretArn
    Tag:
      type: object
      properties:
        Key:
          type: string
          description: 'Required name of the tag. The string value can be Unicode characters and cannot be prefixed with "aws:". The string can contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'', '':'', ''@''(Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
        Value:
          type: string
          description: 'The optional value of the tag. The string value can be Unicode characters. The string can contain only the set of Unicode letters, digits, white-space, ''_'', ''.'', ''/'', ''='', ''+'', ''-'', '':'', ''@'' (Java regex: "^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-]*)$").'
      required:
      - Key
      - Value
    HybridUpdateValue:
      type: object
      properties:
        InstanceIds:
          type: array
          items:
            type: string
          description: The identifiers of the self-managed instances with SSM in the hybrid directory configuration.
        DnsIps:
          type: array
          items:
            type: string
          description: The IP addresses of the DNS servers or domain controllers in the hybrid directory configuration.
    CreateHybridADResult:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The unique identifier of the newly created hybrid directory.
    CreateHybridADRequest:
      type: object
      properties:
        SecretArn:
          type: string
          description: 'The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials for the service account used to join hybrid domain controllers to your self-managed AD domain. This secret is used once and not stored. The secret must contain key-value pairs with keys matching customerAdAdminDomainUsername and customerAdAdminDomainPassword. For example: {"customerAdAdminDomainUsername":"carlos_salazar","customerAdAdminDomainPassword":"ExamplePassword123!"}.'
        AssessmentId:
          type: string
          description: The unique identifier of the successful directory assessment that validates your self-managed AD environment. You must have a successful directory assessment before you create a hybrid directory.
        Tags:
          type: array
          items:
            $ref: '#/components/schemas/Tag'
          description: The tags to be assigned to the directory. Each tag consists of a key and value pair. You can specify multiple tags as a list.
      required:
      - SecretArn
      - AssessmentId
    ServiceException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    DescribeHybridADUpdateRequest:
      type: object
      properties:
        DirectoryId:
          type: string
          description: The identifier of the hybrid directory for which to retrieve update information.
        UpdateType:
          type: string
          enum:
          - SelfManagedInstances
          - HybridAdministratorAccount
          description: The type of update activities to retrieve. Valid values include SelfManagedInstances and HybridAdministratorAccount.
        NextToken:
          type: string
          description: The pagination token from a previous request to DescribeHybridADUpdate. Pass null if this is the first request.
      required:
      - DirectoryId
    ClientException:
      type: object
      properties:
        Message:
          type: string
        RequestId:
          type: string
    ADAssessmentLimitExceededException:
      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)