| 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.DescribeGameSessionPlacement
Description
Retrieves information, including current status, about a game session placement request.
To get game session placement details, specify the placement ID.
If successful, a GameSessionPlacement object is returned.
Related actions
CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task
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 #
Represents the input for a request operation.
See: newDescribeGameSessionPlacement smart constructor.
Constructors
| DescribeGameSessionPlacement' | |
Fields
| |
Instances
newDescribeGameSessionPlacement Source #
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:
$sel:placementId: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 #
Represents the returned data in response to a request operation.
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.