libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.StopGameSessionPlacement

Description

Cancels a game session placement that is in PENDING status. To stop a placement, provide the placement ID values. If successful, the placement is moved to CANCELLED status.

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Synopsis

Creating a Request

data StopGameSessionPlacement Source #

Represents the input for a request operation.

See: newStopGameSessionPlacement smart constructor.

Constructors

StopGameSessionPlacement' 

Fields

  • placementId :: Text

    A unique identifier for a game session placement to cancel.

Instances

Instances details
Eq StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

(==) :: StopGameSessionPlacement -> StopGameSessionPlacement -> Bool #

(/=) :: StopGameSessionPlacement -> StopGameSessionPlacement -> Bool #

Read StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

readsPrec :: Int -> ReadS StopGameSessionPlacement #

readList :: ReadS [StopGameSessionPlacement] #

readPrec :: ReadPrec StopGameSessionPlacement #

readListPrec :: ReadPrec [StopGameSessionPlacement] #

Show StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

showsPrec :: Int -> StopGameSessionPlacement -> ShowS #

show :: StopGameSessionPlacement -> String #

showList :: [StopGameSessionPlacement] -> ShowS #

Generic StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Associated Types

type Rep StopGameSessionPlacement :: Type -> Type #

Methods

from :: StopGameSessionPlacement -> Rep StopGameSessionPlacement x #

to :: Rep StopGameSessionPlacement x -> StopGameSessionPlacement #

NFData StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

rnf :: StopGameSessionPlacement -> () #

Hashable StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

hashWithSalt :: Int -> StopGameSessionPlacement -> Int #

hash :: StopGameSessionPlacement -> Int #

ToJSON StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

toJSON :: StopGameSessionPlacement -> Value #

toEncoding :: StopGameSessionPlacement -> Encoding #

toJSONList :: [StopGameSessionPlacement] -> Value #

toEncodingList :: [StopGameSessionPlacement] -> Encoding #

AWSRequest StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Associated Types

type AWSResponse StopGameSessionPlacement #

Methods

request :: StopGameSessionPlacement -> Request StopGameSessionPlacement #

response :: MonadResource m => Logger -> Service -> Proxy StopGameSessionPlacement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopGameSessionPlacement))) #

ToHeaders StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

toHeaders :: StopGameSessionPlacement -> [Header] #

ToPath StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

toPath :: StopGameSessionPlacement -> ByteString #

ToQuery StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

toQuery :: StopGameSessionPlacement -> QueryString #

type Rep StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

type Rep StopGameSessionPlacement = D1 ('MetaData "StopGameSessionPlacement" "Amazonka.GameLift.StopGameSessionPlacement" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "StopGameSessionPlacement'" 'PrefixI 'True) (S1 ('MetaSel ('Just "placementId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopGameSessionPlacement Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

type AWSResponse StopGameSessionPlacement = StopGameSessionPlacementResponse

newStopGameSessionPlacement Source #

Arguments

:: Text

$sel:placementId:StopGameSessionPlacement'

-> StopGameSessionPlacement 

Create a value of StopGameSessionPlacement 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:placementId:StopGameSessionPlacement', stopGameSessionPlacement_placementId - A unique identifier for a game session placement to cancel.

Request Lenses

stopGameSessionPlacement_placementId :: Lens' StopGameSessionPlacement Text Source #

A unique identifier for a game session placement to cancel.

Destructuring the Response

data StopGameSessionPlacementResponse Source #

Represents the returned data in response to a request operation.

See: newStopGameSessionPlacementResponse smart constructor.

Constructors

StopGameSessionPlacementResponse' 

Fields

Instances

Instances details
Eq StopGameSessionPlacementResponse Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

(==) :: StopGameSessionPlacementResponse -> StopGameSessionPlacementResponse -> Bool #

(/=) :: StopGameSessionPlacementResponse -> StopGameSessionPlacementResponse -> Bool #

Read StopGameSessionPlacementResponse Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

readsPrec :: Int -> ReadS StopGameSessionPlacementResponse #

readList :: ReadS [StopGameSessionPlacementResponse] #

readPrec :: ReadPrec StopGameSessionPlacementResponse #

readListPrec :: ReadPrec [StopGameSessionPlacementResponse] #

Show StopGameSessionPlacementResponse Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

showsPrec :: Int -> StopGameSessionPlacementResponse -> ShowS #

show :: StopGameSessionPlacementResponse -> String #

showList :: [StopGameSessionPlacementResponse] -> ShowS #

Generic StopGameSessionPlacementResponse Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Associated Types

type Rep StopGameSessionPlacementResponse :: Type -> Type #

Methods

from :: StopGameSessionPlacementResponse -> Rep StopGameSessionPlacementResponse x #

to :: Rep StopGameSessionPlacementResponse x -> StopGameSessionPlacementResponse #

NFData StopGameSessionPlacementResponse Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

rnf :: StopGameSessionPlacementResponse -> () #

type Rep StopGameSessionPlacementResponse Source # 
Instance details

Defined in Amazonka.GameLift.StopGameSessionPlacement

type Rep StopGameSessionPlacementResponse = D1 ('MetaData "StopGameSessionPlacementResponse" "Amazonka.GameLift.StopGameSessionPlacement" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "StopGameSessionPlacementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameSessionPlacement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GameSessionPlacement)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopGameSessionPlacementResponse Source #

Arguments

:: Int

$sel:httpStatus:StopGameSessionPlacementResponse'

-> StopGameSessionPlacementResponse 

Create a value of StopGameSessionPlacementResponse 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:gameSessionPlacement:StopGameSessionPlacementResponse', stopGameSessionPlacementResponse_gameSessionPlacement - Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.

$sel:httpStatus:StopGameSessionPlacementResponse', stopGameSessionPlacementResponse_httpStatus - The response's http status code.

Response Lenses

stopGameSessionPlacementResponse_gameSessionPlacement :: Lens' StopGameSessionPlacementResponse (Maybe GameSessionPlacement) Source #

Object that describes the canceled game session placement, with CANCELLED status and an end time stamp.

stopGameSessionPlacementResponse_httpStatus :: Lens' StopGameSessionPlacementResponse Int Source #

The response's http status code.