aws-sdk-gamelift 1.118.0

AWS SDK for Amazon GameLift
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetPlayerConnectionDetails`](crate::operation::get_player_connection_details::builders::GetPlayerConnectionDetailsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`game_session_id(impl Into<String>)`](crate::operation::get_player_connection_details::builders::GetPlayerConnectionDetailsFluentBuilder::game_session_id) / [`set_game_session_id(Option<String>)`](crate::operation::get_player_connection_details::builders::GetPlayerConnectionDetailsFluentBuilder::set_game_session_id):<br>required: **true**<br><p>An identifier for the game session that is unique across all regions for which to retrieve player connection details. 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_ids(impl Into<String>)`](crate::operation::get_player_connection_details::builders::GetPlayerConnectionDetailsFluentBuilder::player_ids) / [`set_player_ids(Option<Vec::<String>>)`](crate::operation::get_player_connection_details::builders::GetPlayerConnectionDetailsFluentBuilder::set_player_ids):<br>required: **true**<br><p>List of unique identifiers for players. Connection details are returned for each player in this list.</p><br>
    /// - On success, responds with [`GetPlayerConnectionDetailsOutput`](crate::operation::get_player_connection_details::GetPlayerConnectionDetailsOutput) with field(s):
    ///   - [`game_session_id(Option<String>)`](crate::operation::get_player_connection_details::GetPlayerConnectionDetailsOutput::game_session_id): <p>An identifier for the game session that is unique across all regions for which the player connection details were retrieved. 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>
    ///   - [`player_connection_details(Option<Vec::<PlayerConnectionDetail>>)`](crate::operation::get_player_connection_details::GetPlayerConnectionDetailsOutput::player_connection_details): <p>A collection of player connection detail objects, one for each requested player.</p>
    /// - On failure, responds with [`SdkError<GetPlayerConnectionDetailsError>`](crate::operation::get_player_connection_details::GetPlayerConnectionDetailsError)
    pub fn get_player_connection_details(
        &self,
    ) -> crate::operation::get_player_connection_details::builders::GetPlayerConnectionDetailsFluentBuilder {
        crate::operation::get_player_connection_details::builders::GetPlayerConnectionDetailsFluentBuilder::new(self.handle.clone())
    }
}