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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Retrieves information on all game servers that are currently active in a specified game server group. You can opt to sort the list by game server age. Use the pagination parameters to retrieve results in a set of sequential segments.

Learn more

GameLift FleetIQ Guide

Related actions

This operation returns paginated results.

Synopsis

data ListGameServers = ListGameServers' {
- nextToken :: Maybe Text
- sortOrder :: Maybe SortOrder
- limit :: Maybe Natural
- gameServerGroupName :: Text
}
newListGameServers :: Text -> ListGameServers
listGameServers_nextToken :: Lens' ListGameServers (Maybe Text)
listGameServers_sortOrder :: Lens' ListGameServers (Maybe SortOrder)
listGameServers_limit :: Lens' ListGameServers (Maybe Natural)
listGameServers_gameServerGroupName :: Lens' ListGameServers Text
data ListGameServersResponse = ListGameServersResponse' {
- gameServers :: Maybe [GameServer]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListGameServersResponse :: Int -> ListGameServersResponse
listGameServersResponse_gameServers :: Lens' ListGameServersResponse (Maybe [GameServer])
listGameServersResponse_nextToken :: Lens' ListGameServersResponse (Maybe Text)
listGameServersResponse_httpStatus :: Lens' ListGameServersResponse Int

Creating a Request

data ListGameServers Source #

See: newListGameServers smart constructor.

Constructors

ListGameServers'

Fields

nextToken :: Maybe Text
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
sortOrder :: Maybe SortOrder
Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.
limit :: Maybe Natural
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
gameServerGroupName :: Text
An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

Instances

Instances details

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

newListGameServers Source #

Arguments

:: Text	`$sel:gameServerGroupName:ListGameServers'`
-> ListGameServers

Create a value of ListGameServers 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:nextToken:ListGameServers', listGameServers_nextToken - A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

$sel:sortOrder:ListGameServers', listGameServers_sortOrder - Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

$sel:limit:ListGameServers', listGameServers_limit - The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

$sel:gameServerGroupName:ListGameServers', listGameServers_gameServerGroupName - An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

Request Lenses

listGameServers_nextToken :: Lens' ListGameServers (Maybe Text) Source #

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

listGameServers_sortOrder :: Lens' ListGameServers (Maybe SortOrder) Source #

Indicates how to sort the returned data based on game server registration timestamp. Use ASCENDING to retrieve oldest game servers first, or use DESCENDING to retrieve newest game servers first. If this parameter is left empty, game servers are returned in no particular order.

listGameServers_limit :: Lens' ListGameServers (Maybe Natural) Source #

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

listGameServers_gameServerGroupName :: Lens' ListGameServers Text Source #

An identifier for the game server group to retrieve a list of game servers from. Use either the GameServerGroup name or ARN value.

Destructuring the Response

data ListGameServersResponse Source #

See: newListGameServersResponse smart constructor.

Constructors

ListGameServersResponse'
Fields gameServers :: Maybe [GameServer] A collection of game server objects that match the request. nextToken :: Maybe Text A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq ListGameServersResponse Source #
Instance details Defined in Amazonka.GameLift.ListGameServers Methods (==) :: ListGameServersResponse -> ListGameServersResponse -> Bool # (/=) :: ListGameServersResponse -> ListGameServersResponse -> Bool #
Read ListGameServersResponse Source #
Instance details Defined in Amazonka.GameLift.ListGameServers Methods readsPrec :: Int -> ReadS ListGameServersResponse # readList :: ReadS [ListGameServersResponse] # readPrec :: ReadPrec ListGameServersResponse # readListPrec :: ReadPrec [ListGameServersResponse] #
Show ListGameServersResponse Source #
Instance details Defined in Amazonka.GameLift.ListGameServers Methods showsPrec :: Int -> ListGameServersResponse -> ShowS # show :: ListGameServersResponse -> String # showList :: [ListGameServersResponse] -> ShowS #
Generic ListGameServersResponse Source #
Instance details Defined in Amazonka.GameLift.ListGameServers Associated Types type Rep ListGameServersResponse :: Type -> Type # Methods from :: ListGameServersResponse -> Rep ListGameServersResponse x # to :: Rep ListGameServersResponse x -> ListGameServersResponse #
NFData ListGameServersResponse Source #
Instance details Defined in Amazonka.GameLift.ListGameServers Methods rnf :: ListGameServersResponse -> () #
type Rep ListGameServersResponse Source #
Instance details Defined in Amazonka.GameLift.ListGameServers type Rep ListGameServersResponse = D1 ('MetaData "ListGameServersResponse" "Amazonka.GameLift.ListGameServers" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "ListGameServersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameServers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GameServer])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListGameServersResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListGameServersResponse'`
-> ListGameServersResponse

Create a value of ListGameServersResponse 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:gameServers:ListGameServersResponse', listGameServersResponse_gameServers - A collection of game server objects that match the request.

$sel:nextToken:ListGameServers', listGameServersResponse_nextToken - A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

$sel:httpStatus:ListGameServersResponse', listGameServersResponse_httpStatus - The response's http status code.

Response Lenses

listGameServersResponse_gameServers :: Lens' ListGameServersResponse (Maybe [GameServer]) Source #

A collection of game server objects that match the request.

listGameServersResponse_nextToken :: Lens' ListGameServersResponse (Maybe Text) Source #

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

listGameServersResponse_httpStatus :: Lens' ListGameServersResponse Int Source #

The response's http status code.