Network.AWS.GameLift.CreatePlayerSessions

Adds a group of players to a game session. Similar to CreatePlayerSession , this action allows you to add multiple players in a single call, which is useful for games that provide party and/or matchmaking features. A game session must be in an ACTIVE status, have a creation policy of ALLOW_ALL , and have an open player slot before players can be added to the session.

To create player sessions, specify a game session ID and a list of player IDs. If successful, the players are added to the game session and a set of new PlayerSession objects is returned.

Creating a Request

createPlayerSessions

Arguments

:: Text

cpsGameSessionId

-> NonEmpty Text

cpsPlayerIds

-> CreatePlayerSessions

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

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

• cpsGameSessionId - Unique identifier for the game session to add players to. Game session ID format is as follows: "arn:aws:gamelift:region::gamesessionfleet-IDstring". The value of string is either a custom ID string (if one was specified when the game session was created) an autogenerated string.
• cpsPlayerIds - List of unique identifiers for the players to be added.

data CreatePlayerSessions

Represents the input for a request action.

See: createPlayerSessions smart constructor.

Instances

Eq CreatePlayerSessions

Methods

(==) :: CreatePlayerSessions -> CreatePlayerSessions -> Bool

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

Data CreatePlayerSessions

Methods

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

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

toConstr :: CreatePlayerSessions -> Constr

dataTypeOf :: CreatePlayerSessions -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreatePlayerSessions

Methods

readsPrec :: Int -> ReadS CreatePlayerSessions

readList :: ReadS [CreatePlayerSessions]

readPrec :: ReadPrec CreatePlayerSessions

readListPrec :: ReadPrec [CreatePlayerSessions]

Show CreatePlayerSessions

Methods

showsPrec :: Int -> CreatePlayerSessions -> ShowS

show :: CreatePlayerSessions -> String

showList :: [CreatePlayerSessions] -> ShowS

Generic CreatePlayerSessions

Associated Types

type Rep CreatePlayerSessions :: * -> *

Methods

from :: CreatePlayerSessions -> Rep CreatePlayerSessions x

to :: Rep CreatePlayerSessions x -> CreatePlayerSessions

Hashable CreatePlayerSessions

Methods

hashWithSalt :: Int -> CreatePlayerSessions -> Int

hash :: CreatePlayerSessions -> Int

ToJSON CreatePlayerSessions

Methods

toJSON :: CreatePlayerSessions -> Value

toEncoding :: CreatePlayerSessions -> Encoding

toJSONList :: [CreatePlayerSessions] -> Value

toEncodingList :: [CreatePlayerSessions] -> Encoding

NFData CreatePlayerSessions

Methods

rnf :: CreatePlayerSessions -> ()

AWSRequest CreatePlayerSessions

Associated Types

type Rs CreatePlayerSessions :: *

Methods

request :: CreatePlayerSessions -> Request CreatePlayerSessions

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

ToPath CreatePlayerSessions

Methods

toPath :: CreatePlayerSessions -> ByteString

ToHeaders CreatePlayerSessions

Methods

toHeaders :: CreatePlayerSessions -> [Header]

ToQuery CreatePlayerSessions

Methods

toQuery :: CreatePlayerSessions -> QueryString

type Rep CreatePlayerSessions

type Rep CreatePlayerSessions = D1 (MetaData "CreatePlayerSessions" "Network.AWS.GameLift.CreatePlayerSessions" "amazonka-gamelift-1.4.5-2krZbzEaIqtLV8ATX8AZ52" False) (C1 (MetaCons "CreatePlayerSessions'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cpsGameSessionId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cpsPlayerIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (List1 Text)))))

type Rs CreatePlayerSessions

type Rs CreatePlayerSessions = CreatePlayerSessionsResponse

Request Lenses

cpsGameSessionId :: Lens' CreatePlayerSessions Text

Unique identifier for the game session to add players to. Game session ID format is as follows: "arn:aws:gamelift:region::gamesessionfleet-IDstring". The value of string is either a custom ID string (if one was specified when the game session was created) an autogenerated string.

cpsPlayerIds :: Lens' CreatePlayerSessions (NonEmpty Text)

List of unique identifiers for the players to be added.

Destructuring the Response

createPlayerSessionsResponse

Arguments

:: Int

crsResponseStatus

-> CreatePlayerSessionsResponse

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

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

• crsPlayerSessions - Collection of player session objects created for the added players.
• crsResponseStatus - -- | The response status code.

data CreatePlayerSessionsResponse

Represents the returned data in response to a request action.

See: createPlayerSessionsResponse smart constructor.

Instances

Eq CreatePlayerSessionsResponse

Methods

(==) :: CreatePlayerSessionsResponse -> CreatePlayerSessionsResponse -> Bool

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

Data CreatePlayerSessionsResponse

Methods

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

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

toConstr :: CreatePlayerSessionsResponse -> Constr

dataTypeOf :: CreatePlayerSessionsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreatePlayerSessionsResponse

Methods

readsPrec :: Int -> ReadS CreatePlayerSessionsResponse

readList :: ReadS [CreatePlayerSessionsResponse]

readPrec :: ReadPrec CreatePlayerSessionsResponse

readListPrec :: ReadPrec [CreatePlayerSessionsResponse]

Show CreatePlayerSessionsResponse

Methods

showsPrec :: Int -> CreatePlayerSessionsResponse -> ShowS

show :: CreatePlayerSessionsResponse -> String

showList :: [CreatePlayerSessionsResponse] -> ShowS

Generic CreatePlayerSessionsResponse

Associated Types

type Rep CreatePlayerSessionsResponse :: * -> *

Methods

from :: CreatePlayerSessionsResponse -> Rep CreatePlayerSessionsResponse x

to :: Rep CreatePlayerSessionsResponse x -> CreatePlayerSessionsResponse

NFData CreatePlayerSessionsResponse

Methods

rnf :: CreatePlayerSessionsResponse -> ()

type Rep CreatePlayerSessionsResponse

type Rep CreatePlayerSessionsResponse = D1 (MetaData "CreatePlayerSessionsResponse" "Network.AWS.GameLift.CreatePlayerSessions" "amazonka-gamelift-1.4.5-2krZbzEaIqtLV8ATX8AZ52" False) (C1 (MetaCons "CreatePlayerSessionsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_crsPlayerSessions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [PlayerSession]))) (S1 (MetaSel (Just Symbol "_crsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

crsPlayerSessions :: Lens' CreatePlayerSessionsResponse [PlayerSession]

Collection of player session objects created for the added players.

crsResponseStatus :: Lens' CreatePlayerSessionsResponse Int

• - | The response status code.