aws_sdk_memorydb/client/describe_subnet_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 [`DescribeSubnetGroups`](crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`subnet_group_name(impl Into<String>)`](crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder::subnet_group_name) / [`set_subnet_group_name(Option<String>)`](crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder::set_subnet_group_name):<br>required: **false**<br><p>The name of the subnet group to return details for.</p><br>
8 /// - [`max_results(i32)`](crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.</p><br>
9 /// - [`next_token(impl Into<String>)`](crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder::set_next_token):<br>required: **false**<br><p>An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p><br>
10 /// - On success, responds with [`DescribeSubnetGroupsOutput`](crate::operation::describe_subnet_groups::DescribeSubnetGroupsOutput) with field(s):
11 /// - [`next_token(Option<String>)`](crate::operation::describe_subnet_groups::DescribeSubnetGroupsOutput::next_token): <p>An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.</p>
12 /// - [`subnet_groups(Option<Vec::<SubnetGroup>>)`](crate::operation::describe_subnet_groups::DescribeSubnetGroupsOutput::subnet_groups): <p>A list of subnet groups. Each element in the list contains detailed information about one group.</p>
13 /// - On failure, responds with [`SdkError<DescribeSubnetGroupsError>`](crate::operation::describe_subnet_groups::DescribeSubnetGroupsError)
14 pub fn describe_subnet_groups(&self) -> crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder {
15 crate::operation::describe_subnet_groups::builders::DescribeSubnetGroupsFluentBuilder::new(self.handle.clone())
16 }
17}