| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.GameLift.ListGameServers
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
This operation returns paginated results.
Synopsis
- data ListGameServers = ListGameServers' {}
- newListGameServers :: Text -> ListGameServers
- listGameServers_limit :: Lens' ListGameServers (Maybe Natural)
- listGameServers_nextToken :: Lens' ListGameServers (Maybe Text)
- listGameServers_sortOrder :: Lens' ListGameServers (Maybe SortOrder)
- 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
| |
Instances
Arguments
| :: Text | |
| -> 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: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.
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.
ListGameServers, listGameServers_gameServerGroupName - An identifier for the game server group to retrieve a list of game
servers from. Use either the name or ARN value.
Request Lenses
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_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_gameServerGroupName :: Lens' ListGameServers Text Source #
An identifier for the game server group to retrieve a list of game servers from. Use either the name or ARN value.
Destructuring the Response
data ListGameServersResponse Source #
See: newListGameServersResponse smart constructor.
Constructors
| ListGameServersResponse' | |
Fields
| |
Instances
newListGameServersResponse Source #
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.
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.