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

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

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.


The name of the Directory Config object.

Type: String

Required: Yes


The distinguished names of the organizational units for computer accounts.

Type: Array of strings

Length Constraints: Maximum length of 2000.

Required: No


The credentials for the service account used by the fleet or image builder to connect to the directory.

Type: ServiceAccountCredentials object

Required: No

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.


Information about the Directory Config object.

Type: DirectoryConfig object


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


An API error occurred. Wait a few minutes and try again.

HTTP Status Code: 400


The specified resource is in use.

HTTP Status Code: 400


The specified resource was not found.

HTTP Status Code: 400

See Also

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