Network.AWS.GameLift.AcceptMatch

Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.

When FlexMatch builds a match, all the matchmaking tickets involved in the proposed match are placed into status REQUIRES_ACCEPTANCE . This is a trigger for your game to get acceptance from all players in the ticket. Acceptances are only valid for tickets when they are in this status; all other acceptances result in an error.

To register acceptance, specify the ticket ID, a response, and one or more players. Once all players have registered acceptance, the matchmaking tickets advance to status PLACING , where a new game session is created for the match.

If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. The matchmaking tickets are then handled in one of two ways: For tickets where all players accepted the match, the ticket status is returned to SEARCHING to find a new match. For tickets where one or more players failed to accept the match, the ticket status is set to FAILED , and processing is terminated. A new matchmaking request for these players can be submitted as needed.

Matchmaking-related operations include:

• StartMatchmaking
• DescribeMatchmaking
• StopMatchmaking
• AcceptMatch

Creating a Request

acceptMatch

Arguments

:: Text

amTicketId

-> AcceptanceType

amAcceptanceType

-> AcceptMatch

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

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

• amTicketId - Unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE ; otherwise this request will fail.
• amPlayerIds - Unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.
• amAcceptanceType - Player response to the proposed match.

data AcceptMatch

Represents the input for a request action.

See: acceptMatch smart constructor.

Instances

Eq AcceptMatch

Methods

(==) :: AcceptMatch -> AcceptMatch -> Bool

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

Data AcceptMatch

Methods

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

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

toConstr :: AcceptMatch -> Constr

dataTypeOf :: AcceptMatch -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> AcceptMatch -> AcceptMatch

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

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

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

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

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

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

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

Read AcceptMatch

Methods

readsPrec :: Int -> ReadS AcceptMatch

readList :: ReadS [AcceptMatch]

readPrec :: ReadPrec AcceptMatch

readListPrec :: ReadPrec [AcceptMatch]

Show AcceptMatch

Methods

showsPrec :: Int -> AcceptMatch -> ShowS

show :: AcceptMatch -> String

showList :: [AcceptMatch] -> ShowS

Generic AcceptMatch

Associated Types

type Rep AcceptMatch :: * -> *

Methods

from :: AcceptMatch -> Rep AcceptMatch x

to :: Rep AcceptMatch x -> AcceptMatch

Hashable AcceptMatch

Methods

hashWithSalt :: Int -> AcceptMatch -> Int

hash :: AcceptMatch -> Int

ToJSON AcceptMatch

Methods

toJSON :: AcceptMatch -> Value

toEncoding :: AcceptMatch -> Encoding

toJSONList :: [AcceptMatch] -> Value

toEncodingList :: [AcceptMatch] -> Encoding

NFData AcceptMatch

Methods

rnf :: AcceptMatch -> ()

AWSRequest AcceptMatch

Associated Types

type Rs AcceptMatch :: *

Methods

request :: AcceptMatch -> Request AcceptMatch

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

ToQuery AcceptMatch

Methods

toQuery :: AcceptMatch -> QueryString

ToPath AcceptMatch

Methods

toPath :: AcceptMatch -> ByteString

ToHeaders AcceptMatch

Methods

toHeaders :: AcceptMatch -> [Header]

type Rep AcceptMatch

type Rep AcceptMatch = D1 (MetaData "AcceptMatch" "Network.AWS.GameLift.AcceptMatch" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "AcceptMatch'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_amTicketId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_amPlayerIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])) (S1 (MetaSel (Just Symbol "_amAcceptanceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 AcceptanceType)))))

type Rs AcceptMatch

type Rs AcceptMatch = AcceptMatchResponse

Request Lenses

amTicketId :: Lens' AcceptMatch Text

Unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE ; otherwise this request will fail.

amPlayerIds :: Lens' AcceptMatch [Text]

Unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.

amAcceptanceType :: Lens' AcceptMatch AcceptanceType

Player response to the proposed match.

Destructuring the Response

acceptMatchResponse

Arguments

:: Int

amrsResponseStatus

-> AcceptMatchResponse

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

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

• amrsResponseStatus - -- | The response status code.

data AcceptMatchResponse

See: acceptMatchResponse smart constructor.

Instances

Eq AcceptMatchResponse

Methods

(==) :: AcceptMatchResponse -> AcceptMatchResponse -> Bool

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

Data AcceptMatchResponse

Methods

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

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

toConstr :: AcceptMatchResponse -> Constr

dataTypeOf :: AcceptMatchResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> AcceptMatchResponse -> AcceptMatchResponse

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

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

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

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

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

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

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

Read AcceptMatchResponse

Methods

readsPrec :: Int -> ReadS AcceptMatchResponse

readList :: ReadS [AcceptMatchResponse]

readPrec :: ReadPrec AcceptMatchResponse

readListPrec :: ReadPrec [AcceptMatchResponse]

Show AcceptMatchResponse

Methods

showsPrec :: Int -> AcceptMatchResponse -> ShowS

show :: AcceptMatchResponse -> String

showList :: [AcceptMatchResponse] -> ShowS

Generic AcceptMatchResponse

Associated Types

type Rep AcceptMatchResponse :: * -> *

Methods

from :: AcceptMatchResponse -> Rep AcceptMatchResponse x

to :: Rep AcceptMatchResponse x -> AcceptMatchResponse

NFData AcceptMatchResponse

Methods

rnf :: AcceptMatchResponse -> ()

type Rep AcceptMatchResponse

type Rep AcceptMatchResponse = D1 (MetaData "AcceptMatchResponse" "Network.AWS.GameLift.AcceptMatch" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" True) (C1 (MetaCons "AcceptMatchResponse'" PrefixI True) (S1 (MetaSel (Just Symbol "_amrsResponseStatus") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)))

Response Lenses

amrsResponseStatus :: Lens' AcceptMatchResponse Int

• - | The response status code.