Struct aws_sdk_fsx::client::fluent_builders::DescribeFileSystems

pub struct DescribeFileSystems { /* private fields */ }

Fluent builder constructing a request to DescribeFileSystems.

Returns the description of specific Amazon FSx file systems, if a FileSystemIds value is provided for that file system. Otherwise, it returns descriptions of all file systems owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all file system descriptions, you can optionally specify the MaxResults parameter to limit the number of descriptions in a response. If more file system descriptions remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This operation is used in an iterative process to retrieve a list of your file system descriptions. DescribeFileSystems is called first without a NextTokenvalue. Then the operation continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this operation, keep the following in mind:

• The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

• The order of file systems returned in the response of one DescribeFileSystems call and the order of file systems returned across the responses of a multicall iteration is unspecified.

Implementations

impl DescribeFileSystems

pub async fn send(
    self
) -> Result<DescribeFileSystemsOutput, SdkError<DescribeFileSystemsError>>

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) -> DescribeFileSystemsPaginator

Create a paginator for this request

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

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

Appends an item to FileSystemIds.

To override the contents of this collection use set_file_system_ids.

IDs of the file systems whose descriptions you want to retrieve (String).

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

IDs of the file systems whose descriptions you want to retrieve (String).

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

Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

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

Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

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

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.

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

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the operation continues the list from where the returning call left off.

Trait Implementations

impl Clone for DescribeFileSystems

fn clone(&self) -> DescribeFileSystems

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeFileSystems

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

Formats the value using the given formatter.