Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.GameLift.DeregisterGameServer

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

__This operation is used with the GameLift FleetIQ solution and game server groups.__

Removes the game server from a game server group. As a result of this operation, the deregistered game server can no longer be claimed and will not be returned in a list of active game servers.

To deregister a game server, specify the game server group and game server ID. If successful, this operation emits a CloudWatch event with termination timestamp and reason.

Learn more

GameLift FleetIQ Guide

Related actions

Creating a Request

data DeregisterGameServer Source #

See: newDeregisterGameServer smart constructor.

Constructors

DeregisterGameServer'
Fields gameServerGroupName :: Text A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value. gameServerId :: Text A custom string that uniquely identifies the game server to deregister.

Instances

Instances details

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

newDeregisterGameServer Source #

Arguments

:: Text	`$sel:gameServerGroupName:DeregisterGameServer'`
-> Text	`$sel:gameServerId:DeregisterGameServer'`
-> DeregisterGameServer

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

$sel:gameServerGroupName:DeregisterGameServer', deregisterGameServer_gameServerGroupName - A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

$sel:gameServerId:DeregisterGameServer', deregisterGameServer_gameServerId - A custom string that uniquely identifies the game server to deregister.

Request Lenses

deregisterGameServer_gameServerGroupName :: Lens' DeregisterGameServer Text Source #

A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

deregisterGameServer_gameServerId :: Lens' DeregisterGameServer Text Source #

A custom string that uniquely identifies the game server to deregister.

Destructuring the Response

data DeregisterGameServerResponse Source #

See: newDeregisterGameServerResponse smart constructor.

Constructors

DeregisterGameServerResponse'

Instances

Instances details

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

newDeregisterGameServerResponse :: DeregisterGameServerResponse Source #

Create a value of DeregisterGameServerResponse with all optional fields omitted.

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