pub struct DescribeGameSessionDetails { /* 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. Alternatively, use SearchGameSessions
to request a set of active game sessions that are filtered by certain criteria. To retrieve all game session properties, use DescribeGameSessions
.
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
Related actions
CreateGameSession
| DescribeGameSessions
| DescribeGameSessionDetails
| SearchGameSessions
| UpdateGameSession
| GetGameSessionLogUrl
| StartGameSessionPlacement
| DescribeGameSessionPlacement
| StopGameSessionPlacement
| All APIs by task
Implementations
sourceimpl DescribeGameSessionDetails
impl DescribeGameSessionDetails
sourcepub async fn send(
self
) -> Result<DescribeGameSessionDetailsOutput, SdkError<DescribeGameSessionDetailsError>>
pub async fn send(
self
) -> Result<DescribeGameSessionDetailsOutput, SdkError<DescribeGameSessionDetailsError>>
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 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 Stream
.
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 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 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 location(self, input: impl Into<String>) -> Self
pub fn location(self, input: impl Into<String>) -> Self
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
.
sourcepub fn set_location(self, input: Option<String>) -> Self
pub fn set_location(self, input: Option<String>) -> Self
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
.
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 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 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.
Trait Implementations
sourceimpl Clone for DescribeGameSessionDetails
impl Clone for DescribeGameSessionDetails
sourcefn clone(&self) -> DescribeGameSessionDetails
fn clone(&self) -> DescribeGameSessionDetails
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for DescribeGameSessionDetails
impl Send for DescribeGameSessionDetails
impl Sync for DescribeGameSessionDetails
impl Unpin for DescribeGameSessionDetails
impl !UnwindSafe for DescribeGameSessionDetails
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more