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

Amazonka.GameLift.DescribeGameSessions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Find a game session

All APIs by task

This operation returns paginated results.

Synopsis

data DescribeGameSessions = DescribeGameSessions' {
- aliasId :: Maybe Text
- fleetId :: Maybe Text
- gameSessionId :: Maybe Text
- limit :: Maybe Natural
- location :: Maybe Text
- nextToken :: Maybe Text
- statusFilter :: Maybe Text
}
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.

Constructors

DescribeGameSessions'

Fields

aliasId :: Maybe Text
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.
fleetId :: Maybe Text
A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.
gameSessionId :: Maybe Text
A unique identifier for the game session to retrieve.
limit :: Maybe Natural
The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
location :: Maybe Text
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.
nextToken :: Maybe Text
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.
statusFilter :: Maybe Text
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.

Instances

Instances details

ToJSON DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods toJSON :: DescribeGameSessions -> Value # toEncoding :: DescribeGameSessions -> Encoding # toJSONList :: [DescribeGameSessions] -> Value # toEncodingList :: [DescribeGameSessions] -> Encoding #
ToHeaders DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods toHeaders :: DescribeGameSessions -> [Header] #
ToPath DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods toPath :: DescribeGameSessions -> ByteString #
ToQuery DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods toQuery :: DescribeGameSessions -> QueryString #
AWSPager DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods page :: DescribeGameSessions -> AWSResponse DescribeGameSessions -> Maybe DescribeGameSessions #
AWSRequest DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Associated Types type AWSResponse DescribeGameSessions # Methods request :: (Service -> Service) -> DescribeGameSessions -> Request DescribeGameSessions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeGameSessions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeGameSessions))) #
Generic DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Associated Types type Rep DescribeGameSessions :: Type -> Type # Methods from :: DescribeGameSessions -> Rep DescribeGameSessions x # to :: Rep DescribeGameSessions x -> DescribeGameSessions #
Read DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods readsPrec :: Int -> ReadS DescribeGameSessions # readList :: ReadS [DescribeGameSessions] # readPrec :: ReadPrec DescribeGameSessions # readListPrec :: ReadPrec [DescribeGameSessions] #
Show DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods showsPrec :: Int -> DescribeGameSessions -> ShowS # show :: DescribeGameSessions -> String # showList :: [DescribeGameSessions] -> ShowS #
NFData DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods rnf :: DescribeGameSessions -> () #
Eq DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods (==) :: DescribeGameSessions -> DescribeGameSessions -> Bool # (/=) :: DescribeGameSessions -> DescribeGameSessions -> Bool #
Hashable DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods hashWithSalt :: Int -> DescribeGameSessions -> Int # hash :: DescribeGameSessions -> Int #
type AWSResponse DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions type AWSResponse DescribeGameSessions = DescribeGameSessionsResponse
type Rep DescribeGameSessions Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions type Rep DescribeGameSessions = D1 ('MetaData "DescribeGameSessions" "Amazonka.GameLift.DescribeGameSessions" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeGameSessions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aliasId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "fleetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "gameSessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

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.

Constructors

DescribeGameSessionsResponse'
Fields gameSessions :: Maybe [GameSession] A collection of properties for each game session that matches the request. nextToken :: Maybe Text 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. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeGameSessionsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Associated Types type Rep DescribeGameSessionsResponse :: Type -> Type # Methods from :: DescribeGameSessionsResponse -> Rep DescribeGameSessionsResponse x # to :: Rep DescribeGameSessionsResponse x -> DescribeGameSessionsResponse #
Read DescribeGameSessionsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods readsPrec :: Int -> ReadS DescribeGameSessionsResponse # readList :: ReadS [DescribeGameSessionsResponse] # readPrec :: ReadPrec DescribeGameSessionsResponse # readListPrec :: ReadPrec [DescribeGameSessionsResponse] #
Show DescribeGameSessionsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods showsPrec :: Int -> DescribeGameSessionsResponse -> ShowS # show :: DescribeGameSessionsResponse -> String # showList :: [DescribeGameSessionsResponse] -> ShowS #
NFData DescribeGameSessionsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods rnf :: DescribeGameSessionsResponse -> () #
Eq DescribeGameSessionsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions Methods (==) :: DescribeGameSessionsResponse -> DescribeGameSessionsResponse -> Bool # (/=) :: DescribeGameSessionsResponse -> DescribeGameSessionsResponse -> Bool #
type Rep DescribeGameSessionsResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeGameSessions type Rep DescribeGameSessionsResponse = D1 ('MetaData "DescribeGameSessionsResponse" "Amazonka.GameLift.DescribeGameSessions" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeGameSessionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameSessions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GameSession])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeGameSessionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeGameSessionsResponse'`
-> DescribeGameSessionsResponse

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.