Struct aws_sdk_fsx::client::fluent_builders::DescribeBackups

pub struct DescribeBackups<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to DescribeBackups.

Returns the description of specific Amazon FSx backups, 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 NextToken from the last response.

This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action 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 action, keep the following in mind:

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

• The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

Implementations

impl<C, M, R> DescribeBackups<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<DescribeBackupsOutput, SdkError<DescribeBackupsError>> where
    R::Policy: SmithyRetryPolicy<DescribeBackupsInputOperationOutputAlias, DescribeBackupsOutput, DescribeBackupsError, DescribeBackupsInputOperationRetryAlias>, 

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 backup_ids(self, inp: impl Into<String>) -> Self

Appends an item to BackupIds.

To override the contents of this collection use set_backup_ids.

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

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

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

pub fn filters(self, inp: impl Into<Filter>) -> Self

Appends an item to Filters.

To override the contents of this collection use set_filters.

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

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

Filters structure. Supported names are file-system-id, backup-type, file-system-type, and volume-id.

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

Maximum number of backups 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 backups 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, inp: impl Into<String>) -> Self

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action 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 DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for DescribeBackups<C, M, R>

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

Formats the value using the given formatter.