Amazonka.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 one or more players rejected the match or failed to respond, the ticket status is set to CANCELLED, and processing is terminated. For tickets where players have accepted or not yet responded, the ticket status is returned to SEARCHING to find a new match. A new matchmaking request for these players can be submitted as needed.

Learn more

Add FlexMatch to a game client

FlexMatch events (reference)

Creating a Request

data AcceptMatch

See: newAcceptMatch smart constructor.

Constructors

AcceptMatch'

Fields

• ticketId :: Text

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

• playerIds :: [Text]

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

• acceptanceType :: AcceptanceType

  Player response to the proposed match.

Instances

ToJSON AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Methods

toJSON :: AcceptMatch -> Value

toEncoding :: AcceptMatch -> Encoding

toJSONList :: [AcceptMatch] -> Value

toEncodingList :: [AcceptMatch] -> Encoding

ToHeaders AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Methods

toHeaders :: AcceptMatch -> [Header]

ToPath AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Methods

toPath :: AcceptMatch -> ByteString

ToQuery AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Methods

toQuery :: AcceptMatch -> QueryString

AWSRequest AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Associated Types

type AWSResponse AcceptMatch

Methods

request :: (Service -> Service) -> AcceptMatch -> Request AcceptMatch

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AcceptMatch -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AcceptMatch)))

Generic AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Associated Types

type Rep AcceptMatch :: Type -> Type

Methods

from :: AcceptMatch -> Rep AcceptMatch x

to :: Rep AcceptMatch x -> AcceptMatch

Read AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Methods

readsPrec :: Int -> ReadS AcceptMatch

readList :: ReadS [AcceptMatch]

readPrec :: ReadPrec AcceptMatch

readListPrec :: ReadPrec [AcceptMatch]

Show AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Methods

showsPrec :: Int -> AcceptMatch -> ShowS

show :: AcceptMatch -> String

showList :: [AcceptMatch] -> ShowS

NFData AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Methods

rnf :: AcceptMatch -> ()

Eq AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Methods

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

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

Hashable AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

Methods

hashWithSalt :: Int -> AcceptMatch -> Int

hash :: AcceptMatch -> Int

type AWSResponse AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

type AWSResponse AcceptMatch = AcceptMatchResponse

type Rep AcceptMatch

Defined in Amazonka.GameLift.AcceptMatch

type Rep AcceptMatch = D1 ('MetaData "AcceptMatch" "Amazonka.GameLift.AcceptMatch" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "AcceptMatch'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ticketId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "playerIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "acceptanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AcceptanceType))))

newAcceptMatch

Arguments

:: Text

AcceptMatch

-> AcceptanceType

$sel:acceptanceType:AcceptMatch'

-> AcceptMatch

Create a value of AcceptMatch 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:

AcceptMatch, acceptMatch_ticketId - A unique identifier for a matchmaking ticket. The ticket must be in status REQUIRES_ACCEPTANCE; otherwise this request will fail.

$sel:playerIds:AcceptMatch', acceptMatch_playerIds - A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.

$sel:acceptanceType:AcceptMatch', acceptMatch_acceptanceType - Player response to the proposed match.

Request Lenses

acceptMatch_ticketId :: Lens' AcceptMatch Text

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

acceptMatch_playerIds :: Lens' AcceptMatch [Text]

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

acceptMatch_acceptanceType :: Lens' AcceptMatch AcceptanceType

Player response to the proposed match.

Destructuring the Response

data AcceptMatchResponse

See: newAcceptMatchResponse smart constructor.

Constructors

AcceptMatchResponse'

Fields

• httpStatus :: Int

  The response's http status code.

Instances

Generic AcceptMatchResponse

Defined in Amazonka.GameLift.AcceptMatch

Associated Types

type Rep AcceptMatchResponse :: Type -> Type

Methods

from :: AcceptMatchResponse -> Rep AcceptMatchResponse x

to :: Rep AcceptMatchResponse x -> AcceptMatchResponse

Read AcceptMatchResponse

Defined in Amazonka.GameLift.AcceptMatch

Methods

readsPrec :: Int -> ReadS AcceptMatchResponse

readList :: ReadS [AcceptMatchResponse]

readPrec :: ReadPrec AcceptMatchResponse

readListPrec :: ReadPrec [AcceptMatchResponse]

Show AcceptMatchResponse

Defined in Amazonka.GameLift.AcceptMatch

Methods

showsPrec :: Int -> AcceptMatchResponse -> ShowS

show :: AcceptMatchResponse -> String

showList :: [AcceptMatchResponse] -> ShowS

NFData AcceptMatchResponse

Defined in Amazonka.GameLift.AcceptMatch

Methods

rnf :: AcceptMatchResponse -> ()

Eq AcceptMatchResponse

Defined in Amazonka.GameLift.AcceptMatch

Methods

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

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

type Rep AcceptMatchResponse

Defined in Amazonka.GameLift.AcceptMatch

type Rep AcceptMatchResponse = D1 ('MetaData "AcceptMatchResponse" "Amazonka.GameLift.AcceptMatch" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "AcceptMatchResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newAcceptMatchResponse

Arguments

:: Int

$sel:httpStatus:AcceptMatchResponse'

-> AcceptMatchResponse

Create a value of AcceptMatchResponse 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:httpStatus:AcceptMatchResponse', acceptMatchResponse_httpStatus - The response's http status code.

Response Lenses

acceptMatchResponse_httpStatus :: Lens' AcceptMatchResponse Int

The response's http status code.