aws_sdk_applicationinsights/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    ///   - [`resource_group_name(impl Into<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::resource_group_name) / [`set_resource_group_name(Option<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::set_resource_group_name):<br>required: **true**<br><p>The name of the resource group.</p><br>
8    ///   - [`component_name(impl Into<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::component_name) / [`set_component_name(Option<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::set_component_name):<br>required: **true**<br><p>The name of the component.</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 in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p><br>
10    ///   - [`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 request the next page of results.</p><br>
11    ///   - [`account_id(impl Into<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::account_id) / [`set_account_id(Option<String>)`](crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::set_account_id):<br>required: **false**<br><p>The Amazon Web Services account ID of the owner of the workload.</p><br>
12    /// - On success, responds with [`ListWorkloadsOutput`](crate::operation::list_workloads::ListWorkloadsOutput) with field(s):
13    ///   - [`workload_list(Option<Vec::<Workload>>)`](crate::operation::list_workloads::ListWorkloadsOutput::workload_list): <p>The list of workloads.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_workloads::ListWorkloadsOutput::next_token): <p>The token to request the next page of results.</p>
15    /// - On failure, responds with [`SdkError<ListWorkloadsError>`](crate::operation::list_workloads::ListWorkloadsError)
16    pub fn list_workloads(&self) -> crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder {
17        crate::operation::list_workloads::builders::ListWorkloadsFluentBuilder::new(self.handle.clone())
18    }
19}