1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeGameSessions`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`fleet_id(impl Into<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::fleet_id) / [`set_fleet_id(Option<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::set_fleet_id):<br>required: **false**<br><p>A unique identifier for the fleet to retrieve game sessions for. You can use either the fleet ID or ARN value.</p><br>
    ///   - [`game_session_id(impl Into<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::game_session_id) / [`set_game_session_id(Option<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::set_game_session_id):<br>required: **false**<br><p>A unique identifier for the game session to retrieve.</p><br>
    ///   - [`alias_id(impl Into<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::alias_id) / [`set_alias_id(Option<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::set_alias_id):<br>required: **false**<br><p>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.</p><br>
    ///   - [`location(impl Into<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::location) / [`set_location(Option<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::set_location):<br>required: **false**<br><p>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 <code>us-west-2</code>.</p><br>
    ///   - [`status_filter(impl Into<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::status_filter) / [`set_status_filter(Option<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::set_status_filter):<br>required: **false**<br><p>Game session status to filter results on. You can filter on the following states: <code>ACTIVE</code>, <code>TERMINATED</code>, <code>ACTIVATING</code>, and <code>TERMINATING</code>. The last two are transitory and used for only very brief periods of time.</p><br>
    ///   - [`limit(i32)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::set_limit):<br>required: **false**<br><p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::set_next_token):<br>required: **false**<br><p>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.</p><br>
    /// - On success, responds with [`DescribeGameSessionsOutput`](crate::operation::describe_game_sessions::DescribeGameSessionsOutput) with field(s):
    ///   - [`game_sessions(Option<Vec::<GameSession>>)`](crate::operation::describe_game_sessions::DescribeGameSessionsOutput::game_sessions): <p>A collection of properties for each game session that matches the request.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::describe_game_sessions::DescribeGameSessionsOutput::next_token): <p>A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.</p>
    /// - On failure, responds with [`SdkError<DescribeGameSessionsError>`](crate::operation::describe_game_sessions::DescribeGameSessionsError)
    pub fn describe_game_sessions(&self) -> crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder {
        crate::operation::describe_game_sessions::builders::DescribeGameSessionsFluentBuilder::new(self.handle.clone())
    }
}