aws_sdk_ssm/client/
list_nodes_summary.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 [`ListNodesSummary`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`sync_name(impl Into<String>)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::sync_name) / [`set_sync_name(Option<String>)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::set_sync_name):<br>required: **false**<br><p>The name of the Amazon Web Services managed resource data sync to retrieve information about.</p> <p>For cross-account/cross-Region configurations, this parameter is required, and the name of the supported resource data sync is <code>AWS-QuickSetup-ManagedNode</code>.</p> <p>For single account/single-Region configurations, the parameter is not required.</p><br>
8    ///   - [`filters(NodeFilter)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::filters) / [`set_filters(Option<Vec::<NodeFilter>>)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters. Use a filter to generate a summary that matches your specified filter criteria.</p><br>
9    ///   - [`aggregators(NodeAggregator)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::aggregators) / [`set_aggregators(Option<Vec::<NodeAggregator>>)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::set_aggregators):<br>required: **true**<br><p>Specify one or more aggregators to return a count of managed nodes that match that expression. For example, a count of managed nodes by operating system.</p><br>
10    ///   - [`next_token(impl Into<String>)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next set of items to return. (You received this token from a previous call.) The call also returns a token that you can specify in a subsequent call to get the next set of results.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.</p><br>
12    /// - On success, responds with [`ListNodesSummaryOutput`](crate::operation::list_nodes_summary::ListNodesSummaryOutput) with field(s):
13    ///   - [`summary(Option<Vec::<HashMap::<String, String>>>)`](crate::operation::list_nodes_summary::ListNodesSummaryOutput::summary): <p>A collection of objects reporting information about your managed nodes, such as the count of nodes by operating system.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_nodes_summary::ListNodesSummaryOutput::next_token): <p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>
15    /// - On failure, responds with [`SdkError<ListNodesSummaryError>`](crate::operation::list_nodes_summary::ListNodesSummaryError)
16    pub fn list_nodes_summary(&self) -> crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder {
17        crate::operation::list_nodes_summary::builders::ListNodesSummaryFluentBuilder::new(self.handle.clone())
18    }
19}