aws_sdk_datasync/client/
list_locations.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 [`ListLocations`](crate::operation::list_locations::builders::ListLocationsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`max_results(i32)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of locations to return.</p><br>
8    ///   - [`next_token(impl Into<String>)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::set_next_token):<br>required: **false**<br><p>An opaque string that indicates the position at which to begin the next list of locations.</p><br>
9    ///   - [`filters(LocationFilter)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::filters) / [`set_filters(Option<Vec::<LocationFilter>>)`](crate::operation::list_locations::builders::ListLocationsFluentBuilder::set_filters):<br>required: **false**<br><p>You can use API filters to narrow down the list of resources returned by <code>ListLocations</code>. For example, to retrieve all tasks on a specific source location, you can use <code>ListLocations</code> with filter name <code>LocationType S3</code> and <code>Operator Equals</code>.</p><br>
10    /// - On success, responds with [`ListLocationsOutput`](crate::operation::list_locations::ListLocationsOutput) with field(s):
11    ///   - [`locations(Option<Vec::<LocationListEntry>>)`](crate::operation::list_locations::ListLocationsOutput::locations): <p>An array that contains a list of locations.</p>
12    ///   - [`next_token(Option<String>)`](crate::operation::list_locations::ListLocationsOutput::next_token): <p>An opaque string that indicates the position at which to begin returning the next list of locations.</p>
13    /// - On failure, responds with [`SdkError<ListLocationsError>`](crate::operation::list_locations::ListLocationsError)
14    pub fn list_locations(&self) -> crate::operation::list_locations::builders::ListLocationsFluentBuilder {
15        crate::operation::list_locations::builders::ListLocationsFluentBuilder::new(self.handle.clone())
16    }
17}
aws_sdk_datasync/client/list_locations.rs

aws_sdk_datasync/client/
list_locations.rs
