Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.GameLift.DescribeGameSessionDetails

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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 or GameSessionArn 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.

Game-session-related operations include:

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

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 - Unique identifier for the game session to retrieve.
dgsdAliasId - Unique identifier for an alias associated with the fleet to retrieve all game sessions for.
dgsdNextToken - 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.
dgsdStatusFilter - Game session status to filter results on. Possible game session statuses include ACTIVE , TERMINATED , ACTIVATING and TERMINATING (the last two are transitory).
dgsdLimit - Maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
dgsdFleetId - Unique identifier for a fleet to retrieve all game sessions active on the fleet.

data DescribeGameSessionDetails #

Represents the input for a request action.

See: describeGameSessionDetails smart constructor.

Instances

Eq DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods (==) :: DescribeGameSessionDetails -> DescribeGameSessionDetails -> Bool # (/=) :: DescribeGameSessionDetails -> DescribeGameSessionDetails -> Bool #
Data DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGameSessionDetails -> c DescribeGameSessionDetails # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGameSessionDetails # toConstr :: DescribeGameSessionDetails -> Constr # dataTypeOf :: DescribeGameSessionDetails -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGameSessionDetails) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGameSessionDetails) # gmapT :: (forall b. Data b => b -> b) -> DescribeGameSessionDetails -> DescribeGameSessionDetails # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionDetails -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionDetails -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeGameSessionDetails -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGameSessionDetails -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGameSessionDetails -> m DescribeGameSessionDetails # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionDetails -> m DescribeGameSessionDetails # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionDetails -> m DescribeGameSessionDetails #
Read DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods readsPrec :: Int -> ReadS DescribeGameSessionDetails # readList :: ReadS [DescribeGameSessionDetails] # readPrec :: ReadPrec DescribeGameSessionDetails # readListPrec :: ReadPrec [DescribeGameSessionDetails] #
Show DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods showsPrec :: Int -> DescribeGameSessionDetails -> ShowS # show :: DescribeGameSessionDetails -> String # showList :: [DescribeGameSessionDetails] -> ShowS #
Generic DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Associated Types type Rep DescribeGameSessionDetails :: Type -> Type # Methods from :: DescribeGameSessionDetails -> Rep DescribeGameSessionDetails x # to :: Rep DescribeGameSessionDetails x -> DescribeGameSessionDetails #
Hashable DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods hashWithSalt :: Int -> DescribeGameSessionDetails -> Int # hash :: DescribeGameSessionDetails -> Int #
ToJSON DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods toJSON :: DescribeGameSessionDetails -> Value # toEncoding :: DescribeGameSessionDetails -> Encoding # toJSONList :: [DescribeGameSessionDetails] -> Value # toEncodingList :: [DescribeGameSessionDetails] -> Encoding #
AWSRequest DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Associated Types type Rs DescribeGameSessionDetails :: Type # Methods request :: DescribeGameSessionDetails -> Request DescribeGameSessionDetails # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DescribeGameSessionDetails -> ClientResponse -> m (Response DescribeGameSessionDetails) #
ToHeaders DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods toHeaders :: DescribeGameSessionDetails -> [Header] #
ToPath DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods toPath :: DescribeGameSessionDetails -> ByteString #
ToQuery DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods toQuery :: DescribeGameSessionDetails -> QueryString #
NFData DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods rnf :: DescribeGameSessionDetails -> () #
type Rep DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails type Rep DescribeGameSessionDetails = D1 (MetaData "DescribeGameSessionDetails" "Network.AWS.GameLift.DescribeGameSessionDetails" "amazonka-gamelift-1.6.1-56J6KyCyd5gIP1PYUN0n62" False) (C1 (MetaCons "DescribeGameSessionDetails'" PrefixI True) ((S1 (MetaSel (Just "_dgsdGameSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dgsdAliasId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dgsdNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_dgsdStatusFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_dgsdLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_dgsdFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Rs DescribeGameSessionDetails #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails type Rs DescribeGameSessionDetails = DescribeGameSessionDetailsResponse

Request Lenses

dgsdGameSessionId :: Lens' DescribeGameSessionDetails (Maybe Text) #

Unique identifier for the game session to retrieve.

dgsdAliasId :: Lens' DescribeGameSessionDetails (Maybe Text) #

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

dgsdNextToken :: Lens' DescribeGameSessionDetails (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.

dgsdStatusFilter :: Lens' DescribeGameSessionDetails (Maybe Text) #

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

dgsdLimit :: Lens' DescribeGameSessionDetails (Maybe Natural) #

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

dgsdFleetId :: Lens' DescribeGameSessionDetails (Maybe Text) #

Unique identifier for a fleet to retrieve 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 - Collection of objects containing game session properties and the protection policy currently in force for each session matching the request.
dgsdrsNextToken - 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.
dgsdrsResponseStatus - -- | The response status code.

data DescribeGameSessionDetailsResponse #

Represents the returned data in response to a request action.

See: describeGameSessionDetailsResponse smart constructor.

Instances

Eq DescribeGameSessionDetailsResponse #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods (==) :: DescribeGameSessionDetailsResponse -> DescribeGameSessionDetailsResponse -> Bool # (/=) :: DescribeGameSessionDetailsResponse -> DescribeGameSessionDetailsResponse -> Bool #
Data DescribeGameSessionDetailsResponse #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeGameSessionDetailsResponse -> c DescribeGameSessionDetailsResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeGameSessionDetailsResponse # toConstr :: DescribeGameSessionDetailsResponse -> Constr # dataTypeOf :: DescribeGameSessionDetailsResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DescribeGameSessionDetailsResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeGameSessionDetailsResponse) # gmapT :: (forall b. Data b => b -> b) -> DescribeGameSessionDetailsResponse -> DescribeGameSessionDetailsResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionDetailsResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeGameSessionDetailsResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DescribeGameSessionDetailsResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeGameSessionDetailsResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeGameSessionDetailsResponse -> m DescribeGameSessionDetailsResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionDetailsResponse -> m DescribeGameSessionDetailsResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeGameSessionDetailsResponse -> m DescribeGameSessionDetailsResponse #
Read DescribeGameSessionDetailsResponse #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods readsPrec :: Int -> ReadS DescribeGameSessionDetailsResponse # readList :: ReadS [DescribeGameSessionDetailsResponse] # readPrec :: ReadPrec DescribeGameSessionDetailsResponse # readListPrec :: ReadPrec [DescribeGameSessionDetailsResponse] #
Show DescribeGameSessionDetailsResponse #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods showsPrec :: Int -> DescribeGameSessionDetailsResponse -> ShowS # show :: DescribeGameSessionDetailsResponse -> String # showList :: [DescribeGameSessionDetailsResponse] -> ShowS #
Generic DescribeGameSessionDetailsResponse #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Associated Types type Rep DescribeGameSessionDetailsResponse :: Type -> Type # Methods from :: DescribeGameSessionDetailsResponse -> Rep DescribeGameSessionDetailsResponse x # to :: Rep DescribeGameSessionDetailsResponse x -> DescribeGameSessionDetailsResponse #
NFData DescribeGameSessionDetailsResponse #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails Methods rnf :: DescribeGameSessionDetailsResponse -> () #
type Rep DescribeGameSessionDetailsResponse #
Instance details Defined in Network.AWS.GameLift.DescribeGameSessionDetails type Rep DescribeGameSessionDetailsResponse = D1 (MetaData "DescribeGameSessionDetailsResponse" "Network.AWS.GameLift.DescribeGameSessionDetails" "amazonka-gamelift-1.6.1-56J6KyCyd5gIP1PYUN0n62" False) (C1 (MetaCons "DescribeGameSessionDetailsResponse'" PrefixI True) (S1 (MetaSel (Just "_dgsdrsGameSessionDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GameSessionDetail])) :: (S1 (MetaSel (Just "_dgsdrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dgsdrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

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

dgsdrsResponseStatus :: Lens' DescribeGameSessionDetailsResponse Int #

- | The response status code.