aws_sdk_outposts/client/list_outposts.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 [`ListOutposts`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder) operation.
4 /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::into_paginator).
5 ///
6 /// - The fluent builder is configurable:
7 /// - [`next_token(impl Into<String>)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::set_next_token):<br>required: **false**<br><p>The pagination token.</p><br>
8 /// - [`max_results(i32)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum page size.</p><br>
9 /// - [`life_cycle_status_filter(impl Into<String>)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::life_cycle_status_filter) / [`set_life_cycle_status_filter(Option<Vec::<String>>)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::set_life_cycle_status_filter):<br>required: **false**<br><p>Filters the results by the lifecycle status.</p><br>
10 /// - [`availability_zone_filter(impl Into<String>)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::availability_zone_filter) / [`set_availability_zone_filter(Option<Vec::<String>>)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::set_availability_zone_filter):<br>required: **false**<br><p>Filters the results by Availability Zone (for example, <code>us-east-1a</code>).</p><br>
11 /// - [`availability_zone_id_filter(impl Into<String>)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::availability_zone_id_filter) / [`set_availability_zone_id_filter(Option<Vec::<String>>)`](crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::set_availability_zone_id_filter):<br>required: **false**<br><p>Filters the results by AZ ID (for example, <code>use1-az1</code>).</p><br>
12 /// - On success, responds with [`ListOutpostsOutput`](crate::operation::list_outposts::ListOutpostsOutput) with field(s):
13 /// - [`outposts(Option<Vec::<Outpost>>)`](crate::operation::list_outposts::ListOutpostsOutput::outposts): <p>Information about the Outposts.</p>
14 /// - [`next_token(Option<String>)`](crate::operation::list_outposts::ListOutpostsOutput::next_token): <p>The pagination token.</p>
15 /// - On failure, responds with [`SdkError<ListOutpostsError>`](crate::operation::list_outposts::ListOutpostsError)
16 pub fn list_outposts(&self) -> crate::operation::list_outposts::builders::ListOutpostsFluentBuilder {
17 crate::operation::list_outposts::builders::ListOutpostsFluentBuilder::new(self.handle.clone())
18 }
19}