Network.AWS.GameLift.CreateGameSession

Creates a multiplayer game session for players. This action creates a game session record and assigns the new session to an instance in the specified fleet, which activates the server initialization process in your game server. A fleet must be in an ACTIVE state before a game session can be created for it.

To create a game session, specify either a fleet ID or an alias ID and indicate the maximum number of players the game session allows. You can also provide a name and a set of properties for your game (optional). If successful, a GameSession object is returned containing session properties, including an IP address. By default, newly created game sessions are set to accept adding any new players to the game session. Use UpdateGameSession to change the creation policy.

Creating a Request

createGameSession

Arguments

:: Natural

cgsMaximumPlayerSessionCount

-> CreateGameSession

Creates a value of CreateGameSession with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cgsGameProperties
• cgsAliasId
• cgsName
• cgsFleetId
• cgsMaximumPlayerSessionCount

data CreateGameSession

Represents the input for a request action.

See: createGameSession smart constructor.

Instances

Eq CreateGameSession

Methods

(==) :: CreateGameSession -> CreateGameSession -> Bool

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

Data CreateGameSession

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateGameSession -> c CreateGameSession

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateGameSession

toConstr :: CreateGameSession -> Constr

dataTypeOf :: CreateGameSession -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateGameSession)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateGameSession)

gmapT :: (forall b. Data b => b -> b) -> CreateGameSession -> CreateGameSession

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateGameSession -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateGameSession -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateGameSession -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateGameSession -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateGameSession -> m CreateGameSession

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateGameSession -> m CreateGameSession

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateGameSession -> m CreateGameSession

Read CreateGameSession

Methods

readsPrec :: Int -> ReadS CreateGameSession

readList :: ReadS [CreateGameSession]

readPrec :: ReadPrec CreateGameSession

readListPrec :: ReadPrec [CreateGameSession]

Show CreateGameSession

Methods

showsPrec :: Int -> CreateGameSession -> ShowS

show :: CreateGameSession -> String

showList :: [CreateGameSession] -> ShowS

Generic CreateGameSession

Associated Types

type Rep CreateGameSession :: * -> *

Methods

from :: CreateGameSession -> Rep CreateGameSession x

to :: Rep CreateGameSession x -> CreateGameSession

Hashable CreateGameSession

Methods

hashWithSalt :: Int -> CreateGameSession -> Int

hash :: CreateGameSession -> Int

ToJSON CreateGameSession

Methods

toJSON :: CreateGameSession -> Value

toEncoding :: CreateGameSession -> Encoding

toJSONList :: [CreateGameSession] -> Value

toEncodingList :: [CreateGameSession] -> Encoding

NFData CreateGameSession

Methods

rnf :: CreateGameSession -> ()

AWSRequest CreateGameSession

Associated Types

type Rs CreateGameSession :: *

Methods

request :: CreateGameSession -> Request CreateGameSession

response :: MonadResource m => Logger -> Service -> Proxy * CreateGameSession -> ClientResponse -> m (Response CreateGameSession)

ToQuery CreateGameSession

Methods

toQuery :: CreateGameSession -> QueryString

ToPath CreateGameSession

Methods

toPath :: CreateGameSession -> ByteString

ToHeaders CreateGameSession

Methods

toHeaders :: CreateGameSession -> [Header]

type Rep CreateGameSession

type Rep CreateGameSession = D1 (MetaData "CreateGameSession" "Network.AWS.GameLift.CreateGameSession" "amazonka-gamelift-1.4.3-H985lHzdma37rqlxR66M9y" False) (C1 (MetaCons "CreateGameSession'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cgsGameProperties") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GameProperty]))) (S1 (MetaSel (Just Symbol "_cgsAliasId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_cgsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cgsFleetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cgsMaximumPlayerSessionCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat))))))

type Rs CreateGameSession

type Rs CreateGameSession = CreateGameSessionResponse

Request Lenses

cgsGameProperties :: Lens' CreateGameSession [GameProperty]

Set of properties used to administer a game session. These properties are passed to your game server.

cgsAliasId :: Lens' CreateGameSession (Maybe Text)

Unique identifier for a fleet alias. Each request must reference either a fleet ID or alias ID, but not both.

cgsName :: Lens' CreateGameSession (Maybe Text)

Descriptive label associated with this game session. Session names do not need to be unique.

cgsFleetId :: Lens' CreateGameSession (Maybe Text)

Unique identifier for a fleet. Each request must reference either a fleet ID or alias ID, but not both.

cgsMaximumPlayerSessionCount :: Lens' CreateGameSession Natural

Maximum number of players that can be connected simultaneously to the game session.

Destructuring the Response

createGameSessionResponse

Arguments

:: Int

cgsrsResponseStatus

-> CreateGameSessionResponse

Creates a value of CreateGameSessionResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cgsrsGameSession
• cgsrsResponseStatus

data CreateGameSessionResponse

Represents the returned data in response to a request action.

See: createGameSessionResponse smart constructor.

Instances

Eq CreateGameSessionResponse

Methods

(==) :: CreateGameSessionResponse -> CreateGameSessionResponse -> Bool

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

Data CreateGameSessionResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateGameSessionResponse -> c CreateGameSessionResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateGameSessionResponse

toConstr :: CreateGameSessionResponse -> Constr

dataTypeOf :: CreateGameSessionResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateGameSessionResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateGameSessionResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateGameSessionResponse -> CreateGameSessionResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateGameSessionResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateGameSessionResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateGameSessionResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateGameSessionResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateGameSessionResponse -> m CreateGameSessionResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateGameSessionResponse -> m CreateGameSessionResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateGameSessionResponse -> m CreateGameSessionResponse

Read CreateGameSessionResponse

Methods

readsPrec :: Int -> ReadS CreateGameSessionResponse

readList :: ReadS [CreateGameSessionResponse]

readPrec :: ReadPrec CreateGameSessionResponse

readListPrec :: ReadPrec [CreateGameSessionResponse]

Show CreateGameSessionResponse

Methods

showsPrec :: Int -> CreateGameSessionResponse -> ShowS

show :: CreateGameSessionResponse -> String

showList :: [CreateGameSessionResponse] -> ShowS

Generic CreateGameSessionResponse

Associated Types

type Rep CreateGameSessionResponse :: * -> *

Methods

from :: CreateGameSessionResponse -> Rep CreateGameSessionResponse x

to :: Rep CreateGameSessionResponse x -> CreateGameSessionResponse

NFData CreateGameSessionResponse

Methods

rnf :: CreateGameSessionResponse -> ()

type Rep CreateGameSessionResponse

type Rep CreateGameSessionResponse = D1 (MetaData "CreateGameSessionResponse" "Network.AWS.GameLift.CreateGameSession" "amazonka-gamelift-1.4.3-H985lHzdma37rqlxR66M9y" False) (C1 (MetaCons "CreateGameSessionResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cgsrsGameSession") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GameSession))) (S1 (MetaSel (Just Symbol "_cgsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

cgsrsGameSession :: Lens' CreateGameSessionResponse (Maybe GameSession)

Object containing the newly created game session record.

cgsrsResponseStatus :: Lens' CreateGameSessionResponse Int

The response status code.