Amazonka.GameLift.StopGameSessionPlacement

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.

Creating a Request

data StopGameSessionPlacement

See: newStopGameSessionPlacement smart constructor.

Constructors

StopGameSessionPlacement'

Fields

• placementId :: Text

  A unique identifier for a game session placement to stop.

Instances

ToJSON StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

toJSON :: StopGameSessionPlacement -> Value

toEncoding :: StopGameSessionPlacement -> Encoding

toJSONList :: [StopGameSessionPlacement] -> Value

toEncodingList :: [StopGameSessionPlacement] -> Encoding

ToHeaders StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

toHeaders :: StopGameSessionPlacement -> [Header]

ToPath StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

toPath :: StopGameSessionPlacement -> ByteString

ToQuery StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

toQuery :: StopGameSessionPlacement -> QueryString

AWSRequest StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Associated Types

type AWSResponse StopGameSessionPlacement

Methods

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

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

Generic StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Associated Types

type Rep StopGameSessionPlacement :: Type -> Type

Methods

from :: StopGameSessionPlacement -> Rep StopGameSessionPlacement x

to :: Rep StopGameSessionPlacement x -> StopGameSessionPlacement

Read StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

readsPrec :: Int -> ReadS StopGameSessionPlacement

readList :: ReadS [StopGameSessionPlacement]

readPrec :: ReadPrec StopGameSessionPlacement

readListPrec :: ReadPrec [StopGameSessionPlacement]

Show StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

showsPrec :: Int -> StopGameSessionPlacement -> ShowS

show :: StopGameSessionPlacement -> String

showList :: [StopGameSessionPlacement] -> ShowS

NFData StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

rnf :: StopGameSessionPlacement -> ()

Eq StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

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

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

Hashable StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

hashWithSalt :: Int -> StopGameSessionPlacement -> Int

hash :: StopGameSessionPlacement -> Int

type AWSResponse StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

type AWSResponse StopGameSessionPlacement = StopGameSessionPlacementResponse

type Rep StopGameSessionPlacement

Defined in Amazonka.GameLift.StopGameSessionPlacement

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

newStopGameSessionPlacement

Arguments

:: Text

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:

StopGameSessionPlacement, stopGameSessionPlacement_placementId - A unique identifier for a game session placement to stop.

Request Lenses

stopGameSessionPlacement_placementId :: Lens' StopGameSessionPlacement Text

A unique identifier for a game session placement to stop.

Destructuring the Response

data StopGameSessionPlacementResponse

See: newStopGameSessionPlacementResponse smart constructor.

Constructors

StopGameSessionPlacementResponse'

Fields

• gameSessionPlacement :: Maybe GameSessionPlacement

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic StopGameSessionPlacementResponse

Defined in Amazonka.GameLift.StopGameSessionPlacement

Associated Types

type Rep StopGameSessionPlacementResponse :: Type -> Type

Methods

from :: StopGameSessionPlacementResponse -> Rep StopGameSessionPlacementResponse x

to :: Rep StopGameSessionPlacementResponse x -> StopGameSessionPlacementResponse

Read StopGameSessionPlacementResponse

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

readsPrec :: Int -> ReadS StopGameSessionPlacementResponse

readList :: ReadS [StopGameSessionPlacementResponse]

readPrec :: ReadPrec StopGameSessionPlacementResponse

readListPrec :: ReadPrec [StopGameSessionPlacementResponse]

Show StopGameSessionPlacementResponse

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

showsPrec :: Int -> StopGameSessionPlacementResponse -> ShowS

show :: StopGameSessionPlacementResponse -> String

showList :: [StopGameSessionPlacementResponse] -> ShowS

NFData StopGameSessionPlacementResponse

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

rnf :: StopGameSessionPlacementResponse -> ()

Eq StopGameSessionPlacementResponse

Defined in Amazonka.GameLift.StopGameSessionPlacement

Methods

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

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

type Rep StopGameSessionPlacementResponse

Defined in Amazonka.GameLift.StopGameSessionPlacement

type Rep StopGameSessionPlacementResponse = D1 ('MetaData "StopGameSessionPlacementResponse" "Amazonka.GameLift.StopGameSessionPlacement" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" '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

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)

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

stopGameSessionPlacementResponse_httpStatus :: Lens' StopGameSessionPlacementResponse Int

The response's http status code.