aws_sdk_gamelift/client/

update_game_session_queue.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateGameSessionQueue`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`name(impl Into<String>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::name) / [`set_name(Option<String>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::set_name):<br>required: **true**<br><p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.</p><br>
    ///   - [`timeout_in_seconds(i32)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::timeout_in_seconds) / [`set_timeout_in_seconds(Option<i32>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::set_timeout_in_seconds):<br>required: **false**<br><p>The maximum time, in seconds, that a new game session placement request remains in the queue. When a request exceeds this time, the game session placement changes to a <code>TIMED_OUT</code> status.</p><br>
    ///   - [`player_latency_policies(PlayerLatencyPolicy)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::player_latency_policies) / [`set_player_latency_policies(Option<Vec::<PlayerLatencyPolicy>>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::set_player_latency_policies):<br>required: **false**<br><p>A set of policies that enforce a sliding cap on player latency when processing game sessions placement requests. Use multiple policies to gradually relax the cap over time if Amazon GameLift Servers can't make a placement. Policies are evaluated in order starting with the lowest maximum latency value. When updating policies, provide a complete collection of policies.</p><br>
    ///   - [`destinations(GameSessionQueueDestination)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::destinations) / [`set_destinations(Option<Vec::<GameSessionQueueDestination>>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::set_destinations):<br>required: **false**<br><p>A list of fleets and/or fleet aliases that can be used to fulfill game session placement requests in the queue. Destinations are identified by either a fleet ARN or a fleet alias ARN, and are listed in order of placement preference. When updating this list, provide a complete list of destinations.</p><br>
    ///   - [`filter_configuration(FilterConfiguration)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::filter_configuration) / [`set_filter_configuration(Option<FilterConfiguration>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::set_filter_configuration):<br>required: **false**<br><p>A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of Amazon Web Services Region codes, such as <code>us-west-2</code>. If this parameter is not set, game sessions can be placed in any queue location. To remove an existing filter configuration, pass in an empty set.</p><br>
    ///   - [`priority_configuration(PriorityConfiguration)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::priority_configuration) / [`set_priority_configuration(Option<PriorityConfiguration>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::set_priority_configuration):<br>required: **false**<br><p>Custom settings to use when prioritizing destinations and locations for game session placements. This configuration replaces the FleetIQ default prioritization process. Priority types that are not explicitly named will be automatically applied at the end of the prioritization process. To remove an existing priority configuration, pass in an empty set.</p><br>
    ///   - [`custom_event_data(impl Into<String>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::custom_event_data) / [`set_custom_event_data(Option<String>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::set_custom_event_data):<br>required: **false**<br><p>Information to be added to all events that are related to this game session queue.</p><br>
    ///   - [`notification_target(impl Into<String>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::notification_target) / [`set_notification_target(Option<String>)`](crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::set_notification_target):<br>required: **false**<br><p>An SNS topic ARN that is set up to receive game session placement notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queue-notification.html"> Setting up notifications for game session placement</a>.</p><br>
    /// - On success, responds with [`UpdateGameSessionQueueOutput`](crate::operation::update_game_session_queue::UpdateGameSessionQueueOutput) with field(s):
    ///   - [`game_session_queue(Option<GameSessionQueue>)`](crate::operation::update_game_session_queue::UpdateGameSessionQueueOutput::game_session_queue): <p>An object that describes the newly updated game session queue.</p>
    /// - On failure, responds with [`SdkError<UpdateGameSessionQueueError>`](crate::operation::update_game_session_queue::UpdateGameSessionQueueError)
    pub fn update_game_session_queue(&self) -> crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder {
        crate::operation::update_game_session_queue::builders::UpdateGameSessionQueueFluentBuilder::new(self.handle.clone())
    }
}