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 |
Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session.
You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking
.
To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.
Matchmaking-related operations include:
StartMatchmaking
DescribeMatchmaking
StopMatchmaking
AcceptMatch
StartMatchBackfill
Synopsis
- describeMatchmaking :: DescribeMatchmaking
- data DescribeMatchmaking
- dmTicketIds :: Lens' DescribeMatchmaking [Text]
- describeMatchmakingResponse :: Int -> DescribeMatchmakingResponse
- data DescribeMatchmakingResponse
- dmrsTicketList :: Lens' DescribeMatchmakingResponse [MatchmakingTicket]
- dmrsResponseStatus :: Lens' DescribeMatchmakingResponse Int
Creating a Request
describeMatchmaking :: DescribeMatchmaking Source #
Creates a value of DescribeMatchmaking
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dmTicketIds
- Unique identifier for a matchmaking ticket. You can include up to 10 ID values.
data DescribeMatchmaking Source #
Represents the input for a request action.
See: describeMatchmaking
smart constructor.
Instances
Request Lenses
dmTicketIds :: Lens' DescribeMatchmaking [Text] Source #
Unique identifier for a matchmaking ticket. You can include up to 10 ID values.
Destructuring the Response
describeMatchmakingResponse Source #
Creates a value of DescribeMatchmakingResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dmrsTicketList
- Collection of existing matchmaking ticket objects matching the request.dmrsResponseStatus
- -- | The response status code.
data DescribeMatchmakingResponse Source #
Represents the returned data in response to a request action.
See: describeMatchmakingResponse
smart constructor.
Instances
Response Lenses
dmrsTicketList :: Lens' DescribeMatchmakingResponse [MatchmakingTicket] Source #
Collection of existing matchmaking ticket objects matching the request.
dmrsResponseStatus :: Lens' DescribeMatchmakingResponse Int Source #
- - | The response status code.