Skip to content

restore_document_versions

restore_document_versions(
    document_id: ResourceIdType,
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[AuthenticationHeaderType] = None,
) -> None

Recovers a deleted version of an Amazon WorkDocs document.

Parameters:

  • authentication_token (Optional[AuthenticationHeaderType], default: None ) –

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • document_id (ResourceIdType) –

    The ID of the document.

Raises:

Source code in docs_src/capo_workdocs/_services/work_docs.py
def restore_document_versions(
    self,
    document_id: "capo_workdocs.types.resource_id_type.ResourceIdType",
    *,
    config_overrides: Optional[WorkDocsClientConfig] = None,
    authentication_token: Optional[
        "capo_workdocs.types.authentication_header_type.AuthenticationHeaderType"
    ] = None,
) -> None:
    """<p>Recovers a deleted version of an Amazon WorkDocs document.</p>

    Args:
        authentication_token: <p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p>
        document_id: <p>The ID of the document.</p>

    Raises:
        capo_workdocs.errors.concurrent_modification_exception.ConcurrentModificationException: <p>The resource hierarchy is changing.</p>
        capo_workdocs.errors.conflicting_operation_exception.ConflictingOperationException: <p>Another operation is in progress on the resource that conflicts with the current operation.</p>
        capo_workdocs.errors.entity_not_exists_exception.EntityNotExistsException: <p>The resource does not exist.</p>
        capo_workdocs.errors.failed_dependency_exception.FailedDependencyException: <p>The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.</p>
        capo_workdocs.errors.invalid_operation_exception.InvalidOperationException: <p>The operation is invalid.</p>
        capo_workdocs.errors.prohibited_state_exception.ProhibitedStateException: <p>The specified document version is not in the INITIALIZED state.</p>
        capo_workdocs.errors.unauthorized_operation_exception.UnauthorizedOperationException: <p>The operation is not permitted.</p>
        capo_workdocs.errors.unauthorized_resource_access_exception.UnauthorizedResourceAccessException: <p>The caller does not have access to perform the action on the resource.</p>
        capo_workdocs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workdocs.types.restore_document_versions_request.RestoreDocumentVersionsRequest]",
    ) -> OperationResponse[None]:
        import capo_workdocs._operations.aws_gorilla_boy_service.restore_document_versions

        output, http_response = (
            capo_workdocs._operations.aws_gorilla_boy_service.restore_document_versions.restore_document_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_workdocs.types.restore_document_versions_request.RestoreDocumentVersionsRequest",
    ) -> dict[str, Any]:
        import capo_workdocs.types.restore_document_versions_request

        return (
            capo_workdocs.types.restore_document_versions_request.redact_sensitive(
                input_
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("RestoreDocumentVersions", redact_input=_redact_input),
    )
    input_: capo_workdocs.types.restore_document_versions_request.RestoreDocumentVersionsRequest = {
        "document_id": document_id
    }
    if authentication_token is not None:
        input_["authentication_token"] = authentication_token

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