Struct aws_sdk_cloudhsmv2::client::fluent_builders::DescribeBackups

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

Fluent builder constructing a request to DescribeBackups.

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

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

The NextToken value that you received in the previous response. Use this value to get more backups.

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

The NextToken value that you received in the previous response. Use this value to get more backups.

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

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

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

The maximum number of backups to return in the response. When there are more backups than the number you specify, the response contains a NextToken value.

pub fn filters(self, k: impl Into<String>, v: impl Into<Vec<String>>) -> Self

Adds a key-value pair to Filters.

To override the contents of this collection use set_filters.

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

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

One or more filters to limit the items returned in the response.

Use the backupIds filter to return only the specified backups. Specify backups by their backup identifier (ID).

Use the sourceBackupIds filter to return only the backups created from a source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion operation.

Use the clusterIds filter to return only the backups for the specified clusters. Specify clusters by their cluster identifier (ID).

Use the states filter to return only backups that match the specified state.

Use the neverExpires filter to return backups filtered by the value in the neverExpires parameter. True returns all backups exempt from the backup retention policy. False returns all backups with a backup retention policy defined at the cluster.

pub fn sort_ascending(self, inp: bool) -> Self

Designates whether or not to sort the return backups by ascending chronological order of generation.

pub fn set_sort_ascending(self, input: Option<bool>) -> Self

Designates whether or not to sort the return backups by ascending chronological order of generation.

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.