Struct aws_sdk_gamelift::client::fluent_builders::StopMatchmaking

pub struct StopMatchmaking { /* private fields */ }

Fluent builder constructing a request to StopMatchmaking.

Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.

If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).

Learn more

Add FlexMatch to a game client

Related actions

StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task

Implementations

impl StopMatchmaking

pub async fn send(
    self
) -> Result<StopMatchmakingOutput, SdkError<StopMatchmakingError>>

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 ticket_id(self, input: impl Into<String>) -> Self

A unique identifier for a matchmaking ticket.

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

A unique identifier for a matchmaking ticket.

Trait Implementations

impl Clone for StopMatchmaking

fn clone(&self) -> StopMatchmaking

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StopMatchmaking

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

Formats the value using the given formatter.