aws_sdk_ec2/client/
describe_prefix_lists.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 [`DescribePrefixLists`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`dry_run(bool)`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
8    ///   - [`filters(Filter)`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::filters) / [`set_filters(Option<Vec::<Filter>>)`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::set_filters):<br>required: **false**<br><p>One or more filters.</p> <ul>  <li>   <p><code>prefix-list-id</code>: The ID of a prefix list.</p></li>  <li>   <p><code>prefix-list-name</code>: The name of a prefix list.</p></li> </ul><br>
9    ///   - [`max_results(i32)`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of results to return with 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::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::set_next_token):<br>required: **false**<br><p>The token for the next page of results.</p><br>
11    ///   - [`prefix_list_ids(impl Into<String>)`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::prefix_list_ids) / [`set_prefix_list_ids(Option<Vec::<String>>)`](crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::set_prefix_list_ids):<br>required: **false**<br><p>One or more prefix list IDs.</p><br>
12    /// - On success, responds with [`DescribePrefixListsOutput`](crate::operation::describe_prefix_lists::DescribePrefixListsOutput) with field(s):
13    ///   - [`next_token(Option<String>)`](crate::operation::describe_prefix_lists::DescribePrefixListsOutput::next_token): <p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>
14    ///   - [`prefix_lists(Option<Vec::<PrefixList>>)`](crate::operation::describe_prefix_lists::DescribePrefixListsOutput::prefix_lists): <p>All available prefix lists.</p>
15    /// - On failure, responds with [`SdkError<DescribePrefixListsError>`](crate::operation::describe_prefix_lists::DescribePrefixListsError)
16    pub fn describe_prefix_lists(&self) -> crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder {
17        crate::operation::describe_prefix_lists::builders::DescribePrefixListsFluentBuilder::new(self.handle.clone())
18    }
19}