| 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.GamesParks.ListGames
Description
Gets a paginated list of games.
This operation returns paginated results.
Synopsis
- data ListGames = ListGames' {}
- newListGames :: ListGames
- listGames_maxResults :: Lens' ListGames (Maybe Natural)
- listGames_nextToken :: Lens' ListGames (Maybe Text)
- data ListGamesResponse = ListGamesResponse' {
- games :: Maybe [GameSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListGamesResponse :: Int -> ListGamesResponse
- listGamesResponse_games :: Lens' ListGamesResponse (Maybe [GameSummary])
- listGamesResponse_nextToken :: Lens' ListGamesResponse (Maybe Text)
- listGamesResponse_httpStatus :: Lens' ListGamesResponse Int
Creating a Request
See: newListGames smart constructor.
Constructors
| ListGames' | |
Fields
| |
Instances
newListGames :: ListGames Source #
Create a value of ListGames 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:maxResults:ListGames', listGames_maxResults - The maximum number of results to return.
Use this parameter with NextToken to get results as a set of sequential pages.
ListGames, listGames_nextToken - The 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.
Request Lenses
listGames_maxResults :: Lens' ListGames (Maybe Natural) Source #
The maximum number of results to return.
Use this parameter with NextToken to get results as a set of sequential pages.
listGames_nextToken :: Lens' ListGames (Maybe Text) Source #
The 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.
Destructuring the Response
data ListGamesResponse Source #
See: newListGamesResponse smart constructor.
Constructors
| ListGamesResponse' | |
Fields
| |
Instances
Arguments
| :: Int | |
| -> ListGamesResponse |
Create a value of ListGamesResponse 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:games:ListGamesResponse', listGamesResponse_games - The list of games.
ListGames, listGamesResponse_nextToken - The token that indicates the start of the next sequential page of
results.
Use this value when making the next call to this operation to continue where the last one finished.
$sel:httpStatus:ListGamesResponse', listGamesResponse_httpStatus - The response's http status code.
Response Lenses
listGamesResponse_games :: Lens' ListGamesResponse (Maybe [GameSummary]) Source #
The list of games.
listGamesResponse_nextToken :: Lens' ListGamesResponse (Maybe Text) Source #
The token that indicates the start of the next sequential page of results.
Use this value when making the next call to this operation to continue where the last one finished.
listGamesResponse_httpStatus :: Lens' ListGamesResponse Int Source #
The response's http status code.