libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.DeregisterGameServer

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

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Synopsis

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

Read DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

Show DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

Generic DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

Associated Types

type Rep DeregisterGameServer :: Type -> Type #

NFData DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

Methods

rnf :: DeregisterGameServer -> () #

Hashable DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

ToJSON DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

AWSRequest DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

Associated Types

type AWSResponse DeregisterGameServer #

ToHeaders DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

ToPath DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

ToQuery DeregisterGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

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

newDeregisterGameServer Source #

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.

Instances

Instances details
Eq DeregisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

Read DeregisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

Show DeregisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

Generic DeregisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

Associated Types

type Rep DeregisterGameServerResponse :: Type -> Type #

NFData DeregisterGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DeregisterGameServer

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.