Struct aws_sdk_gamelift::client::fluent_builders::UpdateGameSessionQueue

pub struct UpdateGameSessionQueue<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to UpdateGameSessionQueue.

Updates the configuration of a game session queue, which determines how the queue processes new game session requests. To update settings, specify the queue name to be updated and provide the new settings. When updating destinations, provide a complete list of destinations.

Learn more

Using Multi-Region Queues

Related actions

CreateGameSessionQueue | DescribeGameSessionQueues | UpdateGameSessionQueue | DeleteGameSessionQueue | All APIs by task

Implementations

impl<C, M, R> UpdateGameSessionQueue<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<UpdateGameSessionQueueOutput, SdkError<UpdateGameSessionQueueError>> where
    R::Policy: SmithyRetryPolicy<UpdateGameSessionQueueInputOperationOutputAlias, UpdateGameSessionQueueOutput, UpdateGameSessionQueueError, UpdateGameSessionQueueInputOperationRetryAlias>, 

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.

pub fn name(self, inp: impl Into<String>) -> Self

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.

pub fn set_name(self, input: Option<String>) -> Self

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.

pub fn timeout_in_seconds(self, inp: i32) -> Self

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 TIMED_OUT status.

pub fn set_timeout_in_seconds(self, input: Option<i32>) -> Self

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 TIMED_OUT status.

pub fn player_latency_policies(
    self,
    inp: impl Into<PlayerLatencyPolicy>
) -> Self

Appends an item to PlayerLatencyPolicies.

To override the contents of this collection use set_player_latency_policies.

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

pub fn set_player_latency_policies(
    self,
    input: Option<Vec<PlayerLatencyPolicy>>
) -> Self

A set of policies that act as a sliding cap on player latency. FleetIQ works to deliver low latency for most players in a game session. These policies ensure that no individual player can be placed into a game with unreasonably high latency. Use multiple policies to gradually relax latency requirements a step at a time. Multiple policies are applied based on their maximum allowed latency, starting with the lowest value. When updating policies, provide a complete collection of policies.

pub fn destinations(self, inp: impl Into<GameSessionQueueDestination>) -> Self

Appends an item to Destinations.

To override the contents of this collection use set_destinations.

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.

pub fn set_destinations(
    self,
    input: Option<Vec<GameSessionQueueDestination>>
) -> Self

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.

pub fn filter_configuration(self, inp: FilterConfiguration) -> Self

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. 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.

pub fn set_filter_configuration(
    self,
    input: Option<FilterConfiguration>
) -> Self

A list of locations where a queue is allowed to place new game sessions. Locations are specified in the form of AWS Region codes, such as us-west-2. 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.

pub fn priority_configuration(self, inp: PriorityConfiguration) -> Self

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.

pub fn set_priority_configuration(
    self,
    input: Option<PriorityConfiguration>
) -> Self

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.

pub fn custom_event_data(self, inp: impl Into<String>) -> Self

Information to be added to all events that are related to this game session queue.

pub fn set_custom_event_data(self, input: Option<String>) -> Self

Information to be added to all events that are related to this game session queue.

pub fn notification_target(self, inp: impl Into<String>) -> Self

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

pub fn set_notification_target(self, input: Option<String>) -> Self

An SNS topic ARN that is set up to receive game session placement notifications. See Setting up notifications for game session placement.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for UpdateGameSessionQueue<C, M, R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.