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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information, including current status, about a game session placement request.

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.

Creating a Request

data DescribeGameSessionPlacement Source #

See: newDescribeGameSessionPlacement smart constructor.

Constructors

DescribeGameSessionPlacement'
Fields placementId :: Text A unique identifier for a game session placement to retrieve.

Instances

Instances details

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

newDescribeGameSessionPlacement Source #

Arguments

:: Text	`DescribeGameSessionPlacement`
-> DescribeGameSessionPlacement

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

DescribeGameSessionPlacement, describeGameSessionPlacement_placementId - A unique identifier for a game session placement to retrieve.

Request Lenses

describeGameSessionPlacement_placementId :: Lens' DescribeGameSessionPlacement Text Source #

A unique identifier for a game session placement to retrieve.

Destructuring the Response

data DescribeGameSessionPlacementResponse Source #

See: newDescribeGameSessionPlacementResponse smart constructor.

Constructors

DescribeGameSessionPlacementResponse'
Fields gameSessionPlacement :: Maybe GameSessionPlacement Object that describes the requested game session placement. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeGameSessionPlacementResponse Source #

Arguments

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

Create a value of DescribeGameSessionPlacementResponse 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:DescribeGameSessionPlacementResponse', describeGameSessionPlacementResponse_gameSessionPlacement - Object that describes the requested game session placement.

$sel:httpStatus:DescribeGameSessionPlacementResponse', describeGameSessionPlacementResponse_httpStatus - The response's http status code.

Response Lenses

describeGameSessionPlacementResponse_gameSessionPlacement :: Lens' DescribeGameSessionPlacementResponse (Maybe GameSessionPlacement) Source #

Object that describes the requested game session placement.

describeGameSessionPlacementResponse_httpStatus :: Lens' DescribeGameSessionPlacementResponse Int Source #

The response's http status code.