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 |
Gets a paginated list of stage summaries from the game.
This operation returns paginated results.
Synopsis
- data ListStages = ListStages' {}
- newListStages :: Text -> ListStages
- listStages_maxResults :: Lens' ListStages (Maybe Natural)
- listStages_nextToken :: Lens' ListStages (Maybe Text)
- listStages_gameName :: Lens' ListStages Text
- data ListStagesResponse = ListStagesResponse' {
- nextToken :: Maybe Text
- stages :: Maybe [StageSummary]
- httpStatus :: Int
- newListStagesResponse :: Int -> ListStagesResponse
- listStagesResponse_nextToken :: Lens' ListStagesResponse (Maybe Text)
- listStagesResponse_stages :: Lens' ListStagesResponse (Maybe [StageSummary])
- listStagesResponse_httpStatus :: Lens' ListStagesResponse Int
Creating a Request
data ListStages Source #
See: newListStages
smart constructor.
ListStages' | |
|
Instances
Create a value of ListStages
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:ListStages'
, listStages_maxResults
- The maximum number of results to return.
Use this parameter with NextToken to get results as a set of sequential pages.
ListStages
, listStages_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.
$sel:gameName:ListStages'
, listStages_gameName
- The name of the game.
Request Lenses
listStages_maxResults :: Lens' ListStages (Maybe Natural) Source #
The maximum number of results to return.
Use this parameter with NextToken to get results as a set of sequential pages.
listStages_nextToken :: Lens' ListStages (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.
listStages_gameName :: Lens' ListStages Text Source #
The name of the game.
Destructuring the Response
data ListStagesResponse Source #
See: newListStagesResponse
smart constructor.
ListStagesResponse' | |
|
Instances
newListStagesResponse Source #
Create a value of ListStagesResponse
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:
ListStages
, listStagesResponse_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:stages:ListStagesResponse'
, listStagesResponse_stages
- A list of stage summaries. You can use the stage names in the
UpdateStage
and GetStage
actions.
$sel:httpStatus:ListStagesResponse'
, listStagesResponse_httpStatus
- The response's http status code.
Response Lenses
listStagesResponse_nextToken :: Lens' ListStagesResponse (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.
listStagesResponse_stages :: Lens' ListStagesResponse (Maybe [StageSummary]) Source #
A list of stage summaries. You can use the stage names in the
UpdateStage
and GetStage
actions.
listStagesResponse_httpStatus :: Lens' ListStagesResponse Int Source #
The response's http status code.