Skip to content

get_recovery_point_index_details

get_recovery_point_index_details(
    backup_vault_name: BackupVaultName,
    recovery_point_arn: ARN,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> GetRecoveryPointIndexDetailsOutput

This operation returns the metadata and details specific to the backup index associated with the specified recovery point.

Parameters:

  • backup_vault_name (BackupVaultName) –

    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.

    Accepted characters include lowercase letters, numbers, and hyphens.

  • recovery_point_arn (ARN) –

    An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Raises:

Source code in docs_src/capo_backup/_services/backup.py
def get_recovery_point_index_details(
    self,
    backup_vault_name: "capo_backup.types.backup_vault_name.BackupVaultName",
    recovery_point_arn: "capo_backup.types.arn.ARN",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
) -> "capo_backup.types.get_recovery_point_index_details_output.GetRecoveryPointIndexDetailsOutput":
    """<p>This operation returns the metadata and details specific to the backup index associated with the specified recovery point.</p>

    Args:
        backup_vault_name: <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>
        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>

    Raises:
        capo_backup.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>Indicates that something is wrong with a parameter's value. For example, the value is out of range.</p>
        capo_backup.errors.missing_parameter_value_exception.MissingParameterValueException: <p>Indicates that a required parameter is missing.</p>
        capo_backup.errors.resource_not_found_exception.ResourceNotFoundException: <p>A resource that is required for the action doesn't exist.</p>
        capo_backup.errors.service_unavailable_exception.ServiceUnavailableException: <p>The request failed due to a temporary failure of the server.</p>
        capo_backup.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_backup.types.get_recovery_point_index_details_input.GetRecoveryPointIndexDetailsInput]",
    ) -> OperationResponse[
        "capo_backup.types.get_recovery_point_index_details_output.GetRecoveryPointIndexDetailsOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.get_recovery_point_index_details

        output, http_response = (
            capo_backup._operations.cryo_controller_user_manager.get_recovery_point_index_details.get_recovery_point_index_details(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetRecoveryPointIndexDetails")
    )
    input_: capo_backup.types.get_recovery_point_index_details_input.GetRecoveryPointIndexDetailsInput = {
        "backup_vault_name": backup_vault_name,
        "recovery_point_arn": recovery_point_arn,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output