aws_sdk_wickr/client/
list_security_groups.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 [`ListSecurityGroups`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`network_id(impl Into<String>)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::network_id) / [`set_network_id(Option<String>)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::set_network_id):<br>required: **true**<br><p>The ID of the Wickr network from which to list security groups.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for retrieving the next page of results. This is returned from a previous request when there are more results available.</p><br>
9    ///   - [`max_results(i32)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of security groups to return in a single page. Valid range is 1-100. Default is 10.</p><br>
10    ///   - [`sort_fields(impl Into<String>)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::sort_fields) / [`set_sort_fields(Option<String>)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::set_sort_fields):<br>required: **false**<br><p>The field to sort security groups by. Accepted values include 'id' and 'name'.</p><br>
11    ///   - [`sort_direction(SortDirection)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::sort_direction) / [`set_sort_direction(Option<SortDirection>)`](crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::set_sort_direction):<br>required: **false**<br><p>The direction to sort results. Valid values are 'ASC' (ascending) or 'DESC' (descending). Default is 'DESC'.</p><br>
12    /// - On success, responds with [`ListSecurityGroupsOutput`](crate::operation::list_security_groups::ListSecurityGroupsOutput) with field(s):
13    ///   - [`security_groups(Option<Vec::<SecurityGroup>>)`](crate::operation::list_security_groups::ListSecurityGroupsOutput::security_groups): <p>A list of security group objects in the current page.</p>
14    ///   - [`next_token(Option<String>)`](crate::operation::list_security_groups::ListSecurityGroupsOutput::next_token): <p>The token to use for retrieving the next page of results. If this is not present, there are no more results.</p>
15    /// - On failure, responds with [`SdkError<ListSecurityGroupsError>`](crate::operation::list_security_groups::ListSecurityGroupsError)
16    pub fn list_security_groups(&self) -> crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder {
17        crate::operation::list_security_groups::builders::ListSecurityGroupsFluentBuilder::new(self.handle.clone())
18    }
19}
aws_sdk_wickr/client/list_security_groups.rs

aws_sdk_wickr/client/
list_security_groups.rs
