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 |
Retrieves a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.
This operation can be used in the following ways:
- To retrieve all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns all game sessions in the fleet's home Region and all remote locations.
- To retrieve all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
- To retrieve a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSession
object is returned for each game session
that matches the request.
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 an Amazon Simple
Notification Service (SNS) topic to receive notifications from FlexMatch
or queues. Continuously polling with DescribeGameSessions
should only
be used for games in development with low game session usage.
Available in Amazon GameLift Local.
Learn more
This operation returns paginated results.
Synopsis
- data DescribeGameSessions = DescribeGameSessions' {}
- newDescribeGameSessions :: DescribeGameSessions
- describeGameSessions_aliasId :: Lens' DescribeGameSessions (Maybe Text)
- describeGameSessions_fleetId :: Lens' DescribeGameSessions (Maybe Text)
- describeGameSessions_gameSessionId :: Lens' DescribeGameSessions (Maybe Text)
- describeGameSessions_limit :: Lens' DescribeGameSessions (Maybe Natural)
- describeGameSessions_location :: Lens' DescribeGameSessions (Maybe Text)
- describeGameSessions_nextToken :: Lens' DescribeGameSessions (Maybe Text)
- describeGameSessions_statusFilter :: Lens' DescribeGameSessions (Maybe Text)
- data DescribeGameSessionsResponse = DescribeGameSessionsResponse' {
- gameSessions :: Maybe [GameSession]
- nextToken :: Maybe Text
- httpStatus :: Int
- newDescribeGameSessionsResponse :: Int -> DescribeGameSessionsResponse
- describeGameSessionsResponse_gameSessions :: Lens' DescribeGameSessionsResponse (Maybe [GameSession])
- describeGameSessionsResponse_nextToken :: Lens' DescribeGameSessionsResponse (Maybe Text)
- describeGameSessionsResponse_httpStatus :: Lens' DescribeGameSessionsResponse Int
Creating a Request
data DescribeGameSessions Source #
See: newDescribeGameSessions
smart constructor.
DescribeGameSessions' | |
|
Instances
newDescribeGameSessions :: DescribeGameSessions Source #
Create a value of DescribeGameSessions
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:
DescribeGameSessions
, describeGameSessions_aliasId
- A unique identifier for the alias associated with the fleet to retrieve
game sessions for. You can use either the alias ID or ARN value.
DescribeGameSessions
, describeGameSessions_fleetId
- A unique identifier for the fleet to retrieve game sessions for. You can
use either the fleet ID or ARN value.
DescribeGameSessions
, describeGameSessions_gameSessionId
- A unique identifier for the game session to retrieve.
$sel:limit:DescribeGameSessions'
, describeGameSessions_limit
- The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
DescribeGameSessions
, describeGameSessions_location
- A fleet location to get game sessions for. You can specify a fleet's
home Region or a remote location. Use the Amazon Web Services Region
code format, such as us-west-2
.
DescribeGameSessions
, describeGameSessions_nextToken
- A token that indicates the start of the next sequential page of results.
Use the token that is returned with a previous call to this operation.
To start at the beginning of the result set, do not specify a value.
$sel:statusFilter:DescribeGameSessions'
, describeGameSessions_statusFilter
- Game session status to filter results on. You can filter on the
following states: ACTIVE
, TERMINATED
, ACTIVATING
, and
TERMINATING
. The last two are transitory and used for only very brief
periods of time.
Request Lenses
describeGameSessions_aliasId :: Lens' DescribeGameSessions (Maybe Text) Source #
A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.
describeGameSessions_fleetId :: Lens' DescribeGameSessions (Maybe Text) Source #
A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.
describeGameSessions_gameSessionId :: Lens' DescribeGameSessions (Maybe Text) Source #
A unique identifier for the game session to retrieve.
describeGameSessions_limit :: Lens' DescribeGameSessions (Maybe Natural) Source #
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
describeGameSessions_location :: Lens' DescribeGameSessions (Maybe Text) Source #
A fleet location to get game sessions for. You can specify a fleet's
home Region or a remote location. Use the Amazon Web Services Region
code format, such as us-west-2
.
describeGameSessions_nextToken :: Lens' DescribeGameSessions (Maybe Text) Source #
A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.
describeGameSessions_statusFilter :: Lens' DescribeGameSessions (Maybe Text) Source #
Game session status to filter results on. You can filter on the
following states: ACTIVE
, TERMINATED
, ACTIVATING
, and
TERMINATING
. The last two are transitory and used for only very brief
periods of time.
Destructuring the Response
data DescribeGameSessionsResponse Source #
See: newDescribeGameSessionsResponse
smart constructor.
DescribeGameSessionsResponse' | |
|
Instances
newDescribeGameSessionsResponse Source #
Create a value of DescribeGameSessionsResponse
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:gameSessions:DescribeGameSessionsResponse'
, describeGameSessionsResponse_gameSessions
- A collection of properties for each game session that matches the
request.
DescribeGameSessions
, describeGameSessionsResponse_nextToken
- A token that indicates where to resume retrieving results on the next
call to this operation. If no token is returned, these results represent
the end of the list.
$sel:httpStatus:DescribeGameSessionsResponse'
, describeGameSessionsResponse_httpStatus
- The response's http status code.
Response Lenses
describeGameSessionsResponse_gameSessions :: Lens' DescribeGameSessionsResponse (Maybe [GameSession]) Source #
A collection of properties for each game session that matches the request.
describeGameSessionsResponse_nextToken :: Lens' DescribeGameSessionsResponse (Maybe Text) Source #
A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.
describeGameSessionsResponse_httpStatus :: Lens' DescribeGameSessionsResponse Int Source #
The response's http status code.