aws-sdk-gamelift 1.119.0

AWS SDK for Amazon GameLift
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreatePlayerSession`](crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`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>An identifier for the game session that is unique across all regions to add a player to. The value is always a full ARN in the following format: For Home Region game session - <code>arn:aws:gamelift:<home_region>    ::gamesession/    <fleet id>     /     <id string></id>    </fleet>   </home_region></code>. For Remote Location game session - <code>arn:aws:gamelift:<home_region>    ::gamesession/    <fleet id>     /     <location>      /      <id string></id>     </location>    </fleet>   </home_region></code>.</p><br>
    ///   - [`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>
    ///   - [`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>
    /// - On success, responds with [`CreatePlayerSessionOutput`](crate::operation::create_player_session::CreatePlayerSessionOutput) with field(s):
    ///   - [`player_session(Option<PlayerSession>)`](crate::operation::create_player_session::CreatePlayerSessionOutput::player_session): <p>Object that describes the newly created player session record.</p>
    /// - On failure, responds with [`SdkError<CreatePlayerSessionError>`](crate::operation::create_player_session::CreatePlayerSessionError)
    pub fn create_player_session(&self) -> crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder {
        crate::operation::create_player_session::builders::CreatePlayerSessionFluentBuilder::new(self.handle.clone())
    }
}