Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.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--after a successful match is made--connection information for the resulting new game session.

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.

This operation is not designed to be continually called to track matchmaking ticket status. This practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide the topic ARN in the matchmaking configuration.

Learn more

Add FlexMatch to a game client

Set Up FlexMatch event notification

Creating a Request

data DescribeMatchmaking Source #

See: newDescribeMatchmaking smart constructor.

Constructors

DescribeMatchmaking'
Fields ticketIds :: [Text] A unique identifier for a matchmaking ticket. You can include up to 10 ID values.

Instances

Instances details

ToJSON DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods toJSON :: DescribeMatchmaking -> Value # toEncoding :: DescribeMatchmaking -> Encoding # toJSONList :: [DescribeMatchmaking] -> Value # toEncodingList :: [DescribeMatchmaking] -> Encoding #
ToHeaders DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods toHeaders :: DescribeMatchmaking -> [Header] #
ToPath DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods toPath :: DescribeMatchmaking -> ByteString #
ToQuery DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods toQuery :: DescribeMatchmaking -> QueryString #
AWSRequest DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Associated Types type AWSResponse DescribeMatchmaking # Methods request :: (Service -> Service) -> DescribeMatchmaking -> Request DescribeMatchmaking # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeMatchmaking -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeMatchmaking))) #
Generic DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Associated Types type Rep DescribeMatchmaking :: Type -> Type # Methods from :: DescribeMatchmaking -> Rep DescribeMatchmaking x # to :: Rep DescribeMatchmaking x -> DescribeMatchmaking #
Read DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods readsPrec :: Int -> ReadS DescribeMatchmaking # readList :: ReadS [DescribeMatchmaking] # readPrec :: ReadPrec DescribeMatchmaking # readListPrec :: ReadPrec [DescribeMatchmaking] #
Show DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods showsPrec :: Int -> DescribeMatchmaking -> ShowS # show :: DescribeMatchmaking -> String # showList :: [DescribeMatchmaking] -> ShowS #
NFData DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods rnf :: DescribeMatchmaking -> () #
Eq DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods (==) :: DescribeMatchmaking -> DescribeMatchmaking -> Bool # (/=) :: DescribeMatchmaking -> DescribeMatchmaking -> Bool #
Hashable DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods hashWithSalt :: Int -> DescribeMatchmaking -> Int # hash :: DescribeMatchmaking -> Int #
type AWSResponse DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking type AWSResponse DescribeMatchmaking = DescribeMatchmakingResponse
type Rep DescribeMatchmaking Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking type Rep DescribeMatchmaking = D1 ('MetaData "DescribeMatchmaking" "Amazonka.GameLift.DescribeMatchmaking" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeMatchmaking'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ticketIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newDescribeMatchmaking :: DescribeMatchmaking Source #

Create a value of DescribeMatchmaking with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ticketIds:DescribeMatchmaking', describeMatchmaking_ticketIds - A unique identifier for a matchmaking ticket. You can include up to 10 ID values.

Request Lenses

describeMatchmaking_ticketIds :: Lens' DescribeMatchmaking [Text] Source #

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

Destructuring the Response

data DescribeMatchmakingResponse Source #

See: newDescribeMatchmakingResponse smart constructor.

Constructors

DescribeMatchmakingResponse'
Fields ticketList :: Maybe [MatchmakingTicket] A collection of existing matchmaking ticket objects matching the request. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeMatchmakingResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Associated Types type Rep DescribeMatchmakingResponse :: Type -> Type # Methods from :: DescribeMatchmakingResponse -> Rep DescribeMatchmakingResponse x # to :: Rep DescribeMatchmakingResponse x -> DescribeMatchmakingResponse #
Read DescribeMatchmakingResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods readsPrec :: Int -> ReadS DescribeMatchmakingResponse # readList :: ReadS [DescribeMatchmakingResponse] # readPrec :: ReadPrec DescribeMatchmakingResponse # readListPrec :: ReadPrec [DescribeMatchmakingResponse] #
Show DescribeMatchmakingResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods showsPrec :: Int -> DescribeMatchmakingResponse -> ShowS # show :: DescribeMatchmakingResponse -> String # showList :: [DescribeMatchmakingResponse] -> ShowS #
NFData DescribeMatchmakingResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods rnf :: DescribeMatchmakingResponse -> () #
Eq DescribeMatchmakingResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking Methods (==) :: DescribeMatchmakingResponse -> DescribeMatchmakingResponse -> Bool # (/=) :: DescribeMatchmakingResponse -> DescribeMatchmakingResponse -> Bool #
type Rep DescribeMatchmakingResponse Source #
Instance details Defined in Amazonka.GameLift.DescribeMatchmaking type Rep DescribeMatchmakingResponse = D1 ('MetaData "DescribeMatchmakingResponse" "Amazonka.GameLift.DescribeMatchmaking" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "DescribeMatchmakingResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ticketList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [MatchmakingTicket])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeMatchmakingResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeMatchmakingResponse'`
-> DescribeMatchmakingResponse

Create a value of DescribeMatchmakingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ticketList:DescribeMatchmakingResponse', describeMatchmakingResponse_ticketList - A collection of existing matchmaking ticket objects matching the request.

$sel:httpStatus:DescribeMatchmakingResponse', describeMatchmakingResponse_httpStatus - The response's http status code.

Response Lenses

describeMatchmakingResponse_ticketList :: Lens' DescribeMatchmakingResponse (Maybe [MatchmakingTicket]) Source #

A collection of existing matchmaking ticket objects matching the request.

describeMatchmakingResponse_httpStatus :: Lens' DescribeMatchmakingResponse Int Source #

The response's http status code.