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 additional game session properties, including the game session protection policy in force, 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 details for 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 details from the fleet's home Region and all remote locations.
- To retrieve details for 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 details for 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 GameSessionDetail
object is returned for each game
session that matches the request.
Learn more
This operation returns paginated results.
Synopsis
- data DescribeGameSessionDetails = DescribeGameSessionDetails' {}
- newDescribeGameSessionDetails :: DescribeGameSessionDetails
- describeGameSessionDetails_aliasId :: Lens' DescribeGameSessionDetails (Maybe Text)
- describeGameSessionDetails_fleetId :: Lens' DescribeGameSessionDetails (Maybe Text)
- describeGameSessionDetails_gameSessionId :: Lens' DescribeGameSessionDetails (Maybe Text)
- describeGameSessionDetails_limit :: Lens' DescribeGameSessionDetails (Maybe Natural)
- describeGameSessionDetails_location :: Lens' DescribeGameSessionDetails (Maybe Text)
- describeGameSessionDetails_nextToken :: Lens' DescribeGameSessionDetails (Maybe Text)
- describeGameSessionDetails_statusFilter :: Lens' DescribeGameSessionDetails (Maybe Text)
- data DescribeGameSessionDetailsResponse = DescribeGameSessionDetailsResponse' {}
- newDescribeGameSessionDetailsResponse :: Int -> DescribeGameSessionDetailsResponse
- describeGameSessionDetailsResponse_gameSessionDetails :: Lens' DescribeGameSessionDetailsResponse (Maybe [GameSessionDetail])
- describeGameSessionDetailsResponse_nextToken :: Lens' DescribeGameSessionDetailsResponse (Maybe Text)
- describeGameSessionDetailsResponse_httpStatus :: Lens' DescribeGameSessionDetailsResponse Int
Creating a Request
data DescribeGameSessionDetails Source #
See: newDescribeGameSessionDetails
smart constructor.
DescribeGameSessionDetails' | |
|
Instances
newDescribeGameSessionDetails :: DescribeGameSessionDetails Source #
Create a value of DescribeGameSessionDetails
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:
DescribeGameSessionDetails
, describeGameSessionDetails_aliasId
- A unique identifier for the alias associated with the fleet to retrieve
all game sessions for. You can use either the alias ID or ARN value.
DescribeGameSessionDetails
, describeGameSessionDetails_fleetId
- A unique identifier for the fleet to retrieve all game sessions active
on the fleet. You can use either the fleet ID or ARN value.
DescribeGameSessionDetails
, describeGameSessionDetails_gameSessionId
- A unique identifier for the game session to retrieve.
$sel:limit:DescribeGameSessionDetails'
, describeGameSessionDetails_limit
- The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
DescribeGameSessionDetails
, describeGameSessionDetails_location
- A fleet location to get game session details 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
.
DescribeGameSessionDetails
, describeGameSessionDetails_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:DescribeGameSessionDetails'
, describeGameSessionDetails_statusFilter
- Game session status to filter results on. Possible game session statuses
include ACTIVE
, TERMINATED
, ACTIVATING
and TERMINATING
(the last
two are transitory).
Request Lenses
describeGameSessionDetails_aliasId :: Lens' DescribeGameSessionDetails (Maybe Text) Source #
A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.
describeGameSessionDetails_fleetId :: Lens' DescribeGameSessionDetails (Maybe Text) Source #
A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.
describeGameSessionDetails_gameSessionId :: Lens' DescribeGameSessionDetails (Maybe Text) Source #
A unique identifier for the game session to retrieve.
describeGameSessionDetails_limit :: Lens' DescribeGameSessionDetails (Maybe Natural) Source #
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages.
describeGameSessionDetails_location :: Lens' DescribeGameSessionDetails (Maybe Text) Source #
A fleet location to get game session details 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
.
describeGameSessionDetails_nextToken :: Lens' DescribeGameSessionDetails (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.
describeGameSessionDetails_statusFilter :: Lens' DescribeGameSessionDetails (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).
Destructuring the Response
data DescribeGameSessionDetailsResponse Source #
See: newDescribeGameSessionDetailsResponse
smart constructor.
DescribeGameSessionDetailsResponse' | |
|
Instances
newDescribeGameSessionDetailsResponse Source #
Create a value of DescribeGameSessionDetailsResponse
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:gameSessionDetails:DescribeGameSessionDetailsResponse'
, describeGameSessionDetailsResponse_gameSessionDetails
- A collection of properties for each game session that matches the
request.
DescribeGameSessionDetails
, describeGameSessionDetailsResponse_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:DescribeGameSessionDetailsResponse'
, describeGameSessionDetailsResponse_httpStatus
- The response's http status code.
Response Lenses
describeGameSessionDetailsResponse_gameSessionDetails :: Lens' DescribeGameSessionDetailsResponse (Maybe [GameSessionDetail]) Source #
A collection of properties for each game session that matches the request.
describeGameSessionDetailsResponse_nextToken :: Lens' DescribeGameSessionDetailsResponse (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.
describeGameSessionDetailsResponse_httpStatus :: Lens' DescribeGameSessionDetailsResponse Int Source #
The response's http status code.