aws_sdk_gamelift/client/
create_player_session.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreatePlayerSession`](crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`game_session_id(impl Into<String>)`](crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder::game_session_id) / [`set_game_session_id(Option<String>)`](crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder::set_game_session_id):<br>required: **true**<br><p>A unique identifier for the game session to add a player to.</p><br>
7    ///   - [`player_id(impl Into<String>)`](crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder::player_id) / [`set_player_id(Option<String>)`](crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder::set_player_id):<br>required: **true**<br><p>A unique identifier for a player. Player IDs are developer-defined.</p><br>
8    ///   - [`player_data(impl Into<String>)`](crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder::player_data) / [`set_player_data(Option<String>)`](crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder::set_player_data):<br>required: **false**<br><p>Developer-defined information related to a player. Amazon GameLift Servers does not use this data, so it can be formatted as needed for use in the game.</p><br>
9    /// - On success, responds with [`CreatePlayerSessionOutput`](crate::operation::create_player_session::CreatePlayerSessionOutput) with field(s):
10    ///   - [`player_session(Option<PlayerSession>)`](crate::operation::create_player_session::CreatePlayerSessionOutput::player_session): <p>Object that describes the newly created player session record.</p>
11    /// - On failure, responds with [`SdkError<CreatePlayerSessionError>`](crate::operation::create_player_session::CreatePlayerSessionError)
12    pub fn create_player_session(&self) -> crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder {
13        crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder::new(self.handle.clone())
14    }
15}