aws_sdk_eks/client/
list_nodegroups.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 [`ListNodegroups`](crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`cluster_name(impl Into<String>)`](crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder::cluster_name) / [`set_cluster_name(Option<String>)`](crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder::set_cluster_name):<br>required: **true**<br><p>The name of your cluster.</p><br>
8    ///   - [`max_results(i32)`](crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results, returned in paginated output. You receive <code>maxResults</code> in a single page, along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, 100 results and a <code>nextToken</code> value, if applicable, are returned.</p><br>
9    ///   - [`next_token(impl Into<String>)`](crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a previous paginated request, where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is null when there are no more results to return.</p><note>  <p>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</p> </note><br>
10    /// - On success, responds with [`ListNodegroupsOutput`](crate::operation::list_nodegroups::ListNodegroupsOutput) with field(s):
11    ///   - [`nodegroups(Option<Vec::<String>>)`](crate::operation::list_nodegroups::ListNodegroupsOutput::nodegroups): <p>A list of all of the node groups associated with the specified cluster.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_nodegroups::ListNodegroupsOutput::next_token): <p>The <code>nextToken</code> value returned from a previous paginated request, where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is null when there are no more results to return.</p><note>  <p>This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.</p> </note>
13    /// - On failure, responds with [`SdkError<ListNodegroupsError>`](crate::operation::list_nodegroups::ListNodegroupsError)
14    pub fn list_nodegroups(&self) -> crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder {
15        crate::operation::list_nodegroups::builders::ListNodegroupsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_eks/client/list_nodegroups.rs

aws_sdk_eks/client/
list_nodegroups.rs
