Skip to content

get_recovery_point_restore_metadata

get_recovery_point_restore_metadata(
    backup_vault_name: BackupVaultName,
    recovery_point_arn: ARN,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    backup_vault_account_id: Optional[AccountId] = None,
) -> GetRecoveryPointRestoreMetadataOutput

Returns a set of metadata key-value pairs that were used to create the backup.

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 Amazon Web Services Region where they are created.

  • recovery_point_arn (ARN) –

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

  • backup_vault_account_id (Optional[AccountId], default: None ) –

    The account ID of the specified backup vault.

Raises:

Source code in docs_src/capo_backup/_services/backup.py
def get_recovery_point_restore_metadata(
    self,
    backup_vault_name: "capo_backup.types.backup_vault_name.BackupVaultName",
    recovery_point_arn: "capo_backup.types.arn.ARN",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    backup_vault_account_id: Optional[
        "capo_backup.types.account_id.AccountId"
    ] = None,
) -> "capo_backup.types.get_recovery_point_restore_metadata_output.GetRecoveryPointRestoreMetadataOutput":
    """<p>Returns a set of metadata key-value pairs that were used to create the backup.</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 Amazon Web Services Region where they are created.</p>
        recovery_point_arn: <p>An Amazon Resource Name (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>
        backup_vault_account_id: <p>The account ID of the specified backup vault.</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_restore_metadata_input.GetRecoveryPointRestoreMetadataInput]",
    ) -> OperationResponse[
        "capo_backup.types.get_recovery_point_restore_metadata_output.GetRecoveryPointRestoreMetadataOutput"
    ]:
        import capo_backup._operations.cryo_controller_user_manager.get_recovery_point_restore_metadata

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

    def _redact_output(
        output: "capo_backup.types.get_recovery_point_restore_metadata_output.GetRecoveryPointRestoreMetadataOutput",
    ) -> dict[str, Any]:
        import capo_backup.types.get_recovery_point_restore_metadata_output

        return capo_backup.types.get_recovery_point_restore_metadata_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "GetRecoveryPointRestoreMetadata", redact_output=_redact_output
        ),
    )
    input_: capo_backup.types.get_recovery_point_restore_metadata_input.GetRecoveryPointRestoreMetadataInput = {
        "backup_vault_name": backup_vault_name,
        "recovery_point_arn": recovery_point_arn,
    }
    if backup_vault_account_id is not None:
        input_["backup_vault_account_id"] = backup_vault_account_id

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