amazonka-gamesparks-2.0: Amazon GameSparks SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GamesParks.ListStages

Description

Gets a paginated list of stage summaries from the game.

This operation returns paginated results.

Synopsis

Creating a Request

data ListStages Source #

See: newListStages smart constructor.

Constructors

ListStages' 

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

Instances details
ToHeaders ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

Methods

toHeaders :: ListStages -> [Header] #

ToPath ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

ToQuery ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

AWSPager ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

AWSRequest ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

Associated Types

type AWSResponse ListStages #

Generic ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

Associated Types

type Rep ListStages :: Type -> Type #

Read ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

Show ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

NFData ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

Methods

rnf :: ListStages -> () #

Eq ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

Hashable ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

type AWSResponse ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

type Rep ListStages Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

type Rep ListStages = D1 ('MetaData "ListStages" "Amazonka.GamesParks.ListStages" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "ListStages'" '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))))

newListStages Source #

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.

Destructuring the Response

data ListStagesResponse Source #

See: newListStagesResponse smart constructor.

Constructors

ListStagesResponse' 

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.

  • stages :: Maybe [StageSummary]

    A list of stage summaries. You can use the stage names in the UpdateStage and GetStage actions.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListStagesResponse Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

Associated Types

type Rep ListStagesResponse :: Type -> Type #

Read ListStagesResponse Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

Show ListStagesResponse Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

NFData ListStagesResponse Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

Methods

rnf :: ListStagesResponse -> () #

Eq ListStagesResponse Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

type Rep ListStagesResponse Source # 
Instance details

Defined in Amazonka.GamesParks.ListStages

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

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.