v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1467365253.0 KB

Creates an alias for a directory and assigns the alias to the directory. The alias is used to construct the access URL for the directory, such as http://<alias>.awsapps.com.

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

post/#X-Amz-Target=DirectoryService_20150416.CreateAlias

Headers

X-Amz-Target'DirectoryService_20150416.CreateAlias' required

Request body

DirectoryIdstring required

The identifier of the directory for which to create the alias.

Aliasstring required
<p>The requested alias.</p> <p>The alias must be unique amongst all aliases in Amazon Web Services. This operation throws an <code>EntityAlreadyExistsException</code> error if the alias already exists.</p>

Response

Success

DirectoryIdstring

The identifier of the directory.

Aliasstring

The alias for the directory.