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

openapi: 3.0.0
info:
  version: 2015-04-16
  x-release: v4
  title: 'AWS Directory Service #X Amz Target=DirectoryService 20150416.AcceptSharedDirectory #X Amz Target=DirectoryService 20150416.AcceptSharedDirectory #X Amz Target=DirectoryService 20150416.CreateComputer API'
  description: <fullname>Directory Service</fullname> <p>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. This guide provides detailed information about Directory Service operations, data types, parameters, and errors. For information about Directory Services features, see <a href="https://aws.amazon.com/directoryservice/">Directory Service</a> and the <a href="http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html">Directory Service Administration Guide</a>.</p> <note> <p>Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to Directory Service and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see <a href="http://aws.amazon.com/tools/">Tools for Amazon Web Services</a>.</p> </note>
  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.CreateComputer'
paths:
  /#X-Amz-Target=DirectoryService_20150416.CreateComputer:
    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: CreateComputer
      description: Creates an Active Directory computer object in the specified directory.
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateComputerResult'
        '480':
          description: AuthenticationFailedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedException'
        '481':
          description: DirectoryUnavailableException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DirectoryUnavailableException'
        '482':
          description: EntityAlreadyExistsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityAlreadyExistsException'
        '483':
          description: EntityDoesNotExistException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityDoesNotExistException'
        '484':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
        '485':
          description: UnsupportedOperationException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnsupportedOperationException'
        '486':
          description: ClientException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientException'
        '487':
          description: ServiceException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceException'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateComputerRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - DirectoryService_20150416.CreateComputer
      tags:
      - '#X Amz Target=DirectoryService 20150416.CreateComputer'
components:
  schemas:
    DirectoryUnavailableException: {}
    CreateComputerRequest:
      type: object
      required:
      - DirectoryId
      - ComputerName
      - Password
      title: CreateComputerRequest
      properties:
        DirectoryId:
          allOf:
          - $ref: '#/components/schemas/DirectoryId'
          - description: The identifier of the directory in which to create the computer account.
        ComputerName:
          allOf:
          - $ref: '#/components/schemas/ComputerName'
          - description: The name of the computer account.
        Password:
          allOf:
          - $ref: '#/components/schemas/ComputerPassword'
          - description: A one-time password that is used to join the computer to the directory. You should generate a random, strong password to use for this parameter.
        OrganizationalUnitDistinguishedName:
          allOf:
          - $ref: '#/components/schemas/OrganizationalUnitDN'
          - description: The fully-qualified distinguished name of the organizational unit to place the computer account in.
        ComputerAttributes:
          allOf:
          - $ref: '#/components/schemas/Attributes'
          - description: An array of <a>Attribute</a> objects that contain any LDAP attributes to apply to the computer account.
      description: Contains the inputs for the <a>CreateComputer</a> operation.
    ClientException: {}
    ComputerName:
      type: string
      minLength: 1
      maxLength: 15
    DirectoryId:
      type: string
      pattern: ^d-[0-9a-f]{10}$
    ComputerPassword:
      type: string
      pattern: '[\u0020-\u00FF]+'
      minLength: 8
      maxLength: 64
      format: password
    Attribute:
      type: object
      properties:
        Name:
          allOf:
          - $ref: '#/components/schemas/AttributeName'
          - description: The name of the attribute.
        Value:
          allOf:
          - $ref: '#/components/schemas/AttributeValue'
          - description: The value of the attribute.
      description: Represents a named directory attribute.
    AuthenticationFailedException: {}
    Computer:
      type: object
      properties:
        ComputerId:
          allOf:
          - $ref: '#/components/schemas/SID'
          - description: The identifier of the computer.
        ComputerName:
          allOf:
          - $ref: '#/components/schemas/ComputerName'
          - description: The computer name.
        ComputerAttributes:
          allOf:
          - $ref: '#/components/schemas/Attributes'
          - description: An array of <a>Attribute</a> objects containing the LDAP attributes that belong to the computer account.
      description: Contains information about a computer account in a directory.
    UnsupportedOperationException: {}
    Attributes:
      type: array
      items:
        $ref: '#/components/schemas/Attribute'
    ServiceException: {}
    AttributeValue:
      type: string
    EntityDoesNotExistException: {}
    OrganizationalUnitDN:
      type: string
      minLength: 1
      maxLength: 2000
    SID:
      type: string
      pattern: '[&\w+-.@]+'
      minLength: 1
      maxLength: 256
    InvalidParameterException: {}
    EntityAlreadyExistsException: {}
    AttributeName:
      type: string
      minLength: 1
    CreateComputerResult:
      type: object
      properties:
        Computer:
          allOf:
          - $ref: '#/components/schemas/Computer'
          - description: A <a>Computer</a> object that represents the computer account.
      description: Contains the results for the <a>CreateComputer</a> operation.
  parameters:
    X-Amz-Date:
      name: X-Amz-Date
      in: header
      schema:
        type: string
      required: false
    X-Amz-SignedHeaders:
      name: X-Amz-SignedHeaders
      in: header
      schema:
        type: string
      required: false
    X-Amz-Credential:
      name: X-Amz-Credential
      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-Signature:
      name: X-Amz-Signature
      in: header
      schema:
        type: string
      required: false
    X-Amz-Security-Token:
      name: X-Amz-Security-Token
      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