Menu
Amazon AppStream 2.0
API Reference (API Version 2016-12-01)

CreateDirectoryConfig

Creates a directory configuration.

Request Syntax

{
   "DirectoryName": "string",
   "OrganizationalUnitDistinguishedNames": [ "string" ],
   "ServiceAccountCredentials": { 
      "AccountName": "string",
      "AccountPassword": "string"
   }
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DirectoryName

The fully qualified name of the directory (for example, corp.example.com).

Type: String

Required: Yes

OrganizationalUnitDistinguishedNames

The distinguished names of the organizational units for computer accounts.

Type: Array of strings

Length Constraints: Maximum length of 2000.

Required: Yes

ServiceAccountCredentials

The credentials for the service account used by the streaming instance to connect to the directory.

Type: ServiceAccountCredentials object

Required: Yes

Response Syntax

{
   "DirectoryConfig": { 
      "CreatedTime": number,
      "DirectoryName": "string",
      "OrganizationalUnitDistinguishedNames": [ "string" ],
      "ServiceAccountCredentials": { 
         "AccountName": "string",
         "AccountPassword": "string"
      }
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

DirectoryConfig

Information about the directory configuration.

Type: DirectoryConfig object

Errors

For information about the errors that are common to all actions, see Common Errors.

LimitExceededException

The requested limit exceeds the permitted limit for an account.

HTTP Status Code: 400

ResourceAlreadyExistsException

The specified resource already exists.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: