Network.AWS.GameLift.DescribeGameSessions

Retrieves properties for one or more game sessions. 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.

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.

Creating a Request

describeGameSessions :: DescribeGameSessions

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
• dgsAliasId
• dgsNextToken
• dgsStatusFilter
• dgsLimit
• dgsFleetId

data DescribeGameSessions

Represents the input for a request action.

See: describeGameSessions smart constructor.

Instances

Eq DescribeGameSessions

Data DescribeGameSessions

Read DescribeGameSessions

Show DescribeGameSessions

Generic DescribeGameSessions

ToJSON DescribeGameSessions

Hashable DescribeGameSessions

AWSRequest DescribeGameSessions

ToPath DescribeGameSessions

ToHeaders DescribeGameSessions

ToQuery DescribeGameSessions

type Rep DescribeGameSessions

type Rs DescribeGameSessions = DescribeGameSessionsResponse

Request Lenses

dgsGameSessionId :: Lens' DescribeGameSessions (Maybe Text)

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

dgsAliasId :: Lens' DescribeGameSessions (Maybe Text)

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)

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)

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

dgsLimit :: Lens' DescribeGameSessions (Maybe Natural)

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

dgsFleetId :: Lens' DescribeGameSessions (Maybe Text)

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

Destructuring the Response

describeGameSessionsResponse

Arguments

:: Int

dgsrsResponseStatus

-> DescribeGameSessionsResponse

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
• dgsrsNextToken
• dgsrsResponseStatus

data DescribeGameSessionsResponse

Represents the returned data in response to a request action.

See: describeGameSessionsResponse smart constructor.

Instances

Eq DescribeGameSessionsResponse

Data DescribeGameSessionsResponse

Read DescribeGameSessionsResponse

Show DescribeGameSessionsResponse

Generic DescribeGameSessionsResponse

type Rep DescribeGameSessionsResponse

Response Lenses

dgsrsGameSessions :: Lens' DescribeGameSessionsResponse [GameSession]

Collection of objects containing game session properties for each session matching the request.

dgsrsNextToken :: Lens' DescribeGameSessionsResponse (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.

dgsrsResponseStatus :: Lens' DescribeGameSessionsResponse Int

The response status code.