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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deploys a snapshot to the stage and creates a new game runtime.

After you call this operation, you can check the deployment status by using GetStageDeployment.

If there are any players connected to the previous game runtime, then both runtimes persist. Existing connections to the previous runtime are maintained. When players disconnect and reconnect, they connect to the new runtime. After there are no connections to the previous game runtime, it is deleted.

Synopsis

Creating a Request

data StartStageDeployment Source #

See: newStartStageDeployment smart constructor.

Constructors

StartStageDeployment'
Fields clientToken :: Maybe Text A client-defined token. With an active client token in the request, this action is idempotent. gameName :: Text The name of the game. snapshotId :: Text The identifier of the snapshot to deploy. stageName :: Text The name of the stage to deploy the snapshot onto.

Instances

Instances details

ToJSON StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Methods toJSON :: StartStageDeployment -> Value # toEncoding :: StartStageDeployment -> Encoding # toJSONList :: [StartStageDeployment] -> Value # toEncodingList :: [StartStageDeployment] -> Encoding #
ToHeaders StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Methods toHeaders :: StartStageDeployment -> [Header] #
ToPath StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Methods toPath :: StartStageDeployment -> ByteString #
ToQuery StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Methods toQuery :: StartStageDeployment -> QueryString #
AWSRequest StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Associated Types type AWSResponse StartStageDeployment # Methods request :: (Service -> Service) -> StartStageDeployment -> Request StartStageDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartStageDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartStageDeployment))) #
Generic StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Associated Types type Rep StartStageDeployment :: Type -> Type # Methods from :: StartStageDeployment -> Rep StartStageDeployment x # to :: Rep StartStageDeployment x -> StartStageDeployment #
Read StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Methods readsPrec :: Int -> ReadS StartStageDeployment # readList :: ReadS [StartStageDeployment] # readPrec :: ReadPrec StartStageDeployment # readListPrec :: ReadPrec [StartStageDeployment] #
Show StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Methods showsPrec :: Int -> StartStageDeployment -> ShowS # show :: StartStageDeployment -> String # showList :: [StartStageDeployment] -> ShowS #
NFData StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Methods rnf :: StartStageDeployment -> () #
Eq StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Methods (==) :: StartStageDeployment -> StartStageDeployment -> Bool # (/=) :: StartStageDeployment -> StartStageDeployment -> Bool #
Hashable StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment Methods hashWithSalt :: Int -> StartStageDeployment -> Int # hash :: StartStageDeployment -> Int #
type AWSResponse StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment type AWSResponse StartStageDeployment = StartStageDeploymentResponse
type Rep StartStageDeployment Source #
Instance details Defined in Amazonka.GamesParks.StartStageDeployment type Rep StartStageDeployment = D1 ('MetaData "StartStageDeployment" "Amazonka.GamesParks.StartStageDeployment" "amazonka-gamesparks-2.0-Lk18zLarGCU67rMOwLlDG5" 'False) (C1 ('MetaCons "StartStageDeployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gameName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "snapshotId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newStartStageDeployment Source #

Arguments

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

Create a value of StartStageDeployment 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:clientToken:StartStageDeployment', startStageDeployment_clientToken - A client-defined token. With an active client token in the request, this action is idempotent.

$sel:gameName:StartStageDeployment', startStageDeployment_gameName - The name of the game.

StartStageDeployment, startStageDeployment_snapshotId - The identifier of the snapshot to deploy.

$sel:stageName:StartStageDeployment', startStageDeployment_stageName - The name of the stage to deploy the snapshot onto.

Request Lenses

startStageDeployment_clientToken :: Lens' StartStageDeployment (Maybe Text) Source #

A client-defined token. With an active client token in the request, this action is idempotent.

startStageDeployment_gameName :: Lens' StartStageDeployment Text Source #

The name of the game.

startStageDeployment_snapshotId :: Lens' StartStageDeployment Text Source #

The identifier of the snapshot to deploy.

startStageDeployment_stageName :: Lens' StartStageDeployment Text Source #

The name of the stage to deploy the snapshot onto.

Destructuring the Response

data StartStageDeploymentResponse Source #

See: newStartStageDeploymentResponse smart constructor.

Constructors

StartStageDeploymentResponse'
Fields stageDeployment :: Maybe StageDeploymentDetails Properties that describe the stage deployment. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartStageDeploymentResponse Source #

Arguments

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

Create a value of StartStageDeploymentResponse 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:stageDeployment:StartStageDeploymentResponse', startStageDeploymentResponse_stageDeployment - Properties that describe the stage deployment.

$sel:httpStatus:StartStageDeploymentResponse', startStageDeploymentResponse_httpStatus - The response's http status code.

Response Lenses

startStageDeploymentResponse_stageDeployment :: Lens' StartStageDeploymentResponse (Maybe StageDeploymentDetails) Source #

Properties that describe the stage deployment.

startStageDeploymentResponse_httpStatus :: Lens' StartStageDeploymentResponse Int Source #

The response's http status code.