aws_sdk_pcs/client/list_compute_node_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 [`ListComputeNodeGroups`](crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`cluster_identifier(impl Into<String>)`](crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder::cluster_identifier) / [`set_cluster_identifier(Option<String>)`](crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder::set_cluster_identifier):<br>required: **true**<br><p>The name or ID of the cluster to list compute node groups for.</p><br>
8 /// - [`next_token(impl Into<String>)`](crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>The value of <code>nextToken</code> is a unique pagination token for each page of results returned. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code> error.</p><br>
9 /// - [`max_results(i32)`](crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results that are returned per call. You can use <code>nextToken</code> to obtain further pages of results. The default is 10 results, and the maximum allowed page size is 100 results. A value of 0 uses the default.</p><br>
10 /// - On success, responds with [`ListComputeNodeGroupsOutput`](crate::operation::list_compute_node_groups::ListComputeNodeGroupsOutput) with field(s):
11 /// - [`compute_node_groups(Vec::<ComputeNodeGroupSummary>)`](crate::operation::list_compute_node_groups::ListComputeNodeGroupsOutput::compute_node_groups): <p>The list of compute node groups for the cluster.</p>
12 /// - [`next_token(Option<String>)`](crate::operation::list_compute_node_groups::ListComputeNodeGroupsOutput::next_token): <p>The value of <code>nextToken</code> is a unique pagination token for each page of results returned. If <code>nextToken</code> is returned, there are more results available. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token returns an <code>HTTP 400 InvalidToken</code> error.</p>
13 /// - On failure, responds with [`SdkError<ListComputeNodeGroupsError>`](crate::operation::list_compute_node_groups::ListComputeNodeGroupsError)
14 pub fn list_compute_node_groups(&self) -> crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder {
15 crate::operation::list_compute_node_groups::builders::ListComputeNodeGroupsFluentBuilder::new(self.handle.clone())
16 }
17}