Struct aws_sdk_gamelift::client::fluent_builders::CreatePlayerSessions [−][src]
pub struct CreatePlayerSessions<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }
Expand description
Fluent builder constructing a request to CreatePlayerSessions
.
Reserves open slots in a game session for a group of players. New player sessions can be
created in any game session with an open slot that is in ACTIVE
status and
has a player creation policy of ACCEPT_ALL
. To add a single player to a
game session, use CreatePlayerSession.
To create player sessions, specify a game session ID and a list of player IDs. Optionally, provide a set of player data for each player ID.
If successful, a slot is reserved in the game session for each player, and new PlayerSession objects are returned with player session IDs. Each player references their player session ID when sending a connection request to the game session, and the game server can use it to validate the player reservation with the GameLift service. Player sessions cannot be updated.
Available in Amazon GameLift Local.
Related actions
CreatePlayerSession | CreatePlayerSessions | DescribePlayerSessions | StartGameSessionPlacement | DescribeGameSessionPlacement | All APIs by task
Implementations
impl<C, M, R> CreatePlayerSessions<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
impl<C, M, R> CreatePlayerSessions<C, M, R> where
C: SmithyConnector,
M: SmithyMiddleware<C>,
R: NewRequestPolicy,
pub async fn send(
self
) -> Result<CreatePlayerSessionsOutput, SdkError<CreatePlayerSessionsError>> where
R::Policy: SmithyRetryPolicy<CreatePlayerSessionsInputOperationOutputAlias, CreatePlayerSessionsOutput, CreatePlayerSessionsError, CreatePlayerSessionsInputOperationRetryAlias>,
pub async fn send(
self
) -> Result<CreatePlayerSessionsOutput, SdkError<CreatePlayerSessionsError>> where
R::Policy: SmithyRetryPolicy<CreatePlayerSessionsInputOperationOutputAlias, CreatePlayerSessionsOutput, CreatePlayerSessionsError, CreatePlayerSessionsInputOperationRetryAlias>,
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
A unique identifier for the game session to add players to.
A unique identifier for the game session to add players to.
Appends an item to PlayerIds
.
To override the contents of this collection use set_player_ids
.
List of unique identifiers for the players to be added.
List of unique identifiers for the players to be added.
Adds a key-value pair to PlayerDataMap
.
To override the contents of this collection use set_player_data_map
.
Map of string pairs, each specifying a player ID and a set of developer-defined
information related to the player. Amazon GameLift does not use this data, so it can be formatted
as needed for use in the game. Any player data strings for player IDs that are not
included in the PlayerIds
parameter are ignored.
Map of string pairs, each specifying a player ID and a set of developer-defined
information related to the player. Amazon GameLift does not use this data, so it can be formatted
as needed for use in the game. Any player data strings for player IDs that are not
included in the PlayerIds
parameter are ignored.
Trait Implementations
Auto Trait Implementations
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !RefUnwindSafe for CreatePlayerSessions<C, M, R>
impl<C, M, R> Send for CreatePlayerSessions<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Sync for CreatePlayerSessions<C, M, R> where
C: Send + Sync,
M: Send + Sync,
R: Send + Sync,
impl<C, M, R> Unpin for CreatePlayerSessions<C, M, R>
impl<C = DynConnector, M = DefaultMiddleware, R = Standard> !UnwindSafe for CreatePlayerSessions<C, M, R>
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more