Network.AWS.GameLift.DescribeGameSessions

Retrieves a set of one or more game sessions. Request a specific game session or request all game sessions on a fleet. Alternatively, use SearchGameSessions to request a set of active game sessions that are filtered by certain criteria. To retrieve protection policy settings for game sessions, use DescribeGameSessionDetails .

To get game sessions, specify 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 game session matching the request.

Available in Amazon GameLift Local.

Game-session-related operations include:

• CreateGameSession
• DescribeGameSessions
• DescribeGameSessionDetails
• SearchGameSessions
• UpdateGameSession
• GetGameSessionLogUrl
• Game session placements
• StartGameSessionPlacement
• DescribeGameSessionPlacement
• StopGameSessionPlacement

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 - Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.
• dgsAliasId - Unique identifier for an alias associated with the fleet to retrieve all game sessions for.
• dgsNextToken - Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
• dgsStatusFilter - Game session status to filter results on. Possible game session statuses include ACTIVE , TERMINATED , ACTIVATING , and TERMINATING (the last two are transitory).
• dgsLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• dgsFleetId - Unique identifier for a fleet to retrieve all game sessions for.

data DescribeGameSessions

Represents the input for a request action.

See: describeGameSessions smart constructor.

Instances

Eq DescribeGameSessions

Methods

(==) :: DescribeGameSessions -> DescribeGameSessions -> Bool

(/=) :: DescribeGameSessions -> DescribeGameSessions -> Bool

Data DescribeGameSessions

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGameSessions -> c DescribeGameSessions

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGameSessions

toConstr :: DescribeGameSessions -> Constr

dataTypeOf :: DescribeGameSessions -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGameSessions)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGameSessions)

gmapT :: (forall b. Data b => b -> b) -> DescribeGameSessions -> DescribeGameSessions

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessions -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessions -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeGameSessions -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGameSessions -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGameSessions -> m DescribeGameSessions

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessions -> m DescribeGameSessions

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessions -> m DescribeGameSessions

Read DescribeGameSessions

Methods

readsPrec :: Int -> ReadS DescribeGameSessions

readList :: ReadS [DescribeGameSessions]

readPrec :: ReadPrec DescribeGameSessions

readListPrec :: ReadPrec [DescribeGameSessions]

Show DescribeGameSessions

Methods

showsPrec :: Int -> DescribeGameSessions -> ShowS

show :: DescribeGameSessions -> String

showList :: [DescribeGameSessions] -> ShowS

Generic DescribeGameSessions

Associated Types

type Rep DescribeGameSessions :: * -> *

Methods

from :: DescribeGameSessions -> Rep DescribeGameSessions x

to :: Rep DescribeGameSessions x -> DescribeGameSessions

Hashable DescribeGameSessions

Methods

hashWithSalt :: Int -> DescribeGameSessions -> Int

hash :: DescribeGameSessions -> Int

ToJSON DescribeGameSessions

Methods

toJSON :: DescribeGameSessions -> Value

toEncoding :: DescribeGameSessions -> Encoding

toJSONList :: [DescribeGameSessions] -> Value

toEncodingList :: [DescribeGameSessions] -> Encoding

NFData DescribeGameSessions

Methods

rnf :: DescribeGameSessions -> ()

AWSRequest DescribeGameSessions

Associated Types

type Rs DescribeGameSessions :: *

Methods

request :: DescribeGameSessions -> Request DescribeGameSessions

response :: MonadResource m => Logger -> Service -> Proxy * DescribeGameSessions -> ClientResponse -> m (Response DescribeGameSessions)

ToQuery DescribeGameSessions

Methods

toQuery :: DescribeGameSessions -> QueryString

ToPath DescribeGameSessions

Methods

toPath :: DescribeGameSessions -> ByteString

ToHeaders DescribeGameSessions

Methods

toHeaders :: DescribeGameSessions -> [Header]

type Rep DescribeGameSessions

type Rep DescribeGameSessions = D1 (MetaData "DescribeGameSessions" "Network.AWS.GameLift.DescribeGameSessions" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "DescribeGameSessions'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dgsGameSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dgsAliasId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dgsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_dgsStatusFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dgsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_dgsFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Rs DescribeGameSessions

type Rs DescribeGameSessions = DescribeGameSessionsResponse

Request Lenses

dgsGameSessionId :: Lens' DescribeGameSessions (Maybe Text)

Unique identifier for the game session to retrieve. You can use either a GameSessionId or GameSessionArn value.

dgsAliasId :: Lens' DescribeGameSessions (Maybe Text)

Unique identifier for an alias associated with the fleet to retrieve all game sessions for.

dgsNextToken :: Lens' DescribeGameSessions (Maybe Text)

Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.

dgsStatusFilter :: Lens' DescribeGameSessions (Maybe Text)

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

dgsLimit :: Lens' DescribeGameSessions (Maybe Natural)

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

dgsFleetId :: Lens' DescribeGameSessions (Maybe Text)

Unique identifier for a fleet to retrieve all game sessions for.

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 - Collection of objects containing game session properties for each session matching the request.
• dgsrsNextToken - Token that indicates 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.
• dgsrsResponseStatus - -- | The response status code.

data DescribeGameSessionsResponse

Represents the returned data in response to a request action.

See: describeGameSessionsResponse smart constructor.

Instances

Eq DescribeGameSessionsResponse

Methods

(==) :: DescribeGameSessionsResponse -> DescribeGameSessionsResponse -> Bool

(/=) :: DescribeGameSessionsResponse -> DescribeGameSessionsResponse -> Bool

Data DescribeGameSessionsResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGameSessionsResponse -> c DescribeGameSessionsResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGameSessionsResponse

toConstr :: DescribeGameSessionsResponse -> Constr

dataTypeOf :: DescribeGameSessionsResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGameSessionsResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGameSessionsResponse)

gmapT :: (forall b. Data b => b -> b) -> DescribeGameSessionsResponse -> DescribeGameSessionsResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionsResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionsResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DescribeGameSessionsResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGameSessionsResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGameSessionsResponse -> m DescribeGameSessionsResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionsResponse -> m DescribeGameSessionsResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionsResponse -> m DescribeGameSessionsResponse

Read DescribeGameSessionsResponse

Methods

readsPrec :: Int -> ReadS DescribeGameSessionsResponse

readList :: ReadS [DescribeGameSessionsResponse]

readPrec :: ReadPrec DescribeGameSessionsResponse

readListPrec :: ReadPrec [DescribeGameSessionsResponse]

Show DescribeGameSessionsResponse

Methods

showsPrec :: Int -> DescribeGameSessionsResponse -> ShowS

show :: DescribeGameSessionsResponse -> String

showList :: [DescribeGameSessionsResponse] -> ShowS

Generic DescribeGameSessionsResponse

Associated Types

type Rep DescribeGameSessionsResponse :: * -> *

Methods

from :: DescribeGameSessionsResponse -> Rep DescribeGameSessionsResponse x

to :: Rep DescribeGameSessionsResponse x -> DescribeGameSessionsResponse

NFData DescribeGameSessionsResponse

Methods

rnf :: DescribeGameSessionsResponse -> ()

type Rep DescribeGameSessionsResponse

type Rep DescribeGameSessionsResponse = D1 (MetaData "DescribeGameSessionsResponse" "Network.AWS.GameLift.DescribeGameSessions" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "DescribeGameSessionsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dgsrsGameSessions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GameSession]))) ((:*:) (S1 (MetaSel (Just Symbol "_dgsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dgsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

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 that indicates 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.

dgsrsResponseStatus :: Lens' DescribeGameSessionsResponse Int

• - | The response status code.