pub struct DescribeBackupsFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to DescribeBackups
.
Returns the description of a specific Amazon FSx backup, if a BackupIds
value is provided for that backup. Otherwise, it returns all backups owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.
When retrieving all backups, you can optionally specify the MaxResults
parameter to limit the number of backups in a response. If more backups 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 the NextToken
value from the last response.
This operation is used in an iterative process to retrieve a list of your backups. DescribeBackups
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
value.
When using this operation, keep the following in mind:
-
The operation might return fewer than the
MaxResults
value of backup descriptions while still including aNextToken
value. -
The order of the backups returned in the response of one
DescribeBackups
call and the order of the backups returned across the responses of a multi-call iteration is unspecified.
Implementations§
source§impl DescribeBackupsFluentBuilder
impl DescribeBackupsFluentBuilder
sourcepub fn as_input(&self) -> &DescribeBackupsInputBuilder
pub fn as_input(&self) -> &DescribeBackupsInputBuilder
Access the DescribeBackups as a reference.
sourcepub async fn send(
self
) -> Result<DescribeBackupsOutput, SdkError<DescribeBackupsError, HttpResponse>>
pub async fn send( self ) -> Result<DescribeBackupsOutput, SdkError<DescribeBackupsError, 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<DescribeBackupsOutput, DescribeBackupsError, Self>
pub fn customize( self ) -> CustomizableOperation<DescribeBackupsOutput, DescribeBackupsError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn into_paginator(self) -> DescribeBackupsPaginator
pub fn into_paginator(self) -> DescribeBackupsPaginator
Create a paginator for this request
Paginators are used by calling send().await
which returns a PaginationStream
.
sourcepub fn backup_ids(self, input: impl Into<String>) -> Self
pub fn backup_ids(self, input: impl Into<String>) -> Self
Appends an item to BackupIds
.
To override the contents of this collection use set_backup_ids
.
The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound
error occurs.
sourcepub fn set_backup_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_backup_ids(self, input: Option<Vec<String>>) -> Self
The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound
error occurs.
sourcepub fn get_backup_ids(&self) -> &Option<Vec<String>>
pub fn get_backup_ids(&self) -> &Option<Vec<String>>
The IDs of the backups that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a BackupNotFound
error occurs.
sourcepub fn filters(self, input: Filter) -> Self
pub fn filters(self, input: Filter) -> Self
Appends an item to Filters
.
To override the contents of this collection use set_filters
.
The filters structure. The supported names are file-system-id
, backup-type
, file-system-type
, and volume-id
.
sourcepub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
pub fn set_filters(self, input: Option<Vec<Filter>>) -> Self
The filters structure. The supported names are file-system-id
, backup-type
, file-system-type
, and volume-id
.
sourcepub fn get_filters(&self) -> &Option<Vec<Filter>>
pub fn get_filters(&self) -> &Option<Vec<Filter>>
The filters structure. The supported names are file-system-id
, backup-type
, file-system-type
, and volume-id
.
sourcepub fn max_results(self, input: i32) -> Self
pub fn max_results(self, input: i32) -> Self
Maximum number of backups to return in the response. 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 backups to return in the response. 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 backups to return in the response. 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
An opaque pagination token returned from a previous DescribeBackups
operation. If a token is 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
An opaque pagination token returned from a previous DescribeBackups
operation. If a token is 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>
An opaque pagination token returned from a previous DescribeBackups
operation. If a token is present, the operation continues the list from where the returning call left off.
Trait Implementations§
source§impl Clone for DescribeBackupsFluentBuilder
impl Clone for DescribeBackupsFluentBuilder
source§fn clone(&self) -> DescribeBackupsFluentBuilder
fn clone(&self) -> DescribeBackupsFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more