| 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.ListSnapshots
Description
Gets a paginated list of snapshot summaries from the game.
This operation returns paginated results.
Synopsis
- data ListSnapshots = ListSnapshots' {}
- newListSnapshots :: Text -> ListSnapshots
- listSnapshots_maxResults :: Lens' ListSnapshots (Maybe Natural)
- listSnapshots_nextToken :: Lens' ListSnapshots (Maybe Text)
- listSnapshots_gameName :: Lens' ListSnapshots Text
- data ListSnapshotsResponse = ListSnapshotsResponse' {
- nextToken :: Maybe Text
- snapshots :: Maybe [SnapshotSummary]
- httpStatus :: Int
- newListSnapshotsResponse :: Int -> ListSnapshotsResponse
- listSnapshotsResponse_nextToken :: Lens' ListSnapshotsResponse (Maybe Text)
- listSnapshotsResponse_snapshots :: Lens' ListSnapshotsResponse (Maybe [SnapshotSummary])
- listSnapshotsResponse_httpStatus :: Lens' ListSnapshotsResponse Int
Creating a Request
data ListSnapshots Source #
See: newListSnapshots smart constructor.
Constructors
| ListSnapshots' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> ListSnapshots |
Create a value of ListSnapshots 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:ListSnapshots', listSnapshots_maxResults - The maximum number of results to return.
Use this parameter with NextToken to get results as a set of sequential pages.
ListSnapshots, listSnapshots_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:ListSnapshots', listSnapshots_gameName - The name of the game.
Request Lenses
listSnapshots_maxResults :: Lens' ListSnapshots (Maybe Natural) Source #
The maximum number of results to return.
Use this parameter with NextToken to get results as a set of sequential pages.
listSnapshots_nextToken :: Lens' ListSnapshots (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.
listSnapshots_gameName :: Lens' ListSnapshots Text Source #
The name of the game.
Destructuring the Response
data ListSnapshotsResponse Source #
See: newListSnapshotsResponse smart constructor.
Constructors
| ListSnapshotsResponse' | |
Fields
| |
Instances
newListSnapshotsResponse Source #
Create a value of ListSnapshotsResponse 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:
ListSnapshots, listSnapshotsResponse_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:snapshots:ListSnapshotsResponse', listSnapshotsResponse_snapshots - A list of snapshot summaries. You can use the returned snapshot IDs in
the UpdateSnapshot and GetSnapshot operations.
$sel:httpStatus:ListSnapshotsResponse', listSnapshotsResponse_httpStatus - The response's http status code.
Response Lenses
listSnapshotsResponse_nextToken :: Lens' ListSnapshotsResponse (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.
listSnapshotsResponse_snapshots :: Lens' ListSnapshotsResponse (Maybe [SnapshotSummary]) Source #
A list of snapshot summaries. You can use the returned snapshot IDs in
the UpdateSnapshot and GetSnapshot operations.
listSnapshotsResponse_httpStatus :: Lens' ListSnapshotsResponse Int Source #
The response's http status code.