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.ListStageDeployments

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a paginated list of stage deployment summaries from the game.

This operation returns paginated results.

Synopsis

data ListStageDeployments = ListStageDeployments' {
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- gameName :: Text
- stageName :: Text
}
newListStageDeployments :: Text -> Text -> ListStageDeployments
listStageDeployments_maxResults :: Lens' ListStageDeployments (Maybe Natural)
listStageDeployments_nextToken :: Lens' ListStageDeployments (Maybe Text)
listStageDeployments_gameName :: Lens' ListStageDeployments Text
listStageDeployments_stageName :: Lens' ListStageDeployments Text
data ListStageDeploymentsResponse = ListStageDeploymentsResponse' {
- nextToken :: Maybe Text
- stageDeployments :: Maybe [StageDeploymentSummary]
- httpStatus :: Int
}
newListStageDeploymentsResponse :: Int -> ListStageDeploymentsResponse
listStageDeploymentsResponse_nextToken :: Lens' ListStageDeploymentsResponse (Maybe Text)
listStageDeploymentsResponse_stageDeployments :: Lens' ListStageDeploymentsResponse (Maybe [StageDeploymentSummary])
listStageDeploymentsResponse_httpStatus :: Lens' ListStageDeploymentsResponse Int

Creating a Request

data ListStageDeployments Source #

See: newListStageDeployments smart constructor.

Constructors

ListStageDeployments'

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.
stageName :: Text
The name of the stage.

Instances

Instances details

ToHeaders ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods toHeaders :: ListStageDeployments -> [Header] #
ToPath ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods toPath :: ListStageDeployments -> ByteString #
ToQuery ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods toQuery :: ListStageDeployments -> QueryString #
AWSPager ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods page :: ListStageDeployments -> AWSResponse ListStageDeployments -> Maybe ListStageDeployments #
AWSRequest ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Associated Types type AWSResponse ListStageDeployments # Methods request :: (Service -> Service) -> ListStageDeployments -> Request ListStageDeployments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListStageDeployments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListStageDeployments))) #
Generic ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Associated Types type Rep ListStageDeployments :: Type -> Type # Methods from :: ListStageDeployments -> Rep ListStageDeployments x # to :: Rep ListStageDeployments x -> ListStageDeployments #
Read ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods readsPrec :: Int -> ReadS ListStageDeployments # readList :: ReadS [ListStageDeployments] # readPrec :: ReadPrec ListStageDeployments # readListPrec :: ReadPrec [ListStageDeployments] #
Show ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods showsPrec :: Int -> ListStageDeployments -> ShowS # show :: ListStageDeployments -> String # showList :: [ListStageDeployments] -> ShowS #
NFData ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods rnf :: ListStageDeployments -> () #
Eq ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods (==) :: ListStageDeployments -> ListStageDeployments -> Bool # (/=) :: ListStageDeployments -> ListStageDeployments -> Bool #
Hashable ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods hashWithSalt :: Int -> ListStageDeployments -> Int # hash :: ListStageDeployments -> Int #
type AWSResponse ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments type AWSResponse ListStageDeployments = ListStageDeploymentsResponse
type Rep ListStageDeployments Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments type Rep ListStageDeployments = D1 ('MetaData "ListStageDeployments" "Amazonka.GamesParks.ListStageDeployments" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "ListStageDeployments'" '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) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newListStageDeployments Source #

Arguments

:: Text	`$sel:gameName:ListStageDeployments'`
-> Text	`$sel:stageName:ListStageDeployments'`
-> ListStageDeployments

Create a value of ListStageDeployments 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:ListStageDeployments', listStageDeployments_maxResults - The maximum number of results to return.

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

ListStageDeployments, listStageDeployments_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:ListStageDeployments', listStageDeployments_gameName - The name of the game.

$sel:stageName:ListStageDeployments', listStageDeployments_stageName - The name of the stage.

Request Lenses

listStageDeployments_maxResults :: Lens' ListStageDeployments (Maybe Natural) Source #

The maximum number of results to return.

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

listStageDeployments_nextToken :: Lens' ListStageDeployments (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.

listStageDeployments_gameName :: Lens' ListStageDeployments Text Source #

The name of the game.

listStageDeployments_stageName :: Lens' ListStageDeployments Text Source #

The name of the stage.

Destructuring the Response

data ListStageDeploymentsResponse Source #

See: newListStageDeploymentsResponse smart constructor.

Constructors

ListStageDeploymentsResponse'

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.
stageDeployments :: Maybe [StageDeploymentSummary]
A list of stage deployment summaries. You can use the deployment IDs in the UpdateStageDeployment and GetStageDeployment actions.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic ListStageDeploymentsResponse Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Associated Types type Rep ListStageDeploymentsResponse :: Type -> Type # Methods from :: ListStageDeploymentsResponse -> Rep ListStageDeploymentsResponse x # to :: Rep ListStageDeploymentsResponse x -> ListStageDeploymentsResponse #
Read ListStageDeploymentsResponse Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods readsPrec :: Int -> ReadS ListStageDeploymentsResponse # readList :: ReadS [ListStageDeploymentsResponse] # readPrec :: ReadPrec ListStageDeploymentsResponse # readListPrec :: ReadPrec [ListStageDeploymentsResponse] #
Show ListStageDeploymentsResponse Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods showsPrec :: Int -> ListStageDeploymentsResponse -> ShowS # show :: ListStageDeploymentsResponse -> String # showList :: [ListStageDeploymentsResponse] -> ShowS #
NFData ListStageDeploymentsResponse Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods rnf :: ListStageDeploymentsResponse -> () #
Eq ListStageDeploymentsResponse Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments Methods (==) :: ListStageDeploymentsResponse -> ListStageDeploymentsResponse -> Bool # (/=) :: ListStageDeploymentsResponse -> ListStageDeploymentsResponse -> Bool #
type Rep ListStageDeploymentsResponse Source #
Instance details Defined in Amazonka.GamesParks.ListStageDeployments type Rep ListStageDeploymentsResponse = D1 ('MetaData "ListStageDeploymentsResponse" "Amazonka.GamesParks.ListStageDeployments" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "ListStageDeploymentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stageDeployments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StageDeploymentSummary])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListStageDeploymentsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListStageDeploymentsResponse'`
-> ListStageDeploymentsResponse

Create a value of ListStageDeploymentsResponse 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:

ListStageDeployments, listStageDeploymentsResponse_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:stageDeployments:ListStageDeploymentsResponse', listStageDeploymentsResponse_stageDeployments - A list of stage deployment summaries. You can use the deployment IDs in the UpdateStageDeployment and GetStageDeployment actions.

$sel:httpStatus:ListStageDeploymentsResponse', listStageDeploymentsResponse_httpStatus - The response's http status code.

Response Lenses

listStageDeploymentsResponse_nextToken :: Lens' ListStageDeploymentsResponse (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.

listStageDeploymentsResponse_stageDeployments :: Lens' ListStageDeploymentsResponse (Maybe [StageDeploymentSummary]) Source #

A list of stage deployment summaries. You can use the deployment IDs in the UpdateStageDeployment and GetStageDeployment actions.

listStageDeploymentsResponse_httpStatus :: Lens' ListStageDeploymentsResponse Int Source #

The response's http status code.