Network.AWS.GameLift.DescribeMatchmaking

Retrieves a set of 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 .

You can request data for a one or a list of ticket IDs. If the request is successful, a ticket object is returned for each requested ID. When specifying a list of ticket IDs, objects are returned only for tickets that currently exist.

Matchmaking-related operations include:

• StartMatchmaking
• DescribeMatchmaking
• StopMatchmaking
• AcceptMatch

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. To request all existing tickets, leave this parameter empty.

data DescribeMatchmaking

Represents the input for a request action.

See: describeMatchmaking smart constructor.

Instances

Eq DescribeMatchmaking

Methods

(==) :: DescribeMatchmaking -> DescribeMatchmaking -> Bool

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

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

Methods

readsPrec :: Int -> ReadS DescribeMatchmaking

readList :: ReadS [DescribeMatchmaking]

readPrec :: ReadPrec DescribeMatchmaking

readListPrec :: ReadPrec [DescribeMatchmaking]

Show DescribeMatchmaking

Methods

showsPrec :: Int -> DescribeMatchmaking -> ShowS

show :: DescribeMatchmaking -> String

showList :: [DescribeMatchmaking] -> ShowS

Generic DescribeMatchmaking

Associated Types

type Rep DescribeMatchmaking :: * -> *

Methods

from :: DescribeMatchmaking -> Rep DescribeMatchmaking x

to :: Rep DescribeMatchmaking x -> DescribeMatchmaking

Hashable DescribeMatchmaking

Methods

hashWithSalt :: Int -> DescribeMatchmaking -> Int

hash :: DescribeMatchmaking -> Int

ToJSON DescribeMatchmaking

Methods

toJSON :: DescribeMatchmaking -> Value

toEncoding :: DescribeMatchmaking -> Encoding

toJSONList :: [DescribeMatchmaking] -> Value

toEncodingList :: [DescribeMatchmaking] -> Encoding

NFData DescribeMatchmaking

Methods

rnf :: DescribeMatchmaking -> ()

AWSRequest DescribeMatchmaking

Associated Types

type Rs DescribeMatchmaking :: *

Methods

request :: DescribeMatchmaking -> Request DescribeMatchmaking

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

ToQuery DescribeMatchmaking

Methods

toQuery :: DescribeMatchmaking -> QueryString

ToPath DescribeMatchmaking

Methods

toPath :: DescribeMatchmaking -> ByteString

ToHeaders DescribeMatchmaking

Methods

toHeaders :: DescribeMatchmaking -> [Header]

type Rep DescribeMatchmaking

type Rep DescribeMatchmaking = D1 (MetaData "DescribeMatchmaking" "Network.AWS.GameLift.DescribeMatchmaking" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" True) (C1 (MetaCons "DescribeMatchmaking'" PrefixI True) (S1 (MetaSel (Just Symbol "_dmTicketIds") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))

type Rs DescribeMatchmaking

type Rs DescribeMatchmaking = DescribeMatchmakingResponse

Request Lenses

dmTicketIds :: Lens' DescribeMatchmaking [Text]

Unique identifier for a matchmaking ticket. To request all existing tickets, leave this parameter empty.

Destructuring the Response

describeMatchmakingResponse

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

Represents the returned data in response to a request action.

See: describeMatchmakingResponse smart constructor.

Instances

Eq DescribeMatchmakingResponse

Methods

(==) :: DescribeMatchmakingResponse -> DescribeMatchmakingResponse -> Bool

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

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

Methods

readsPrec :: Int -> ReadS DescribeMatchmakingResponse

readList :: ReadS [DescribeMatchmakingResponse]

readPrec :: ReadPrec DescribeMatchmakingResponse

readListPrec :: ReadPrec [DescribeMatchmakingResponse]

Show DescribeMatchmakingResponse

Methods

showsPrec :: Int -> DescribeMatchmakingResponse -> ShowS

show :: DescribeMatchmakingResponse -> String

showList :: [DescribeMatchmakingResponse] -> ShowS

Generic DescribeMatchmakingResponse

Associated Types

type Rep DescribeMatchmakingResponse :: * -> *

Methods

from :: DescribeMatchmakingResponse -> Rep DescribeMatchmakingResponse x

to :: Rep DescribeMatchmakingResponse x -> DescribeMatchmakingResponse

NFData DescribeMatchmakingResponse

Methods

rnf :: DescribeMatchmakingResponse -> ()

type Rep DescribeMatchmakingResponse

type Rep DescribeMatchmakingResponse = D1 (MetaData "DescribeMatchmakingResponse" "Network.AWS.GameLift.DescribeMatchmaking" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" 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.