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.StopMatchmaking
Description
Cancels a matchmaking ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED
.
Matchmaking-related operations include:
StartMatchmaking
DescribeMatchmaking
StopMatchmaking
AcceptMatch
StartMatchBackfill
Creating a Request
Arguments
:: Text | |
-> StopMatchmaking |
Creates a value of StopMatchmaking
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smTicketId
- Unique identifier for a matchmaking ticket.
data StopMatchmaking #
Represents the input for a request action.
See: stopMatchmaking
smart constructor.
Instances
Request Lenses
smTicketId :: Lens' StopMatchmaking Text #
Unique identifier for a matchmaking ticket.
Destructuring the Response
Arguments
:: Int | |
-> StopMatchmakingResponse |
Creates a value of StopMatchmakingResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smrsResponseStatus
- -- | The response status code.
data StopMatchmakingResponse #
See: stopMatchmakingResponse
smart constructor.
Response Lenses
smrsResponseStatus :: Lens' StopMatchmakingResponse Int #
- - | The response status code.