aws_sdk_codeguruprofiler/client/

list_profiling_groups.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListProfilingGroups`](crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>The <code>nextToken</code> value returned from a previous paginated <code>ListProfilingGroups</code> 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.</p><note>  <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note><br>
    ///   - [`max_results(i32)`](crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of profiling groups results returned by <code>ListProfilingGroups</code> in paginated output. When this parameter is used, <code>ListProfilingGroups</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListProfilingGroups</code> request with the returned <code>nextToken</code> value.</p><br>
    ///   - [`include_description(bool)`](crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder::include_description) / [`set_include_description(Option<bool>)`](crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder::set_include_description):<br>required: **false**<br><p>A <code>Boolean</code> value indicating whether to include a description. If <code>true</code>, then a list of <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"> <code>ProfilingGroupDescription</code> </a> objects that contain detailed information about profiling groups is returned. If <code>false</code>, then a list of profiling group names is returned.</p><br>
    /// - On success, responds with [`ListProfilingGroupsOutput`](crate::operation::list_profiling_groups::ListProfilingGroupsOutput) with field(s):
    ///   - [`profiling_group_names(Vec::<String>)`](crate::operation::list_profiling_groups::ListProfilingGroupsOutput::profiling_group_names): <p>A returned list of profiling group names. A list of the names is returned only if <code>includeDescription</code> is <code>false</code>, otherwise a list of <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"> <code>ProfilingGroupDescription</code> </a> objects is returned.</p>
    ///   - [`profiling_groups(Option<Vec::<ProfilingGroupDescription>>)`](crate::operation::list_profiling_groups::ListProfilingGroupsOutput::profiling_groups): <p>A returned list <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"> <code>ProfilingGroupDescription</code> </a> objects. A list of <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"> <code>ProfilingGroupDescription</code> </a> objects is returned only if <code>includeDescription</code> is <code>true</code>, otherwise a list of profiling group names is returned.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_profiling_groups::ListProfilingGroupsOutput::next_token): <p>The <code>nextToken</code> value to include in a future <code>ListProfilingGroups</code> request. When the results of a <code>ListProfilingGroups</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
    /// - On failure, responds with [`SdkError<ListProfilingGroupsError>`](crate::operation::list_profiling_groups::ListProfilingGroupsError)
    pub fn list_profiling_groups(&self) -> crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder {
        crate::operation::list_profiling_groups::builders::ListProfilingGroupsFluentBuilder::new(self.handle.clone())
    }
}