Struct aws_sdk_gamelift::client::fluent_builders::DescribeGameSessionPlacement

pub struct DescribeGameSessionPlacement { /* private fields */ }

Fluent builder constructing a request to DescribeGameSessionPlacement.

Retrieves information, including current status, about a game session placement request.

To get game session placement details, specify the placement ID.

This operation is not designed to be continually called to track game session status. This practice can cause you to exceed your API limit, which results in errors. Instead, you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or queues. Continuously polling with DescribeGameSessionPlacement should only be used for games in development with low game session usage.

If successful, a GameSessionPlacement object is returned.

Related actions

CreateGameSession | DescribeGameSessions | DescribeGameSessionDetails | SearchGameSessions | UpdateGameSession | GetGameSessionLogUrl | StartGameSessionPlacement | DescribeGameSessionPlacement | StopGameSessionPlacement | All APIs by task

Implementations

impl DescribeGameSessionPlacement

pub async fn send(
    self
) -> Result<DescribeGameSessionPlacementOutput, SdkError<DescribeGameSessionPlacementError>>

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

A unique identifier for a game session placement to retrieve.

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

A unique identifier for a game session placement to retrieve.

Trait Implementations

impl Clone for DescribeGameSessionPlacement

fn clone(&self) -> DescribeGameSessionPlacement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeGameSessionPlacement

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

Formats the value using the given formatter.