| Copyright | (c) 2013-2021 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 |
Amazonka.GameLift.DescribeMatchmaking
Description
Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including--after a successful match is made--connection information for the resulting new game session.
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.
This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service (SNS) to receive notifications, and provide the topic ARN in the matchmaking configuration. Continuously poling ticket status with DescribeMatchmaking should only be used for games in development with low matchmaking usage.
Learn more
Add FlexMatch to a game client
Set Up FlexMatch event notification
Related actions
StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task
Synopsis
- data DescribeMatchmaking = DescribeMatchmaking' {}
- newDescribeMatchmaking :: DescribeMatchmaking
- describeMatchmaking_ticketIds :: Lens' DescribeMatchmaking [Text]
- data DescribeMatchmakingResponse = DescribeMatchmakingResponse' {}
- newDescribeMatchmakingResponse :: Int -> DescribeMatchmakingResponse
- describeMatchmakingResponse_ticketList :: Lens' DescribeMatchmakingResponse (Maybe [MatchmakingTicket])
- describeMatchmakingResponse_httpStatus :: Lens' DescribeMatchmakingResponse Int
Creating a Request
data DescribeMatchmaking Source #
Represents the input for a request operation.
See: newDescribeMatchmaking smart constructor.
Constructors
| DescribeMatchmaking' | |
Instances
newDescribeMatchmaking :: DescribeMatchmaking Source #
Create a value of DescribeMatchmaking 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:ticketIds:DescribeMatchmaking', describeMatchmaking_ticketIds - A unique identifier for a matchmaking ticket. You can include up to 10
ID values.
Request Lenses
describeMatchmaking_ticketIds :: Lens' DescribeMatchmaking [Text] Source #
A unique identifier for a matchmaking ticket. You can include up to 10 ID values.
Destructuring the Response
data DescribeMatchmakingResponse Source #
Represents the returned data in response to a request operation.
See: newDescribeMatchmakingResponse smart constructor.
Constructors
| DescribeMatchmakingResponse' | |
Fields
| |
Instances
newDescribeMatchmakingResponse Source #
Create a value of DescribeMatchmakingResponse 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:ticketList:DescribeMatchmakingResponse', describeMatchmakingResponse_ticketList - A collection of existing matchmaking ticket objects matching the
request.
$sel:httpStatus:DescribeMatchmakingResponse', describeMatchmakingResponse_httpStatus - The response's http status code.
Response Lenses
describeMatchmakingResponse_ticketList :: Lens' DescribeMatchmakingResponse (Maybe [MatchmakingTicket]) Source #
A collection of existing matchmaking ticket objects matching the request.
describeMatchmakingResponse_httpStatus :: Lens' DescribeMatchmakingResponse Int Source #
The response's http status code.