Struct aws_sdk_fsx::client::fluent_builders::DescribeSnapshots

pub struct DescribeSnapshots { /* private fields */ }

Fluent builder constructing a request to DescribeSnapshots.

Returns the description of specific Amazon FSx for OpenZFS snapshots, if a SnapshotIds value is provided. Otherwise, this operation returns all snapshots owned by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.

When retrieving all snapshots, you can optionally specify the MaxResults parameter to limit the number of snapshots 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.

Use this operation in an iterative process to retrieve a list of your snapshots. DescribeSnapshots 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 snapshot descriptions while still including a NextToken value.

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

Implementations

impl DescribeSnapshots

pub async fn send(
    self
) -> Result<DescribeSnapshotsOutput, SdkError<DescribeSnapshotsError>>

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

Create a paginator for this request

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

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

Appends an item to SnapshotIds.

To override the contents of this collection use set_snapshot_ids.

The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

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

The IDs of the snapshots that you want to retrieve. This parameter value overrides any filters. If any IDs aren't found, a SnapshotNotFound error occurs.

pub fn filters(self, input: SnapshotFilter) -> 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 or volume-id.

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

The filters structure. The supported names are file-system-id or volume-id.

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

The maximum number of resources to return in the response. This value must be an integer greater than zero.

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

The maximum number of resources to return in the response. This value must be an integer greater than zero.

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

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

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

(Optional) Opaque pagination token returned from a previous operation (String). If present, this token indicates from what point you can continue processing the request, where the previous NextToken value left off.

Trait Implementations

impl Clone for DescribeSnapshots

fn clone(&self) -> DescribeSnapshots

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeSnapshots

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

Formats the value using the given formatter.