Network.AWS.GameLift.DescribeGameSessionDetails

Retrieves properties, including the protection policy in force, for one or more game sessions. This action can be used in several ways: (1) provide a GameSessionId to request details for a specific game session; (2) provide either a FleetId or an AliasId to request properties for all game sessions running on a fleet.

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 GameSessionDetail object is returned for each session matching the request.

Creating a Request

describeGameSessionDetails :: DescribeGameSessionDetails

Creates a value of DescribeGameSessionDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dgsdGameSessionId
• dgsdAliasId
• dgsdNextToken
• dgsdStatusFilter
• dgsdLimit
• dgsdFleetId

data DescribeGameSessionDetails

Represents the input for a request action.

See: describeGameSessionDetails smart constructor.

Instances

Eq DescribeGameSessionDetails

Data DescribeGameSessionDetails

Read DescribeGameSessionDetails

Show DescribeGameSessionDetails

Generic DescribeGameSessionDetails

ToJSON DescribeGameSessionDetails

Hashable DescribeGameSessionDetails

AWSRequest DescribeGameSessionDetails

ToPath DescribeGameSessionDetails

ToHeaders DescribeGameSessionDetails

ToQuery DescribeGameSessionDetails

type Rep DescribeGameSessionDetails

type Rs DescribeGameSessionDetails = DescribeGameSessionDetailsResponse

Request Lenses

dgsdGameSessionId :: Lens' DescribeGameSessionDetails (Maybe Text)

Unique identifier for a game session. Specify the game session to retrieve information on.

dgsdAliasId :: Lens' DescribeGameSessionDetails (Maybe Text)

Unique identifier for a fleet alias. Specify an alias to retrieve information on all game sessions active on the fleet.

dgsdNextToken :: Lens' DescribeGameSessionDetails (Maybe Text)

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.

dgsdStatusFilter :: Lens' DescribeGameSessionDetails (Maybe Text)

Game session status to filter results on. Possible game session states include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

dgsdLimit :: Lens' DescribeGameSessionDetails (Maybe Natural)

Maximum number of results to return. You can use this parameter with NextToken to get results as a set of sequential pages.

dgsdFleetId :: Lens' DescribeGameSessionDetails (Maybe Text)

Unique identifier for a fleet. Specify a fleet to retrieve information on all game sessions active on the fleet.

Destructuring the Response

describeGameSessionDetailsResponse

Arguments

:: Int

dgsdrsResponseStatus

-> DescribeGameSessionDetailsResponse

Creates a value of DescribeGameSessionDetailsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• dgsdrsGameSessionDetails
• dgsdrsNextToken
• dgsdrsResponseStatus

data DescribeGameSessionDetailsResponse

Represents the returned data in response to a request action.

See: describeGameSessionDetailsResponse smart constructor.

Instances

Eq DescribeGameSessionDetailsResponse

Data DescribeGameSessionDetailsResponse

Read DescribeGameSessionDetailsResponse

Show DescribeGameSessionDetailsResponse

Generic DescribeGameSessionDetailsResponse

type Rep DescribeGameSessionDetailsResponse

Response Lenses

dgsdrsGameSessionDetails :: Lens' DescribeGameSessionDetailsResponse [GameSessionDetail]

Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.

dgsdrsNextToken :: Lens' DescribeGameSessionDetailsResponse (Maybe Text)

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.

If a request has a limit that exactly matches the number of remaining results, a token is returned even though there are no more results to retrieve.

dgsdrsResponseStatus :: Lens' DescribeGameSessionDetailsResponse Int

The response status code.