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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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:

StartMatchmaking
DescribeMatchmaking
StopMatchmaking
AcceptMatch
StartMatchBackfill

Synopsis

Creating a Request

describeMatchmaking :: DescribeMatchmaking Source #

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 Source #

Represents the input for a request action.

See: describeMatchmaking smart constructor.

Instances

Eq DescribeMatchmaking Source #
Methods (==) :: DescribeMatchmaking -> DescribeMatchmaking -> Bool # (/=) :: DescribeMatchmaking -> DescribeMatchmaking -> Bool #
Data DescribeMatchmaking Source #
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 Source #
Methods readsPrec :: Int -> ReadS DescribeMatchmaking # readList :: ReadS [DescribeMatchmaking] # readPrec :: ReadPrec DescribeMatchmaking # readListPrec :: ReadPrec [DescribeMatchmaking] #
Show DescribeMatchmaking Source #
Methods showsPrec :: Int -> DescribeMatchmaking -> ShowS # show :: DescribeMatchmaking -> String # showList :: [DescribeMatchmaking] -> ShowS #
Generic DescribeMatchmaking Source #
Associated Types type Rep DescribeMatchmaking :: * -> * # Methods from :: DescribeMatchmaking -> Rep DescribeMatchmaking x # to :: Rep DescribeMatchmaking x -> DescribeMatchmaking #
Hashable DescribeMatchmaking Source #
Methods hashWithSalt :: Int -> DescribeMatchmaking -> Int # hash :: DescribeMatchmaking -> Int #
ToJSON DescribeMatchmaking Source #
Methods toJSON :: DescribeMatchmaking -> Value # toEncoding :: DescribeMatchmaking -> Encoding # toJSONList :: [DescribeMatchmaking] -> Value # toEncodingList :: [DescribeMatchmaking] -> Encoding #
NFData DescribeMatchmaking Source #
Methods rnf :: DescribeMatchmaking -> () #
AWSRequest DescribeMatchmaking Source #
Associated Types type Rs DescribeMatchmaking :: * # Methods request :: DescribeMatchmaking -> Request DescribeMatchmaking # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DescribeMatchmaking -> ClientResponse -> m (Response DescribeMatchmaking) #
ToHeaders DescribeMatchmaking Source #
Methods toHeaders :: DescribeMatchmaking -> [Header] #
ToPath DescribeMatchmaking Source #
Methods toPath :: DescribeMatchmaking -> ByteString #
ToQuery DescribeMatchmaking Source #
Methods toQuery :: DescribeMatchmaking -> QueryString #
type Rep DescribeMatchmaking Source #
type Rep DescribeMatchmaking = D1 * (MetaData "DescribeMatchmaking" "Network.AWS.GameLift.DescribeMatchmaking" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" True) (C1 * (MetaCons "DescribeMatchmaking'" PrefixI True) (S1 * (MetaSel (Just Symbol "_dmTicketIds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Text])))
type Rs DescribeMatchmaking Source #
type Rs DescribeMatchmaking = DescribeMatchmakingResponse

Request Lenses

dmTicketIds :: Lens' DescribeMatchmaking [Text] Source #

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

Destructuring the Response

describeMatchmakingResponse Source #

Arguments

:: Int	`dmrsResponseStatus`
-> 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:

dmrsTicketList - Collection of existing matchmaking ticket objects matching the request.
dmrsResponseStatus - -- | The response status code.

data DescribeMatchmakingResponse Source #

Represents the returned data in response to a request action.

See: describeMatchmakingResponse smart constructor.

Instances

Eq DescribeMatchmakingResponse Source #
Methods (==) :: DescribeMatchmakingResponse -> DescribeMatchmakingResponse -> Bool # (/=) :: DescribeMatchmakingResponse -> DescribeMatchmakingResponse -> Bool #
Data DescribeMatchmakingResponse Source #
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 Source #
Methods readsPrec :: Int -> ReadS DescribeMatchmakingResponse # readList :: ReadS [DescribeMatchmakingResponse] # readPrec :: ReadPrec DescribeMatchmakingResponse # readListPrec :: ReadPrec [DescribeMatchmakingResponse] #
Show DescribeMatchmakingResponse Source #
Methods showsPrec :: Int -> DescribeMatchmakingResponse -> ShowS # show :: DescribeMatchmakingResponse -> String # showList :: [DescribeMatchmakingResponse] -> ShowS #
Generic DescribeMatchmakingResponse Source #
Associated Types type Rep DescribeMatchmakingResponse :: * -> * # Methods from :: DescribeMatchmakingResponse -> Rep DescribeMatchmakingResponse x # to :: Rep DescribeMatchmakingResponse x -> DescribeMatchmakingResponse #
NFData DescribeMatchmakingResponse Source #
Methods rnf :: DescribeMatchmakingResponse -> () #
type Rep DescribeMatchmakingResponse Source #
type Rep DescribeMatchmakingResponse = D1 * (MetaData "DescribeMatchmakingResponse" "Network.AWS.GameLift.DescribeMatchmaking" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" 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] Source #

Collection of existing matchmaking ticket objects matching the request.

dmrsResponseStatus :: Lens' DescribeMatchmakingResponse Int Source #

- | The response status code.