Struct aws_sdk_gamelift::operation::describe_game_session_details::builders::DescribeGameSessionDetailsFluentBuilder
source · pub struct DescribeGameSessionDetailsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DescribeGameSessionDetails
.
Retrieves additional game session properties, including the game session protection policy in force, a set of one or more game sessions in a specific fleet location. You can optionally filter the results by current game session status.
This operation can be used in the following ways:
-
To retrieve details for all game sessions that are currently running on all locations in a fleet, provide a fleet or alias ID, with an optional status filter. This approach returns details from the fleet's home Region and all remote locations.
-
To retrieve details for all game sessions that are currently running on a specific fleet location, provide a fleet or alias ID and a location name, with optional status filter. The location can be the fleet's home Region or any remote location.
-
To retrieve details for a specific game session, provide the game session ID. This approach looks for the game session ID in all fleets that reside in the Amazon Web Services Region defined in the request.
Use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a GameSessionDetail
object is returned for each game session that matches the request.
Learn more
Implementations§
source§impl DescribeGameSessionDetailsFluentBuilder
impl DescribeGameSessionDetailsFluentBuilder
sourcepub fn as_input(&self) -> &DescribeGameSessionDetailsInputBuilder
pub fn as_input(&self) -> &DescribeGameSessionDetailsInputBuilder
Access the DescribeGameSessionDetails as a reference.
sourcepub async fn send(
self
) -> Result<DescribeGameSessionDetailsOutput, SdkError<DescribeGameSessionDetailsError, HttpResponse>>
pub async fn send( self ) -> Result<DescribeGameSessionDetailsOutput, SdkError<DescribeGameSessionDetailsError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<DescribeGameSessionDetailsOutput, DescribeGameSessionDetailsError, Self>
pub fn customize( self ) -> CustomizableOperation<DescribeGameSessionDetailsOutput, DescribeGameSessionDetailsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> DescribeGameSessionDetailsPaginator
pub fn into_paginator(self) -> DescribeGameSessionDetailsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn fleet_id(self, input: impl Into<String>) -> Self
pub fn fleet_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_fleet_id(self, input: Option<String>) -> Self
pub fn set_fleet_id(self, input: Option<String>) -> Self
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.
sourcepub fn get_fleet_id(&self) -> &Option<String>
pub fn get_fleet_id(&self) -> &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.
sourcepub fn game_session_id(self, input: impl Into<String>) -> Self
pub fn game_session_id(self, input: impl Into<String>) -> Self
A unique identifier for the game session to retrieve.
sourcepub fn set_game_session_id(self, input: Option<String>) -> Self
pub fn set_game_session_id(self, input: Option<String>) -> Self
A unique identifier for the game session to retrieve.
sourcepub fn get_game_session_id(&self) -> &Option<String>
pub fn get_game_session_id(&self) -> &Option<String>
A unique identifier for the game session to retrieve.
sourcepub fn alias_id(self, input: impl Into<String>) -> Self
pub fn alias_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_alias_id(self, input: Option<String>) -> Self
pub fn set_alias_id(self, input: Option<String>) -> Self
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.
sourcepub fn get_alias_id(&self) -> &Option<String>
pub fn get_alias_id(&self) -> &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.
sourcepub fn location(self, input: impl Into<String>) -> Self
pub fn location(self, input: impl Into<String>) -> Self
A fleet location to get game session details 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
.
sourcepub fn set_location(self, input: Option<String>) -> Self
pub fn set_location(self, input: Option<String>) -> Self
A fleet location to get game session details 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
.
sourcepub fn get_location(&self) -> &Option<String>
pub fn get_location(&self) -> &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 Amazon Web Services Region code format, such as us-west-2
.
sourcepub fn status_filter(self, input: impl Into<String>) -> Self
pub fn status_filter(self, input: impl Into<String>) -> Self
Game session status to filter results on. Possible game session statuses include ACTIVE
, TERMINATED
, ACTIVATING
and TERMINATING
(the last two are transitory).
sourcepub fn set_status_filter(self, input: Option<String>) -> Self
pub fn set_status_filter(self, input: Option<String>) -> Self
Game session status to filter results on. Possible game session statuses include ACTIVE
, TERMINATED
, ACTIVATING
and TERMINATING
(the last two are transitory).
sourcepub fn get_status_filter(&self) -> &Option<String>
pub fn get_status_filter(&self) -> &Option<String>
Game session status to filter results on. Possible game session statuses include ACTIVE
, TERMINATED
, ACTIVATING
and TERMINATING
(the last two are transitory).
sourcepub fn limit(self, input: i32) -> Self
pub fn limit(self, input: i32) -> Self
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
sourcepub fn set_limit(self, input: Option<i32>) -> Self
pub fn set_limit(self, input: Option<i32>) -> Self
The maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
sourcepub fn get_limit(&self) -> &Option<i32>
pub fn get_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.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
pub fn next_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
pub fn set_next_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &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.
Trait Implementations§
source§impl Clone for DescribeGameSessionDetailsFluentBuilder
impl Clone for DescribeGameSessionDetailsFluentBuilder
source§fn clone(&self) -> DescribeGameSessionDetailsFluentBuilder
fn clone(&self) -> DescribeGameSessionDetailsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for DescribeGameSessionDetailsFluentBuilder
impl !RefUnwindSafe for DescribeGameSessionDetailsFluentBuilder
impl Send for DescribeGameSessionDetailsFluentBuilder
impl Sync for DescribeGameSessionDetailsFluentBuilder
impl Unpin for DescribeGameSessionDetailsFluentBuilder
impl !UnwindSafe for DescribeGameSessionDetailsFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more