Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.GameLift.StopGameSessionPlacement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

Game-session-related operations include:

CreateGameSession
DescribeGameSessions
DescribeGameSessionDetails
SearchGameSessions
UpdateGameSession
GetGameSessionLogUrl
Game session placements
StartGameSessionPlacement
DescribeGameSessionPlacement
StopGameSessionPlacement

Creating a Request

stopGameSessionPlacement #

Arguments

:: Text	`sPlacementId`
-> StopGameSessionPlacement

Creates a value of StopGameSessionPlacement with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

sPlacementId - Unique identifier for a game session placement to cancel.

data StopGameSessionPlacement #

Represents the input for a request action.

See: stopGameSessionPlacement smart constructor.

Instances

Eq StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods (==) :: StopGameSessionPlacement -> StopGameSessionPlacement -> Bool # (/=) :: StopGameSessionPlacement -> StopGameSessionPlacement -> Bool #
Data StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StopGameSessionPlacement -> c StopGameSessionPlacement # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StopGameSessionPlacement # toConstr :: StopGameSessionPlacement -> Constr # dataTypeOf :: StopGameSessionPlacement -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StopGameSessionPlacement) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StopGameSessionPlacement) # gmapT :: (forall b. Data b => b -> b) -> StopGameSessionPlacement -> StopGameSessionPlacement # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StopGameSessionPlacement -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StopGameSessionPlacement -> r # gmapQ :: (forall d. Data d => d -> u) -> StopGameSessionPlacement -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StopGameSessionPlacement -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StopGameSessionPlacement -> m StopGameSessionPlacement # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StopGameSessionPlacement -> m StopGameSessionPlacement # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StopGameSessionPlacement -> m StopGameSessionPlacement #
Read StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods readsPrec :: Int -> ReadS StopGameSessionPlacement # readList :: ReadS [StopGameSessionPlacement] # readPrec :: ReadPrec StopGameSessionPlacement # readListPrec :: ReadPrec [StopGameSessionPlacement] #
Show StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods showsPrec :: Int -> StopGameSessionPlacement -> ShowS # show :: StopGameSessionPlacement -> String # showList :: [StopGameSessionPlacement] -> ShowS #
Generic StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Associated Types type Rep StopGameSessionPlacement :: * -> * # Methods from :: StopGameSessionPlacement -> Rep StopGameSessionPlacement x # to :: Rep StopGameSessionPlacement x -> StopGameSessionPlacement #
Hashable StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods hashWithSalt :: Int -> StopGameSessionPlacement -> Int # hash :: StopGameSessionPlacement -> Int #
ToJSON StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods toJSON :: StopGameSessionPlacement -> Value # toEncoding :: StopGameSessionPlacement -> Encoding # toJSONList :: [StopGameSessionPlacement] -> Value # toEncodingList :: [StopGameSessionPlacement] -> Encoding #
AWSRequest StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Associated Types type Rs StopGameSessionPlacement :: * # Methods request :: StopGameSessionPlacement -> Request StopGameSessionPlacement # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy StopGameSessionPlacement -> ClientResponse -> m (Response StopGameSessionPlacement) #
ToHeaders StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods toHeaders :: StopGameSessionPlacement -> [Header] #
ToPath StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods toPath :: StopGameSessionPlacement -> ByteString #
ToQuery StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods toQuery :: StopGameSessionPlacement -> QueryString #
NFData StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods rnf :: StopGameSessionPlacement -> () #
type Rep StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement type Rep StopGameSessionPlacement = D1 (MetaData "StopGameSessionPlacement" "Network.AWS.GameLift.StopGameSessionPlacement" "amazonka-gamelift-1.6.0-7WgXOZKdxV3Gu4LRJZfX7W" True) (C1 (MetaCons "StopGameSessionPlacement'" PrefixI True) (S1 (MetaSel (Just "_sPlacementId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs StopGameSessionPlacement #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement type Rs StopGameSessionPlacement = StopGameSessionPlacementResponse

Request Lenses

sPlacementId :: Lens' StopGameSessionPlacement Text #

Unique identifier for a game session placement to cancel.

Destructuring the Response

stopGameSessionPlacementResponse #

Arguments

:: Int	`storsResponseStatus`
-> StopGameSessionPlacementResponse

Creates a value of StopGameSessionPlacementResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

storsGameSessionPlacement - Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.
storsResponseStatus - -- | The response status code.

data StopGameSessionPlacementResponse #

Represents the returned data in response to a request action.

See: stopGameSessionPlacementResponse smart constructor.

Instances

Eq StopGameSessionPlacementResponse #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods (==) :: StopGameSessionPlacementResponse -> StopGameSessionPlacementResponse -> Bool # (/=) :: StopGameSessionPlacementResponse -> StopGameSessionPlacementResponse -> Bool #
Data StopGameSessionPlacementResponse #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> StopGameSessionPlacementResponse -> c StopGameSessionPlacementResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c StopGameSessionPlacementResponse # toConstr :: StopGameSessionPlacementResponse -> Constr # dataTypeOf :: StopGameSessionPlacementResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c StopGameSessionPlacementResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c StopGameSessionPlacementResponse) # gmapT :: (forall b. Data b => b -> b) -> StopGameSessionPlacementResponse -> StopGameSessionPlacementResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> StopGameSessionPlacementResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> StopGameSessionPlacementResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> StopGameSessionPlacementResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> StopGameSessionPlacementResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> StopGameSessionPlacementResponse -> m StopGameSessionPlacementResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> StopGameSessionPlacementResponse -> m StopGameSessionPlacementResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> StopGameSessionPlacementResponse -> m StopGameSessionPlacementResponse #
Read StopGameSessionPlacementResponse #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods readsPrec :: Int -> ReadS StopGameSessionPlacementResponse # readList :: ReadS [StopGameSessionPlacementResponse] # readPrec :: ReadPrec StopGameSessionPlacementResponse # readListPrec :: ReadPrec [StopGameSessionPlacementResponse] #
Show StopGameSessionPlacementResponse #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods showsPrec :: Int -> StopGameSessionPlacementResponse -> ShowS # show :: StopGameSessionPlacementResponse -> String # showList :: [StopGameSessionPlacementResponse] -> ShowS #
Generic StopGameSessionPlacementResponse #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Associated Types type Rep StopGameSessionPlacementResponse :: * -> * # Methods from :: StopGameSessionPlacementResponse -> Rep StopGameSessionPlacementResponse x # to :: Rep StopGameSessionPlacementResponse x -> StopGameSessionPlacementResponse #
NFData StopGameSessionPlacementResponse #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement Methods rnf :: StopGameSessionPlacementResponse -> () #
type Rep StopGameSessionPlacementResponse #
Instance details Defined in Network.AWS.GameLift.StopGameSessionPlacement type Rep StopGameSessionPlacementResponse = D1 (MetaData "StopGameSessionPlacementResponse" "Network.AWS.GameLift.StopGameSessionPlacement" "amazonka-gamelift-1.6.0-7WgXOZKdxV3Gu4LRJZfX7W" False) (C1 (MetaCons "StopGameSessionPlacementResponse'" PrefixI True) (S1 (MetaSel (Just "_storsGameSessionPlacement") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GameSessionPlacement)) :*: S1 (MetaSel (Just "_storsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

storsGameSessionPlacement :: Lens' StopGameSessionPlacementResponse (Maybe GameSessionPlacement) #

Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.

storsResponseStatus :: Lens' StopGameSessionPlacementResponse Int #

- | The response status code.