aws_sdk_backup/client/
get_recovery_point_index_details.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`GetRecoveryPointIndexDetails`](crate::operation::get_recovery_point_index_details::builders::GetRecoveryPointIndexDetailsFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`backup_vault_name(impl Into<String>)`](crate::operation::get_recovery_point_index_details::builders::GetRecoveryPointIndexDetailsFluentBuilder::backup_vault_name) / [`set_backup_vault_name(Option<String>)`](crate::operation::get_recovery_point_index_details::builders::GetRecoveryPointIndexDetailsFluentBuilder::set_backup_vault_name):<br>required: **true**<br><p>The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the Region where they are created.</p> <p>Accepted characters include lowercase letters, numbers, and hyphens.</p><br>
7    ///   - [`recovery_point_arn(impl Into<String>)`](crate::operation::get_recovery_point_index_details::builders::GetRecoveryPointIndexDetailsFluentBuilder::recovery_point_arn) / [`set_recovery_point_arn(Option<String>)`](crate::operation::get_recovery_point_index_details::builders::GetRecoveryPointIndexDetailsFluentBuilder::set_recovery_point_arn):<br>required: **true**<br><p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p><br>
8    /// - On success, responds with [`GetRecoveryPointIndexDetailsOutput`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput) with field(s):
9    ///   - [`recovery_point_arn(Option<String>)`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput::recovery_point_arn): <p>An ARN that uniquely identifies a recovery point; for example, <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>
10    ///   - [`backup_vault_arn(Option<String>)`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput::backup_vault_arn): <p>An ARN that uniquely identifies the backup vault where the recovery point index is stored.</p> <p>For example, <code>arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault</code>.</p>
11    ///   - [`source_resource_arn(Option<String>)`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput::source_resource_arn): <p>A string of the Amazon Resource Name (ARN) that uniquely identifies the source resource.</p>
12    ///   - [`index_creation_date(Option<DateTime>)`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput::index_creation_date): <p>The date and time that a backup index was created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
13    ///   - [`index_deletion_date(Option<DateTime>)`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput::index_deletion_date): <p>The date and time that a backup index was deleted, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
14    ///   - [`index_completion_date(Option<DateTime>)`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput::index_completion_date): <p>The date and time that a backup index finished creation, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>
15    ///   - [`index_status(Option<IndexStatus>)`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput::index_status): <p>This is the current status for the backup index associated with the specified recovery point.</p> <p>Statuses are: <code>PENDING</code> | <code>ACTIVE</code> | <code>FAILED</code> | <code>DELETING</code></p> <p>A recovery point with an index that has the status of <code>ACTIVE</code> can be included in a search.</p>
16    ///   - [`index_status_message(Option<String>)`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput::index_status_message): <p>A detailed message explaining the status of a backup index associated with the recovery point.</p>
17    ///   - [`total_items_indexed(Option<i64>)`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsOutput::total_items_indexed): <p>Count of items within the backup index associated with the recovery point.</p>
18    /// - On failure, responds with [`SdkError<GetRecoveryPointIndexDetailsError>`](crate::operation::get_recovery_point_index_details::GetRecoveryPointIndexDetailsError)
19    pub fn get_recovery_point_index_details(
20        &self,
21    ) -> crate::operation::get_recovery_point_index_details::builders::GetRecoveryPointIndexDetailsFluentBuilder {
22        crate::operation::get_recovery_point_index_details::builders::GetRecoveryPointIndexDetailsFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_backup/client/get_recovery_point_index_details.rs

aws_sdk_backup/client/
get_recovery_point_index_details.rs
