| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.GameLift.DescribeGameSessionPlacement
Description
Retrieves information, including current status, about a game session placement request.
To get game session placement details, specify the placement ID.
This operation is not designed to be continually called to track game
session status. This practice can cause you to exceed your API limit,
which results in errors. Instead, you must configure configure an Amazon
Simple Notification Service (SNS) topic to receive notifications from
FlexMatch or queues. Continuously polling with
DescribeGameSessionPlacement should only be used for games in
development with low game session usage.
Synopsis
- data DescribeGameSessionPlacement = DescribeGameSessionPlacement' {
- placementId :: Text
- newDescribeGameSessionPlacement :: Text -> DescribeGameSessionPlacement
- describeGameSessionPlacement_placementId :: Lens' DescribeGameSessionPlacement Text
- data DescribeGameSessionPlacementResponse = DescribeGameSessionPlacementResponse' {}
- newDescribeGameSessionPlacementResponse :: Int -> DescribeGameSessionPlacementResponse
- describeGameSessionPlacementResponse_gameSessionPlacement :: Lens' DescribeGameSessionPlacementResponse (Maybe GameSessionPlacement)
- describeGameSessionPlacementResponse_httpStatus :: Lens' DescribeGameSessionPlacementResponse Int
Creating a Request
data DescribeGameSessionPlacement Source #
See: newDescribeGameSessionPlacement smart constructor.
Constructors
| DescribeGameSessionPlacement' | |
Fields
| |
Instances
newDescribeGameSessionPlacement Source #
Arguments
| :: Text | |
| -> DescribeGameSessionPlacement |
Create a value of DescribeGameSessionPlacement 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:
DescribeGameSessionPlacement, describeGameSessionPlacement_placementId - A unique identifier for a game session placement to retrieve.
Request Lenses
describeGameSessionPlacement_placementId :: Lens' DescribeGameSessionPlacement Text Source #
A unique identifier for a game session placement to retrieve.
Destructuring the Response
data DescribeGameSessionPlacementResponse Source #
See: newDescribeGameSessionPlacementResponse smart constructor.
Constructors
| DescribeGameSessionPlacementResponse' | |
Fields
| |
Instances
newDescribeGameSessionPlacementResponse Source #
Arguments
| :: Int | |
| -> DescribeGameSessionPlacementResponse |
Create a value of DescribeGameSessionPlacementResponse 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:gameSessionPlacement:DescribeGameSessionPlacementResponse', describeGameSessionPlacementResponse_gameSessionPlacement - Object that describes the requested game session placement.
$sel:httpStatus:DescribeGameSessionPlacementResponse', describeGameSessionPlacementResponse_httpStatus - The response's http status code.
Response Lenses
describeGameSessionPlacementResponse_gameSessionPlacement :: Lens' DescribeGameSessionPlacementResponse (Maybe GameSessionPlacement) Source #
Object that describes the requested game session placement.
describeGameSessionPlacementResponse_httpStatus :: Lens' DescribeGameSessionPlacementResponse Int Source #
The response's http status code.