Amazonka.GamesParks.ListSnapshots

Gets a paginated list of snapshot summaries from the game.

This operation returns paginated results.

Creating a Request

data ListSnapshots

See: newListSnapshots smart constructor.

Constructors

ListSnapshots'

Fields

• maxResults :: Maybe Natural

  The maximum number of results to return.

  Use this parameter with NextToken to get results as a set of sequential pages.

• nextToken :: Maybe Text

  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.

• gameName :: Text

  The name of the game.

Instances

ToHeaders ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Methods

toHeaders :: ListSnapshots -> [Header]

ToPath ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Methods

toPath :: ListSnapshots -> ByteString

ToQuery ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Methods

toQuery :: ListSnapshots -> QueryString

AWSPager ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Methods

page :: ListSnapshots -> AWSResponse ListSnapshots -> Maybe ListSnapshots

AWSRequest ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Associated Types

type AWSResponse ListSnapshots

Methods

request :: (Service -> Service) -> ListSnapshots -> Request ListSnapshots

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListSnapshots -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListSnapshots)))

Generic ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Associated Types

type Rep ListSnapshots :: Type -> Type

Methods

from :: ListSnapshots -> Rep ListSnapshots x

to :: Rep ListSnapshots x -> ListSnapshots

Read ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Methods

readsPrec :: Int -> ReadS ListSnapshots

readList :: ReadS [ListSnapshots]

readPrec :: ReadPrec ListSnapshots

readListPrec :: ReadPrec [ListSnapshots]

Show ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Methods

showsPrec :: Int -> ListSnapshots -> ShowS

show :: ListSnapshots -> String

showList :: [ListSnapshots] -> ShowS

NFData ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Methods

rnf :: ListSnapshots -> ()

Eq ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Methods

(==) :: ListSnapshots -> ListSnapshots -> Bool

(/=) :: ListSnapshots -> ListSnapshots -> Bool

Hashable ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

Methods

hashWithSalt :: Int -> ListSnapshots -> Int

hash :: ListSnapshots -> Int

type AWSResponse ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

type AWSResponse ListSnapshots = ListSnapshotsResponse

type Rep ListSnapshots

Defined in Amazonka.GamesParks.ListSnapshots

type Rep ListSnapshots = D1 ('MetaData "ListSnapshots" "Amazonka.GamesParks.ListSnapshots" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "ListSnapshots'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "gameName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListSnapshots

Arguments

:: Text

$sel:gameName:ListSnapshots'

-> 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)

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)

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

The name of the game.

Destructuring the Response

data ListSnapshotsResponse

See: newListSnapshotsResponse smart constructor.

Constructors

ListSnapshotsResponse'

Fields

• nextToken :: Maybe Text

  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.

• snapshots :: Maybe [SnapshotSummary]

  A list of snapshot summaries. You can use the returned snapshot IDs in the UpdateSnapshot and GetSnapshot operations.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListSnapshotsResponse

Defined in Amazonka.GamesParks.ListSnapshots

Associated Types

type Rep ListSnapshotsResponse :: Type -> Type

Methods

from :: ListSnapshotsResponse -> Rep ListSnapshotsResponse x

to :: Rep ListSnapshotsResponse x -> ListSnapshotsResponse

Read ListSnapshotsResponse

Defined in Amazonka.GamesParks.ListSnapshots

Methods

readsPrec :: Int -> ReadS ListSnapshotsResponse

readList :: ReadS [ListSnapshotsResponse]

readPrec :: ReadPrec ListSnapshotsResponse

readListPrec :: ReadPrec [ListSnapshotsResponse]

Show ListSnapshotsResponse

Defined in Amazonka.GamesParks.ListSnapshots

Methods

showsPrec :: Int -> ListSnapshotsResponse -> ShowS

show :: ListSnapshotsResponse -> String

showList :: [ListSnapshotsResponse] -> ShowS

NFData ListSnapshotsResponse

Defined in Amazonka.GamesParks.ListSnapshots

Methods

rnf :: ListSnapshotsResponse -> ()

Eq ListSnapshotsResponse

Defined in Amazonka.GamesParks.ListSnapshots

Methods

(==) :: ListSnapshotsResponse -> ListSnapshotsResponse -> Bool

(/=) :: ListSnapshotsResponse -> ListSnapshotsResponse -> Bool

type Rep ListSnapshotsResponse

Defined in Amazonka.GamesParks.ListSnapshots

type Rep ListSnapshotsResponse = D1 ('MetaData "ListSnapshotsResponse" "Amazonka.GamesParks.ListSnapshots" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "ListSnapshotsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "snapshots") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SnapshotSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListSnapshotsResponse

Arguments

:: Int

$sel:httpStatus:ListSnapshotsResponse'

-> ListSnapshotsResponse

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)

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])

A list of snapshot summaries. You can use the returned snapshot IDs in the UpdateSnapshot and GetSnapshot operations.

listSnapshotsResponse_httpStatus :: Lens' ListSnapshotsResponse Int

The response's http status code.