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 |
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
Synopsis
- stopGameSessionPlacement :: Text -> StopGameSessionPlacement
- data StopGameSessionPlacement
- sPlacementId :: Lens' StopGameSessionPlacement Text
- stopGameSessionPlacementResponse :: Int -> StopGameSessionPlacementResponse
- data StopGameSessionPlacementResponse
- storsGameSessionPlacement :: Lens' StopGameSessionPlacementResponse (Maybe GameSessionPlacement)
- storsResponseStatus :: Lens' StopGameSessionPlacementResponse Int
Creating a Request
stopGameSessionPlacement Source #
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 Source #
Represents the input for a request action.
See: stopGameSessionPlacement
smart constructor.
Instances
Request Lenses
sPlacementId :: Lens' StopGameSessionPlacement Text Source #
Unique identifier for a game session placement to cancel.
Destructuring the Response
stopGameSessionPlacementResponse Source #
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, withCANCELLED
status and an end time stamp.storsResponseStatus
- -- | The response status code.
data StopGameSessionPlacementResponse Source #
Represents the returned data in response to a request action.
See: stopGameSessionPlacementResponse
smart constructor.
Instances
Response Lenses
storsGameSessionPlacement :: Lens' StopGameSessionPlacementResponse (Maybe GameSessionPlacement) Source #
Object that describes the canceled game session placement, with CANCELLED
status and an end time stamp.
storsResponseStatus :: Lens' StopGameSessionPlacementResponse Int Source #
- - | The response status code.