Struct aws_sdk_gamelift::input::DescribeGameSessionsInput [−][src]
#[non_exhaustive]pub struct DescribeGameSessionsInput {
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>,
}
Expand description
Represents the input for a request operation.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
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 game sessions for. 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 game sessions for. You can use either the alias ID or ARN value.
location: Option<String>
A fleet location to get game session details for. You can specify a fleet's home
Region or a remote location. Use the AWS Region code format, such as
us-west-2
.
status_filter: Option<String>
Game session status to filter results on. You can filter on the following states:
ACTIVE
, TERMINATED
, ACTIVATING
, and
TERMINATING
. The last two are transitory and used for only very brief
periods of time.
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
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<DescribeGameSessions, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<DescribeGameSessions, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<DescribeGameSessions
>
Creates a new builder-style object to manufacture DescribeGameSessionsInput
A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.
A unique identifier for the game session to retrieve.
A unique identifier for the alias associated with the fleet to retrieve game sessions for. You can use either the alias ID or ARN value.
A fleet location to get game session details for. You can specify a fleet's home
Region or a remote location. Use the AWS Region code format, such as
us-west-2
.
Game session status to filter results on. You can filter on the following states:
ACTIVE
, TERMINATED
, ACTIVATING
, and
TERMINATING
. The last two are transitory and used for only very brief
periods of time.
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
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
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for DescribeGameSessionsInput
impl Send for DescribeGameSessionsInput
impl Sync for DescribeGameSessionsInput
impl Unpin for DescribeGameSessionsInput
impl UnwindSafe for DescribeGameSessionsInput
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more