Struct aws_sdk_datasync::client::fluent_builders::ListLocations

pub struct ListLocations { /* private fields */ }

Fluent builder constructing a request to ListLocations.

Returns a list of source and destination locations.

If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.

Implementations

impl ListLocations

pub async fn send(
    self
) -> Result<ListLocationsOutput, SdkError<ListLocationsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> ListLocationsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn max_results(self, input: i32) -> Self

The maximum number of locations to return.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of locations to return.

pub fn next_token(self, input: impl Into<String>) -> Self

An opaque string that indicates the position at which to begin the next list of locations.

pub fn set_next_token(self, input: Option<String>) -> Self

An opaque string that indicates the position at which to begin the next list of locations.

pub fn filters(self, input: LocationFilter) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

pub fn set_filters(self, input: Option<Vec<LocationFilter>>) -> Self

You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all tasks on a specific source location, you can use ListLocations with filter name LocationType S3 and Operator Equals.

Trait Implementations

impl Clone for ListLocations

fn clone(&self) -> ListLocations

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListLocations

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.