amazonka-gamelift-1.6.0: Amazon GameLift SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.GameLift.DescribeMatchmaking

Contents

Description

Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket information, including status and--once a successful match is made--acquire connection information for the resulting new game session.

You can use this operation to track the progress of matchmaking requests (through polling) as an alternative to using event notifications. See more details on tracking matchmaking requests through polling or notifications in StartMatchmaking .

To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request is successful, a ticket object is returned for each requested ID that currently exists.

Matchmaking-related operations include:

Synopsis

Creating a Request

describeMatchmaking :: DescribeMatchmaking #

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

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

  • dmTicketIds - Unique identifier for a matchmaking ticket. You can include up to 10 ID values.

data DescribeMatchmaking #

Represents the input for a request action.

See: describeMatchmaking smart constructor.

Instances

Eq DescribeMatchmaking # 
Data DescribeMatchmaking # 

Methods

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

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

toConstr :: DescribeMatchmaking -> Constr #

dataTypeOf :: DescribeMatchmaking -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeMatchmaking -> DescribeMatchmaking #

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

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

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

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

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

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

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

Read DescribeMatchmaking # 
Show DescribeMatchmaking # 
Generic DescribeMatchmaking # 
Hashable DescribeMatchmaking # 
ToJSON DescribeMatchmaking # 
NFData DescribeMatchmaking # 

Methods

rnf :: DescribeMatchmaking -> () #

AWSRequest DescribeMatchmaking # 
ToHeaders DescribeMatchmaking # 
ToPath DescribeMatchmaking # 
ToQuery DescribeMatchmaking # 
type Rep DescribeMatchmaking # 
type Rep DescribeMatchmaking = D1 * (MetaData "DescribeMatchmaking" "Network.AWS.GameLift.DescribeMatchmaking" "amazonka-gamelift-1.6.0-AFaGsb9wXmY9FImAlEHdkb" True) (C1 * (MetaCons "DescribeMatchmaking'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dmTicketIds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Text])))
type Rs DescribeMatchmaking # 

Request Lenses

dmTicketIds :: Lens' DescribeMatchmaking [Text] #

Unique identifier for a matchmaking ticket. You can include up to 10 ID values.

Destructuring the Response

describeMatchmakingResponse #

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

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

data DescribeMatchmakingResponse #

Represents the returned data in response to a request action.

See: describeMatchmakingResponse smart constructor.

Instances

Eq DescribeMatchmakingResponse # 
Data DescribeMatchmakingResponse # 

Methods

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

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

toConstr :: DescribeMatchmakingResponse -> Constr #

dataTypeOf :: DescribeMatchmakingResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeMatchmakingResponse -> DescribeMatchmakingResponse #

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

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

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

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

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

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

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

Read DescribeMatchmakingResponse # 
Show DescribeMatchmakingResponse # 
Generic DescribeMatchmakingResponse # 
NFData DescribeMatchmakingResponse # 
type Rep DescribeMatchmakingResponse # 
type Rep DescribeMatchmakingResponse = D1 * (MetaData "DescribeMatchmakingResponse" "Network.AWS.GameLift.DescribeMatchmaking" "amazonka-gamelift-1.6.0-AFaGsb9wXmY9FImAlEHdkb" False) (C1 * (MetaCons "DescribeMatchmakingResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmrsTicketList") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [MatchmakingTicket]))) (S1 * (MetaSel (Just Symbol "_dmrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

dmrsTicketList :: Lens' DescribeMatchmakingResponse [MatchmakingTicket] #

Collection of existing matchmaking ticket objects matching the request.

dmrsResponseStatus :: Lens' DescribeMatchmakingResponse Int #

  • - | The response status code.