aws_sdk_wellarchitected/client/
list_workloads.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 [`ListWorkloads`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`workload_name_prefix(impl Into<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::workload_name_prefix) / [`set_workload_name_prefix(Option<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::set_workload_name_prefix):<br>required: **false**<br><p>An optional string added to the beginning of each workload name returned in the results.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token to use to retrieve the next set of results.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return for this request.</p><br>
10    /// - On success, responds with [`ListWorkloadsOutput`](crate::operation::list_workloads::ListWorkloadsOutput) with field(s):
11    ///   - [`workload_summaries(Option<Vec::<WorkloadSummary>>)`](crate::operation::list_workloads::ListWorkloadsOutput::workload_summaries): <p>A list of workload summaries.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_workloads::ListWorkloadsOutput::next_token): <p>The token to use to retrieve the next set of results.</p>
13    /// - On failure, responds with [`SdkError<ListWorkloadsError>`](crate::operation::list_workloads::ListWorkloadsError)
14    pub fn list_workloads(&self) -> crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder {
15        crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_wellarchitected/client/list_workloads.rs

aws_sdk_wellarchitected/client/
list_workloads.rs
