aws_sdk_finspace/client/list_kx_scaling_groups.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 [`ListKxScalingGroups`](crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`environment_id(impl Into<String>)`](crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder::environment_id) / [`set_environment_id(Option<String>)`](crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder::set_environment_id):<br>required: **true**<br><p>A unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return in this request.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>A token that indicates where a results page should begin.</p><br>
10 /// - On success, responds with [`ListKxScalingGroupsOutput`](crate::operation::list_kx_scaling_groups::ListKxScalingGroupsOutput) with field(s):
11 /// - [`scaling_groups(Option<Vec::<KxScalingGroup>>)`](crate::operation::list_kx_scaling_groups::ListKxScalingGroupsOutput::scaling_groups): <p>A list of scaling groups available in a kdb environment.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_kx_scaling_groups::ListKxScalingGroupsOutput::next_token): <p>A token that indicates where a results page should begin.</p>
13 /// - On failure, responds with [`SdkError<ListKxScalingGroupsError>`](crate::operation::list_kx_scaling_groups::ListKxScalingGroupsError)
14 pub fn list_kx_scaling_groups(&self) -> crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder {
15 crate::operation::list_kx_scaling_groups::builders::ListKxScalingGroupsFluentBuilder::new(self.handle.clone())
16 }
17}