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 |
__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
Related actions
RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task
Synopsis
- data DeregisterGameServer = DeregisterGameServer' {}
- newDeregisterGameServer :: Text -> Text -> DeregisterGameServer
- deregisterGameServer_gameServerGroupName :: Lens' DeregisterGameServer Text
- deregisterGameServer_gameServerId :: Lens' DeregisterGameServer Text
- data DeregisterGameServerResponse = DeregisterGameServerResponse' {
- newDeregisterGameServerResponse :: DeregisterGameServerResponse
Creating a Request
data DeregisterGameServer Source #
See: newDeregisterGameServer
smart constructor.
DeregisterGameServer' | |
|
Instances
newDeregisterGameServer Source #
:: Text | |
-> Text | |
-> 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.
Instances
newDeregisterGameServerResponse :: DeregisterGameServerResponse Source #
Create a value of DeregisterGameServerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.