Amazonka.DirectoryService.CreateAlias

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.

Creating a Request

data CreateAlias

Contains the inputs for the CreateAlias operation.

See: newCreateAlias smart constructor.

Constructors

CreateAlias'

Fields

• directoryId :: Text

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

• alias :: Text

  The requested alias.

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

Instances

ToJSON CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Methods

toJSON :: CreateAlias -> Value

toEncoding :: CreateAlias -> Encoding

toJSONList :: [CreateAlias] -> Value

toEncodingList :: [CreateAlias] -> Encoding

ToHeaders CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Methods

toHeaders :: CreateAlias -> [Header]

ToPath CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Methods

toPath :: CreateAlias -> ByteString

ToQuery CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Methods

toQuery :: CreateAlias -> QueryString

AWSRequest CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Associated Types

type AWSResponse CreateAlias

Methods

request :: (Service -> Service) -> CreateAlias -> Request CreateAlias

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAlias)))

Generic CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Associated Types

type Rep CreateAlias :: Type -> Type

Methods

from :: CreateAlias -> Rep CreateAlias x

to :: Rep CreateAlias x -> CreateAlias

Read CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Methods

readsPrec :: Int -> ReadS CreateAlias

readList :: ReadS [CreateAlias]

readPrec :: ReadPrec CreateAlias

readListPrec :: ReadPrec [CreateAlias]

Show CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Methods

showsPrec :: Int -> CreateAlias -> ShowS

show :: CreateAlias -> String

showList :: [CreateAlias] -> ShowS

NFData CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Methods

rnf :: CreateAlias -> ()

Eq CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Methods

(==) :: CreateAlias -> CreateAlias -> Bool

(/=) :: CreateAlias -> CreateAlias -> Bool

Hashable CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

Methods

hashWithSalt :: Int -> CreateAlias -> Int

hash :: CreateAlias -> Int

type AWSResponse CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

type AWSResponse CreateAlias = CreateAliasResponse

type Rep CreateAlias

Defined in Amazonka.DirectoryService.CreateAlias

type Rep CreateAlias = D1 ('MetaData "CreateAlias" "Amazonka.DirectoryService.CreateAlias" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "CreateAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateAlias

Arguments

:: Text

CreateAlias

-> Text

CreateAlias

-> CreateAlias

Create a value of CreateAlias with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateAlias, createAlias_directoryId - The identifier of the directory for which to create the alias.

CreateAlias, createAlias_alias - The requested alias.

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

Request Lenses

createAlias_directoryId :: Lens' CreateAlias Text

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

createAlias_alias :: Lens' CreateAlias Text

The requested alias.

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

Destructuring the Response

data CreateAliasResponse

Contains the results of the CreateAlias operation.

See: newCreateAliasResponse smart constructor.

Constructors

CreateAliasResponse'

Fields

• alias :: Maybe Text

  The alias for the directory.

• directoryId :: Maybe Text

  The identifier of the directory.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateAliasResponse

Defined in Amazonka.DirectoryService.CreateAlias

Associated Types

type Rep CreateAliasResponse :: Type -> Type

Methods

from :: CreateAliasResponse -> Rep CreateAliasResponse x

to :: Rep CreateAliasResponse x -> CreateAliasResponse

Read CreateAliasResponse

Defined in Amazonka.DirectoryService.CreateAlias

Methods

readsPrec :: Int -> ReadS CreateAliasResponse

readList :: ReadS [CreateAliasResponse]

readPrec :: ReadPrec CreateAliasResponse

readListPrec :: ReadPrec [CreateAliasResponse]

Show CreateAliasResponse

Defined in Amazonka.DirectoryService.CreateAlias

Methods

showsPrec :: Int -> CreateAliasResponse -> ShowS

show :: CreateAliasResponse -> String

showList :: [CreateAliasResponse] -> ShowS

NFData CreateAliasResponse

Defined in Amazonka.DirectoryService.CreateAlias

Methods

rnf :: CreateAliasResponse -> ()

Eq CreateAliasResponse

Defined in Amazonka.DirectoryService.CreateAlias

Methods

(==) :: CreateAliasResponse -> CreateAliasResponse -> Bool

(/=) :: CreateAliasResponse -> CreateAliasResponse -> Bool

type Rep CreateAliasResponse

Defined in Amazonka.DirectoryService.CreateAlias

type Rep CreateAliasResponse = D1 ('MetaData "CreateAliasResponse" "Amazonka.DirectoryService.CreateAlias" "amazonka-ds-2.0-AgXI5fcN8ZxCoi4kNvhD3" 'False) (C1 ('MetaCons "CreateAliasResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "directoryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateAliasResponse

Arguments

:: Int

$sel:httpStatus:CreateAliasResponse'

-> CreateAliasResponse

Create a value of CreateAliasResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateAlias, createAliasResponse_alias - The alias for the directory.

CreateAlias, createAliasResponse_directoryId - The identifier of the directory.

$sel:httpStatus:CreateAliasResponse', createAliasResponse_httpStatus - The response's http status code.

Response Lenses

createAliasResponse_alias :: Lens' CreateAliasResponse (Maybe Text)

The alias for the directory.

createAliasResponse_directoryId :: Lens' CreateAliasResponse (Maybe Text)

The identifier of the directory.

createAliasResponse_httpStatus :: Lens' CreateAliasResponse Int

The response's http status code.