Amazon Directory Service #X Amz Target=DirectoryService 20150416.ConnectDirectory API

openapi: 3.2.0
info:
  version: 2015-04-16
  x-release: v4
  title: 'AWS Directory Service #X Amz Target=DirectoryService…'
  description: 'Directory Service

    Directory Service is a web service that makes it easy for you to setup and run directories in the Amazon Web Services cloud, or connect your Amazon Web Services resources with an existing self-managed Microsoft Active Directory.'
  x-logo:
    url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: ds
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/ds-2015-04-16.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://ds.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Directory Service multi-region endpoint
- url: https://ds.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Directory Service multi-region endpoint
- url: http://ds.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Directory Service endpoint for China (Beijing) and China (Ningxia)
- url: https://ds.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Directory Service endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=DirectoryService 20150416.ConnectDirectory'
paths:
  /#X-Amz-Target=DirectoryService_20150416.ConnectDirectory:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: ConnectDirectory
      description: 'Creates an AD Connector to connect to a self-managed directory.


        Before you call ConnectDirectory, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the ConnectDirectory operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectDirectoryResult'
        '480':
          description: DirectoryLimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectoryLimitExceededException'
        '481':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '482':
          description: ClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '483':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConnectDirectoryRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.ConnectDirectory
      tags:
      - '#X Amz Target=DirectoryService 20150416.ConnectDirectory'
      summary: Connect directory
      x-summary-source: derived
components:
  schemas:
    IpAddr:
      type: string
      pattern: ^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
    SubnetId:
      type: string
      pattern: ^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$
    TagKey:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
      minLength: 1
      maxLength: 128
    TagValue:
      type: string
      pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
      minLength: 0
      maxLength: 256
    Tag:
      type: object
      required:
      - Key
      - Value
      properties:
        Key:
          allOf:
          - $ref: '#/components/schemas/TagKey'
          - 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:
          allOf:
          - $ref: '#/components/schemas/TagValue'
          - 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}_.:/=+\\-]*)$").'
      description: Metadata assigned to a directory consisting of a key-value pair.
    SubnetIds:
      type: array
      items:
        $ref: '#/components/schemas/SubnetId'
    UserName:
      type: string
      pattern: '[a-zA-Z0-9._-]+'
      minLength: 1
    DirectoryName:
      type: string
      pattern: ^([a-zA-Z0-9]+[\\.-])+([a-zA-Z0-9])+$
    ClientException: {}
    DnsIpAddrs:
      type: array
      items:
        $ref: '#/components/schemas/IpAddr'
    Tags:
      type: array
      items:
        $ref: '#/components/schemas/Tag'
    DirectoryShortName:
      type: string
      pattern: ^[^\\/:*?"<>|.]+[^\\/:*?"<>|]*$
    ServiceException: {}
    DirectoryLimitExceededException: {}
    InvalidParameterException: {}
    VpcId:
      type: string
      pattern: ^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$
    ConnectDirectoryRequest:
      type: object
      required:
      - Name
      - Password
      - Size
      - ConnectSettings
      title: ConnectDirectoryRequest
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/DirectoryName'
          - description: The fully qualified name of your self-managed directory, such as <code>corp.example.com</code>.
        ShortName:
          allOf:
          - $ref: '#/components/schemas/DirectoryShortName'
          - description: The NetBIOS name of your self-managed directory, such as <code>CORP</code>.
        Password:
          allOf:
          - $ref: '#/components/schemas/ConnectPassword'
          - description: The password for your self-managed user account.
        Description:
          allOf:
          - $ref: '#/components/schemas/Description'
          - description: A description for the directory.
        Size:
          allOf:
          - $ref: '#/components/schemas/DirectorySize'
          - description: The size of the directory.
        ConnectSettings:
          allOf:
          - $ref: '#/components/schemas/DirectoryConnectSettings'
          - description: A <a>DirectoryConnectSettings</a> object that contains additional information for the operation.
        Tags:
          allOf:
          - $ref: '#/components/schemas/Tags'
          - description: The tags to be assigned to AD Connector.
      description: Contains the inputs for the <a>ConnectDirectory</a> operation.
    DirectoryId:
      type: string
      pattern: ^d-[0-9a-f]{10}$
    ConnectDirectoryResult:
      type: object
      properties:
        DirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: The identifier of the new directory.
      description: Contains the results of the <a>ConnectDirectory</a> operation.
    DirectoryConnectSettings:
      type: object
      required:
      - VpcId
      - SubnetIds
      - CustomerDnsIps
      - CustomerUserName
      properties:
        VpcId:
          allOf:
          - $ref: '#/components/schemas/VpcId'
          - description: The identifier of the VPC in which the AD Connector is created.
        SubnetIds:
          allOf:
          - $ref: '#/components/schemas/SubnetIds'
          - description: A list of subnet identifiers in the VPC in which the AD Connector is created.
        CustomerDnsIps:
          allOf:
          - $ref: '#/components/schemas/DnsIpAddrs'
          - description: A list of one or more IP addresses of DNS servers or domain controllers in your self-managed directory.
        CustomerUserName:
          allOf:
          - $ref: '#/components/schemas/UserName'
          - description: <p>The user name of an account in your self-managed directory that is used to connect to the directory. This account must have the following permissions:</p> <ul> <li> <p>Read users and groups</p> </li> <li> <p>Create computer objects</p> </li> <li> <p>Join computers to the domain</p> </li> </ul>
      description: Contains information for the <a>ConnectDirectory</a> operation when an AD Connector directory is being created.
    DirectorySize:
      type: string
      enum:
      - Small
      - Large
    ConnectPassword:
      type: string
      minLength: 1
      maxLength: 128
      format: password
    Description:
      type: string
      pattern: ^([a-zA-Z0-9_])[\\a-zA-Z0-9_@#%*+=:?./!\s-]*$
      minLength: 0
      maxLength: 128
  parameters:
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Content-Sha256:
      name: X-Amz-Content-Sha256
      in: header
      schema:
        type: string
      required: false
    X-Amz-Algorithm:
      name: X-Amz-Algorithm
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      in: header
      schema:
        type: string
      required: false
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
  securitySchemes:
    hmac:
      type: apiKey
      name: Authorization
      in: header
      description: Amazon Signature authorization v4
      x-amazon-apigateway-authtype: awsSigv4
externalDocs:
  description: Amazon Web Services documentation
  url: https://docs.aws.amazon.com/ds/
x-hasEquivalentPaths: true