put_restore_validation_result ¶

put_restore_validation_result(
    restore_job_id: RestoreJobId,
    validation_status: RestoreValidationStatus,
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    validation_status_message: Optional[string] = None,
) -> None

This request allows you to send your independent self-run restore test validation results. RestoreJobId and ValidationStatus are required. Optionally, you can input a ValidationStatusMessage.

Parameters:

restore_job_id (RestoreJobId) –

This is a unique identifier of a restore job within Backup.
validation_status (RestoreValidationStatus) –

The status of your restore validation.
validation_status_message (Optional[string], default: None ) –

This is an optional message string you can input to describe the validation status for the restore test validation.

Raises:

InvalidParameterValueException –

Indicates that something is wrong with a parameter's value. For example, the value is out of range.
InvalidRequestException –

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.
MissingParameterValueException –

Indicates that a required parameter is missing.
ResourceNotFoundException –

A resource that is required for the action doesn't exist.
ServiceUnavailableException –

The request failed due to a temporary failure of the server.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_backup/_services/backup.py

def put_restore_validation_result(
    self,
    restore_job_id: "capo_backup.types.restore_job_id.RestoreJobId",
    validation_status: "capo_backup.types.restore_validation_status.RestoreValidationStatus",
    *,
    config_overrides: Optional[BackupClientConfig] = None,
    validation_status_message: Optional["capo_backup.types.string.string"] = None,
) -> None:
    """<p>This request allows you to send your independent self-run restore test validation results. <code>RestoreJobId</code> and <code>ValidationStatus</code> are required. Optionally, you can input a <code>ValidationStatusMessage</code>.</p>

    Args:
        restore_job_id: <p>This is a unique identifier of a restore job within Backup.</p>
        validation_status: <p>The status of your restore validation.</p>
        validation_status_message: <p>This is an optional message string you can input to describe the validation status for the restore test validation.</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.invalid_request_exception.InvalidRequestException: <p>Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.</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.put_restore_validation_result_input.PutRestoreValidationResultInput]",
    ) -> OperationResponse[None]:
        import capo_backup._operations.cryo_controller_user_manager.put_restore_validation_result

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutRestoreValidationResult")
    )
    input_: capo_backup.types.put_restore_validation_result_input.PutRestoreValidationResultInput = {
        "restore_job_id": restore_job_id,
        "validation_status": validation_status,
    }
    if validation_status_message is not None:
        input_["validation_status_message"] = validation_status_message

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