Struct aws_sdk_gamelift::input::DescribeGameSessionDetailsInput

#[non_exhaustive]
pub struct DescribeGameSessionDetailsInput {
    pub fleet_id: Option<String>,
    pub game_session_id: Option<String>,
    pub alias_id: Option<String>,
    pub location: Option<String>,
    pub status_filter: Option<String>,
    pub limit: Option<i32>,
    pub next_token: Option<String>,
}

Represents the input for a request operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

fleet_id: Option<String>

A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

game_session_id: Option<String>

A unique identifier for the game session to retrieve.

alias_id: Option<String>

A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

location: Option<String>

A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.

status_filter: Option<String>

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

limit: Option<i32>

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

next_token: Option<String>

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Implementations

impl DescribeGameSessionDetailsInput

pub async fn make_operation(
    &self,
    _config: &Config
) -> Result<Operation<DescribeGameSessionDetails, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<DescribeGameSessionDetails>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture DescribeGameSessionDetailsInput

impl DescribeGameSessionDetailsInput

pub fn fleet_id(&self) -> Option<&str>

A unique identifier for the fleet to retrieve all game sessions active on the fleet. You can use either the fleet ID or ARN value.

pub fn game_session_id(&self) -> Option<&str>

A unique identifier for the game session to retrieve.

pub fn alias_id(&self) -> Option<&str>

A unique identifier for the alias associated with the fleet to retrieve all game sessions for. You can use either the alias ID or ARN value.

pub fn location(&self) -> Option<&str>

A fleet location to get game sessions for. You can specify a fleet's home Region or a remote location. Use the Amazon Web Services Region code format, such as us-west-2.

pub fn status_filter(&self) -> Option<&str>

Game session status to filter results on. Possible game session statuses include ACTIVE, TERMINATED, ACTIVATING and TERMINATING (the last two are transitory).

pub fn limit(&self) -> Option<i32>

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

pub fn next_token(&self) -> Option<&str>

A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Trait Implementations

impl Clone for DescribeGameSessionDetailsInput

fn clone(&self) -> DescribeGameSessionDetailsInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeGameSessionDetailsInput

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

Formats the value using the given formatter.

impl PartialEq<DescribeGameSessionDetailsInput> for DescribeGameSessionDetailsInput

fn eq(&self, other: &DescribeGameSessionDetailsInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DescribeGameSessionDetailsInput) -> bool

This method tests for !=.

impl StructuralPartialEq for DescribeGameSessionDetailsInput