Struct aws_sdk_fsx::operation::describe_file_systems::builders::DescribeFileSystemsFluentBuilder
source · pub struct DescribeFileSystemsFluentBuilder { /* private fields */ }
Expand description
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 NextToken
value. 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 aNextToken
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§
source§impl DescribeFileSystemsFluentBuilder
impl DescribeFileSystemsFluentBuilder
sourcepub fn as_input(&self) -> &DescribeFileSystemsInputBuilder
pub fn as_input(&self) -> &DescribeFileSystemsInputBuilder
Access the DescribeFileSystems as a reference.
sourcepub async fn send(
self
) -> Result<DescribeFileSystemsOutput, SdkError<DescribeFileSystemsError, HttpResponse>>
pub async fn send( self ) -> Result<DescribeFileSystemsOutput, SdkError<DescribeFileSystemsError, HttpResponse>>
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.
sourcepub fn customize(
self
) -> CustomizableOperation<DescribeFileSystemsOutput, DescribeFileSystemsError, Self>
pub fn customize( self ) -> CustomizableOperation<DescribeFileSystemsOutput, DescribeFileSystemsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> DescribeFileSystemsPaginator
pub fn into_paginator(self) -> DescribeFileSystemsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn file_system_ids(self, input: impl Into<String>) -> Self
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).
sourcepub fn set_file_system_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_file_system_ids(self, input: Option<Vec<String>>) -> Self
IDs of the file systems whose descriptions you want to retrieve (String).
sourcepub fn get_file_system_ids(&self) -> &Option<Vec<String>>
pub fn get_file_system_ids(&self) -> &Option<Vec<String>>
IDs of the file systems whose descriptions you want to retrieve (String).
sourcepub fn max_results(self, input: i32) -> Self
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.
sourcepub fn set_max_results(self, input: Option<i32>) -> Self
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.
sourcepub fn get_max_results(&self) -> &Option<i32>
pub fn get_max_results(&self) -> &Option<i32>
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.
sourcepub fn next_token(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_next_token(self, input: Option<String>) -> Self
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.
sourcepub fn get_next_token(&self) -> &Option<String>
pub fn get_next_token(&self) -> &Option<String>
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§
source§impl Clone for DescribeFileSystemsFluentBuilder
impl Clone for DescribeFileSystemsFluentBuilder
source§fn clone(&self) -> DescribeFileSystemsFluentBuilder
fn clone(&self) -> DescribeFileSystemsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for DescribeFileSystemsFluentBuilder
impl !RefUnwindSafe for DescribeFileSystemsFluentBuilder
impl Send for DescribeFileSystemsFluentBuilder
impl Sync for DescribeFileSystemsFluentBuilder
impl Unpin for DescribeFileSystemsFluentBuilder
impl !UnwindSafe for DescribeFileSystemsFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more