aws_sdk_s3outposts/client/
list_outposts_with_s3.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListOutpostsWithS3`](crate::operation::list_outposts_with_s3::builders::ListOutpostsWithS3FluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_outposts_with_s3::builders::ListOutpostsWithS3FluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_outposts_with_s3::builders::ListOutpostsWithS3FluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_outposts_with_s3::builders::ListOutpostsWithS3FluentBuilder::set_next_token):<br>required: **false**<br><p>When you can get additional results from the <code>ListOutpostsWithS3</code> call, a <code>NextToken</code> parameter is returned in the output. You can then pass in a subsequent command to the <code>NextToken</code> parameter to continue listing additional Outposts.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_outposts_with_s3::builders::ListOutpostsWithS3FluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_outposts_with_s3::builders::ListOutpostsWithS3FluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of Outposts to return. The limit is 100.</p><br>
    /// - On success, responds with [`ListOutpostsWithS3Output`](crate::operation::list_outposts_with_s3::ListOutpostsWithS3Output) with field(s):
    ///   - [`outposts(Option<Vec::<Outpost>>)`](crate::operation::list_outposts_with_s3::ListOutpostsWithS3Output::outposts): <p>Returns the list of Outposts that have the following characteristics:</p> <ul>  <li>   <p>outposts that have S3 provisioned</p></li>  <li>   <p>outposts that are <code>Active</code> (not pending any provisioning nor decommissioned)</p></li>  <li>   <p>outposts to which the the calling Amazon Web Services account has access</p></li> </ul>
    ///   - [`next_token(Option<String>)`](crate::operation::list_outposts_with_s3::ListOutpostsWithS3Output::next_token): <p>Returns a token that you can use to call <code>ListOutpostsWithS3</code> again and receive additional results, if there are any.</p>
    /// - On failure, responds with [`SdkError<ListOutpostsWithS3Error>`](crate::operation::list_outposts_with_s3::ListOutpostsWithS3Error)
    pub fn list_outposts_with_s3(&self) -> crate::operation::list_outposts_with_s3::builders::ListOutpostsWithS3FluentBuilder {
        crate::operation::list_outposts_with_s3::builders::ListOutpostsWithS3FluentBuilder::new(self.handle.clone())
    }
}