Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.DeleteAlias

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

Related actions

All APIs by task

Synopsis

data DeleteAlias = DeleteAlias' {
- aliasId :: Text
}
newDeleteAlias :: Text -> DeleteAlias
deleteAlias_aliasId :: Lens' DeleteAlias Text
data DeleteAliasResponse = DeleteAliasResponse' {
}
newDeleteAliasResponse :: DeleteAliasResponse

Creating a Request

data DeleteAlias Source #

See: newDeleteAlias smart constructor.

Constructors

DeleteAlias'
Fields aliasId :: Text A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.

Instances

Instances details

ToJSON DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods toJSON :: DeleteAlias -> Value # toEncoding :: DeleteAlias -> Encoding # toJSONList :: [DeleteAlias] -> Value # toEncodingList :: [DeleteAlias] -> Encoding #
ToHeaders DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods toHeaders :: DeleteAlias -> [Header] #
ToPath DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods toPath :: DeleteAlias -> ByteString #
ToQuery DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods toQuery :: DeleteAlias -> QueryString #
AWSRequest DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Associated Types type AWSResponse DeleteAlias # Methods request :: (Service -> Service) -> DeleteAlias -> Request DeleteAlias # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteAlias -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteAlias))) #
Generic DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Associated Types type Rep DeleteAlias :: Type -> Type # Methods from :: DeleteAlias -> Rep DeleteAlias x # to :: Rep DeleteAlias x -> DeleteAlias #
Read DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods readsPrec :: Int -> ReadS DeleteAlias # readList :: ReadS [DeleteAlias] # readPrec :: ReadPrec DeleteAlias # readListPrec :: ReadPrec [DeleteAlias] #
Show DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods showsPrec :: Int -> DeleteAlias -> ShowS # show :: DeleteAlias -> String # showList :: [DeleteAlias] -> ShowS #
NFData DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods rnf :: DeleteAlias -> () #
Eq DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods (==) :: DeleteAlias -> DeleteAlias -> Bool # (/=) :: DeleteAlias -> DeleteAlias -> Bool #
Hashable DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods hashWithSalt :: Int -> DeleteAlias -> Int # hash :: DeleteAlias -> Int #
type AWSResponse DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias type AWSResponse DeleteAlias = DeleteAliasResponse
type Rep DeleteAlias Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias type Rep DeleteAlias = D1 ('MetaData "DeleteAlias" "Amazonka.GameLift.DeleteAlias" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DeleteAlias'" 'PrefixI 'True) (S1 ('MetaSel ('Just "aliasId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteAlias Source #

Arguments

:: Text	`DeleteAlias`
-> DeleteAlias

Create a value of DeleteAlias 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:

DeleteAlias, deleteAlias_aliasId - A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.

Request Lenses

deleteAlias_aliasId :: Lens' DeleteAlias Text Source #

A unique identifier of the alias that you want to delete. You can use either the alias ID or ARN value.

Destructuring the Response

data DeleteAliasResponse Source #

See: newDeleteAliasResponse smart constructor.

Constructors

DeleteAliasResponse'

Instances

Instances details

Generic DeleteAliasResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Associated Types type Rep DeleteAliasResponse :: Type -> Type # Methods from :: DeleteAliasResponse -> Rep DeleteAliasResponse x # to :: Rep DeleteAliasResponse x -> DeleteAliasResponse #
Read DeleteAliasResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods readsPrec :: Int -> ReadS DeleteAliasResponse # readList :: ReadS [DeleteAliasResponse] # readPrec :: ReadPrec DeleteAliasResponse # readListPrec :: ReadPrec [DeleteAliasResponse] #
Show DeleteAliasResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods showsPrec :: Int -> DeleteAliasResponse -> ShowS # show :: DeleteAliasResponse -> String # showList :: [DeleteAliasResponse] -> ShowS #
NFData DeleteAliasResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods rnf :: DeleteAliasResponse -> () #
Eq DeleteAliasResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias Methods (==) :: DeleteAliasResponse -> DeleteAliasResponse -> Bool # (/=) :: DeleteAliasResponse -> DeleteAliasResponse -> Bool #
type Rep DeleteAliasResponse Source #
Instance details Defined in Amazonka.GameLift.DeleteAlias type Rep DeleteAliasResponse = D1 ('MetaData "DeleteAliasResponse" "Amazonka.GameLift.DeleteAlias" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DeleteAliasResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteAliasResponse :: DeleteAliasResponse Source #

Create a value of DeleteAliasResponse with all optional fields omitted.

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