aws_sdk_gameliftstreams/client/

list_stream_groups.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListStreamGroups`](crate::operation::list_stream_groups::builders::ListStreamGroupsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_stream_groups::builders::ListStreamGroupsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_stream_groups::builders::ListStreamGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_stream_groups::builders::ListStreamGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_stream_groups::builders::ListStreamGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_stream_groups::builders::ListStreamGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The number of results to return. Use this parameter with <code>NextToken</code> to return results in sequential pages. Default value is <code>25</code>.</p><br>
    /// - On success, responds with [`ListStreamGroupsOutput`](crate::operation::list_stream_groups::ListStreamGroupsOutput) with field(s):
    ///   - [`items(Option<Vec::<StreamGroupSummary>>)`](crate::operation::list_stream_groups::ListStreamGroupsOutput::items): <p>A collection of Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. Each item includes stream group metadata and status, but doesn't include capacity information.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_stream_groups::ListStreamGroupsOutput::next_token): <p>A token that marks the start of the next sequential page of results. If an operation doesn't return a token, you've reached the end of the list.</p>
    /// - On failure, responds with [`SdkError<ListStreamGroupsError>`](crate::operation::list_stream_groups::ListStreamGroupsError)
    pub fn list_stream_groups(&self) -> crate::operation::list_stream_groups::builders::ListStreamGroupsFluentBuilder {
        crate::operation::list_stream_groups::builders::ListStreamGroupsFluentBuilder::new(self.handle.clone())
    }
}