directoryservice_create_alias: Creates an alias for a directory and assigns the alias to the...

Description Usage Arguments Details Request syntax

View source: R/directoryservice_operations.R

Description

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.

Usage

1
directoryservice_create_alias(DirectoryId, Alias)

Arguments

DirectoryId

[required] The identifier of the directory for which to create the alias.

Alias

[required] The requested alias.

The alias must be unique amongst all aliases in AWS. This operation throws an EntityAlreadyExistsException error if the alias already exists.

Details

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

Request syntax

1
2
3
4
svc$create_alias(
  DirectoryId = "string",
  Alias = "string"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.