Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Retrieves a set of one or more game sessions and properties. This action can be used in several ways: (1) provide a GameSessionId
to request properties for a specific game session; (2) provide a FleetId
or an AliasId
to request properties for all game sessions running on a fleet. You can also use SearchGameSessions
, which allows you to retrieve all game sessions or filter on certain criteria, but only returns game sessions with a status of ACTIVE. If you need to retrieve the protection policy for each game session, use DescribeGameSessionDetails
.
To get game session record(s), specify just one of the following: game session ID, fleet ID, or alias ID. You can filter this request by game session status. Use the pagination parameters to retrieve results as a set of sequential pages. If successful, a GameSession
object is returned for each session matching the request.
- describeGameSessions :: DescribeGameSessions
- data DescribeGameSessions
- dgsGameSessionId :: Lens' DescribeGameSessions (Maybe Text)
- dgsAliasId :: Lens' DescribeGameSessions (Maybe Text)
- dgsNextToken :: Lens' DescribeGameSessions (Maybe Text)
- dgsStatusFilter :: Lens' DescribeGameSessions (Maybe Text)
- dgsLimit :: Lens' DescribeGameSessions (Maybe Natural)
- dgsFleetId :: Lens' DescribeGameSessions (Maybe Text)
- describeGameSessionsResponse :: Int -> DescribeGameSessionsResponse
- data DescribeGameSessionsResponse
- dgsrsGameSessions :: Lens' DescribeGameSessionsResponse [GameSession]
- dgsrsNextToken :: Lens' DescribeGameSessionsResponse (Maybe Text)
- dgsrsResponseStatus :: Lens' DescribeGameSessionsResponse Int
Creating a Request
describeGameSessions :: DescribeGameSessions Source #
Creates a value of DescribeGameSessions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dgsGameSessionId
- Unique identifier for the game session to retrieve information on. Game session ID format is as follows: "arn:aws:gamelift:region::gamesessionfleet-IDstring". The value of string is either a custom ID string (if one was specified when the game session was created) an autogenerated string.dgsAliasId
- Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.dgsNextToken
- Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.dgsStatusFilter
- Game session status to filter results on. Possible game session statuses includeACTIVE
,TERMINATED
,ACTIVATING
, andTERMINATING
(the last two are transitory).dgsLimit
- Maximum number of results to return. Use this parameter withNextToken
to get results as a set of sequential pages.dgsFleetId
- Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
data DescribeGameSessions Source #
Represents the input for a request action.
See: describeGameSessions
smart constructor.
Request Lenses
dgsAliasId :: Lens' DescribeGameSessions (Maybe Text) Source #
Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.
dgsNextToken :: Lens' DescribeGameSessions (Maybe Text) Source #
Token indicating the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To specify the start of the result set, do not specify a value.
dgsStatusFilter :: Lens' DescribeGameSessions (Maybe Text) Source #
Game session status to filter results on. Possible game session statuses include ACTIVE
, TERMINATED
, ACTIVATING
, and TERMINATING
(the last two are transitory).
dgsLimit :: Lens' DescribeGameSessions (Maybe Natural) Source #
Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
dgsFleetId :: Lens' DescribeGameSessions (Maybe Text) Source #
Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.
Destructuring the Response
describeGameSessionsResponse Source #
Creates a value of DescribeGameSessionsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dgsrsGameSessions
- Collection of objects containing game session properties for each session matching the request.dgsrsNextToken
- Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.dgsrsResponseStatus
- -- | The response status code.
data DescribeGameSessionsResponse Source #
Represents the returned data in response to a request action.
See: describeGameSessionsResponse
smart constructor.
Response Lenses
dgsrsGameSessions :: Lens' DescribeGameSessionsResponse [GameSession] Source #
Collection of objects containing game session properties for each session matching the request.
dgsrsNextToken :: Lens' DescribeGameSessionsResponse (Maybe Text) Source #
Token indicating where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
dgsrsResponseStatus :: Lens' DescribeGameSessionsResponse Int Source #
- - | The response status code.