aws_sdk_gamelift/client/
describe_game_session_queues.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`DescribeGameSessionQueues`](crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`names(impl Into<String>)`](crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder::names) / [`set_names(Option<Vec::<String>>)`](crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder::set_names):<br>required: **false**<br><p>A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty.</p><br>
8    ///   - [`limit(i32)`](crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder::limit) / [`set_limit(Option<i32>)`](crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder::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. You can request up to 50 results.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder::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>
10    /// - On success, responds with [`DescribeGameSessionQueuesOutput`](crate::operation::describe_game_session_queues::DescribeGameSessionQueuesOutput) with field(s):
11    ///   - [`game_session_queues(Option<Vec::<GameSessionQueue>>)`](crate::operation::describe_game_session_queues::DescribeGameSessionQueuesOutput::game_session_queues): <p>A collection of objects that describe the requested game session queues.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::describe_game_session_queues::DescribeGameSessionQueuesOutput::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>
13    /// - On failure, responds with [`SdkError<DescribeGameSessionQueuesError>`](crate::operation::describe_game_session_queues::DescribeGameSessionQueuesError)
14    pub fn describe_game_session_queues(&self) -> crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder {
15        crate::operation::describe_game_session_queues::builders::DescribeGameSessionQueuesFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_gamelift/client/describe_game_session_queues.rs

aws_sdk_gamelift/client/
describe_game_session_queues.rs
