aws_sdk_resourcegroups/client/

list_groups.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListGroups`](crate::operation::list_groups::builders::ListGroupsFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`filters(GroupFilter)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::filters) / [`set_filters(Option<Vec::<GroupFilter>>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::set_filters):<br>required: **false**<br><p>Filters, formatted as <code>GroupFilter</code> objects, that you want to apply to a <code>ListGroups</code> operation.</p> <ul>  <li>   <p><code>resource-type</code> - Filter the results to include only those resource groups that have the specified resource type in their <code>ResourceTypeFilter</code>. For example, <code>AWS::EC2::Instance</code> would return any resource group with a <code>ResourceTypeFilter</code> that includes <code>AWS::EC2::Instance</code>.</p></li>  <li>   <p><code>configuration-type</code> - Filter the results to include only those groups that have the specified configuration types attached. The current supported values are:</p>   <ul>    <li>     <p><code>AWS::ResourceGroups::ApplicationGroup</code></p></li>    <li>     <p><code>AWS::AppRegistry::Application</code></p></li>    <li>     <p><code>AWS::AppRegistry::ApplicationResourceGroup</code></p></li>    <li>     <p><code>AWS::CloudFormation::Stack</code></p></li>    <li>     <p><code>AWS::EC2::CapacityReservationPool</code></p></li>    <li>     <p><code>AWS::EC2::HostManagement</code></p></li>    <li>     <p><code>AWS::NetworkFirewall::RuleGroup</code></p></li>   </ul></li> </ul><br>
    ///   - [`max_results(i32)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the maximum you specify, the <code>NextToken</code> response element is present and has a value (is not null). Include that value as the <code>NextToken</code> request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check <code>NextToken</code> after every operation to ensure that you receive all of the results.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_groups::builders::ListGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>The parameter for receiving additional results if you receive a <code>NextToken</code> response in a previous request. A <code>NextToken</code> response indicates that more output is available. Set this parameter to the value provided by a previous call's <code>NextToken</code> response to indicate where the output should continue from.</p><br>
    /// - On success, responds with [`ListGroupsOutput`](crate::operation::list_groups::ListGroupsOutput) with field(s):
    ///   - [`group_identifiers(Option<Vec::<GroupIdentifier>>)`](crate::operation::list_groups::ListGroupsOutput::group_identifiers): <p>A list of <code>GroupIdentifier</code> objects. Each identifier is an object that contains both the <code>Name</code> and the <code>GroupArn</code>.</p>
    ///   - [`groups(Option<Vec::<Group>>)`](crate::operation::list_groups::ListGroupsOutput::groups): <important>  <p><i> <b>Deprecated - don't use this field. Use the <code>GroupIdentifiers</code> response field instead.</b> </i></p> </important>
    ///   - [`next_token(Option<String>)`](crate::operation::list_groups::ListGroupsOutput::next_token): <p>If present, indicates that more output is available than is included in the current response. Use this value in the <code>NextToken</code> request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the <code>NextToken</code> response element comes back as <code>null</code>.</p>
    /// - On failure, responds with [`SdkError<ListGroupsError>`](crate::operation::list_groups::ListGroupsError)
    pub fn list_groups(&self) -> crate::operation::list_groups::builders::ListGroupsFluentBuilder {
        crate::operation::list_groups::builders::ListGroupsFluentBuilder::new(self.handle.clone())
    }
}