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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.

If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).

Learn more

Add FlexMatch to a game client

Creating a Request

data StopMatchmaking Source #

See: newStopMatchmaking smart constructor.

Constructors

StopMatchmaking'
Fields ticketId :: Text A unique identifier for a matchmaking ticket.

Instances

Instances details

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

newStopMatchmaking Source #

Arguments

:: Text	`StopMatchmaking`
-> StopMatchmaking

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

StopMatchmaking, stopMatchmaking_ticketId - A unique identifier for a matchmaking ticket.

Request Lenses

stopMatchmaking_ticketId :: Lens' StopMatchmaking Text Source #

A unique identifier for a matchmaking ticket.

Destructuring the Response

data StopMatchmakingResponse Source #

See: newStopMatchmakingResponse smart constructor.

Constructors

StopMatchmakingResponse'
Fields httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStopMatchmakingResponse Source #

Arguments

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

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

Response Lenses

stopMatchmakingResponse_httpStatus :: Lens' StopMatchmakingResponse Int Source #

The response's http status code.