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.DescribeGameServer

Description

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

Retrieves information for a registered game server. Information includes game server status, health check info, and the instance that the game server is running on.

To retrieve game server information, specify the game server ID. If successful, the requested game server object is returned.

Learn more

GameLift FleetIQ Guide

Related actions

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

Synopsis

Creating a Request

data DescribeGameServer Source #

See: newDescribeGameServer smart constructor.

Constructors

DescribeGameServer' 

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 information to be retrieved.

Instances

Instances details
Eq DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

(==) :: DescribeGameServer -> DescribeGameServer -> Bool #

(/=) :: DescribeGameServer -> DescribeGameServer -> Bool #

Read DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

readsPrec :: Int -> ReadS DescribeGameServer #

readList :: ReadS [DescribeGameServer] #

readPrec :: ReadPrec DescribeGameServer #

readListPrec :: ReadPrec [DescribeGameServer] #

Show DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

showsPrec :: Int -> DescribeGameServer -> ShowS #

show :: DescribeGameServer -> String #

showList :: [DescribeGameServer] -> ShowS #

Generic DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Associated Types

type Rep DescribeGameServer :: Type -> Type #

Methods

from :: DescribeGameServer -> Rep DescribeGameServer x #

to :: Rep DescribeGameServer x -> DescribeGameServer #

NFData DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

rnf :: DescribeGameServer -> () #

Hashable DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

hashWithSalt :: Int -> DescribeGameServer -> Int #

hash :: DescribeGameServer -> Int #

ToJSON DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

toJSON :: DescribeGameServer -> Value #

toEncoding :: DescribeGameServer -> Encoding #

toJSONList :: [DescribeGameServer] -> Value #

toEncodingList :: [DescribeGameServer] -> Encoding #

AWSRequest DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Associated Types

type AWSResponse DescribeGameServer #

Methods

request :: DescribeGameServer -> Request DescribeGameServer #

response :: MonadResource m => Logger -> Service -> Proxy DescribeGameServer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGameServer))) #

ToHeaders DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

toHeaders :: DescribeGameServer -> [Header] #

ToPath DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

toPath :: DescribeGameServer -> ByteString #

ToQuery DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

toQuery :: DescribeGameServer -> QueryString #

type Rep DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

type Rep DescribeGameServer = D1 ('MetaData "DescribeGameServer" "Amazonka.GameLift.DescribeGameServer" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeGameServer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameServerGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "gameServerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeGameServer Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

type AWSResponse DescribeGameServer = DescribeGameServerResponse

newDescribeGameServer Source #

Arguments

:: Text

$sel:gameServerGroupName:DescribeGameServer'

-> Text

$sel:gameServerId:DescribeGameServer'

-> DescribeGameServer 

Create a value of DescribeGameServer 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:DescribeGameServer', describeGameServer_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:DescribeGameServer', describeGameServer_gameServerId - A custom string that uniquely identifies the game server information to be retrieved.

Request Lenses

describeGameServer_gameServerGroupName :: Lens' DescribeGameServer Text Source #

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

describeGameServer_gameServerId :: Lens' DescribeGameServer Text Source #

A custom string that uniquely identifies the game server information to be retrieved.

Destructuring the Response

data DescribeGameServerResponse Source #

See: newDescribeGameServerResponse smart constructor.

Constructors

DescribeGameServerResponse' 

Fields

Instances

Instances details
Eq DescribeGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

(==) :: DescribeGameServerResponse -> DescribeGameServerResponse -> Bool #

(/=) :: DescribeGameServerResponse -> DescribeGameServerResponse -> Bool #

Read DescribeGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

readsPrec :: Int -> ReadS DescribeGameServerResponse #

readList :: ReadS [DescribeGameServerResponse] #

readPrec :: ReadPrec DescribeGameServerResponse #

readListPrec :: ReadPrec [DescribeGameServerResponse] #

Show DescribeGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

showsPrec :: Int -> DescribeGameServerResponse -> ShowS #

show :: DescribeGameServerResponse -> String #

showList :: [DescribeGameServerResponse] -> ShowS #

Generic DescribeGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Associated Types

type Rep DescribeGameServerResponse :: Type -> Type #

Methods

from :: DescribeGameServerResponse -> Rep DescribeGameServerResponse x #

to :: Rep DescribeGameServerResponse x -> DescribeGameServerResponse #

NFData DescribeGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

Methods

rnf :: DescribeGameServerResponse -> () #

type Rep DescribeGameServerResponse Source # 
Instance details

Defined in Amazonka.GameLift.DescribeGameServer

type Rep DescribeGameServerResponse = D1 ('MetaData "DescribeGameServerResponse" "Amazonka.GameLift.DescribeGameServer" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "DescribeGameServerResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameServer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameServer)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeGameServerResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeGameServerResponse'

-> DescribeGameServerResponse 

Create a value of DescribeGameServerResponse 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:gameServer:DescribeGameServerResponse', describeGameServerResponse_gameServer - Object that describes the requested game server.

$sel:httpStatus:DescribeGameServerResponse', describeGameServerResponse_httpStatus - The response's http status code.

Response Lenses

describeGameServerResponse_gameServer :: Lens' DescribeGameServerResponse (Maybe GameServer) Source #

Object that describes the requested game server.

describeGameServerResponse_httpStatus :: Lens' DescribeGameServerResponse Int Source #

The response's http status code.