aws_sdk_workdocs/client/
delete_document_version.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 [`DeleteDocumentVersion`](crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`authentication_token(impl Into<String>)`](crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder::authentication_token) / [`set_authentication_token(Option<String>)`](crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder::set_authentication_token):<br>required: **false**<br><p>Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.</p><br>
7    ///   - [`document_id(impl Into<String>)`](crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder::document_id) / [`set_document_id(Option<String>)`](crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder::set_document_id):<br>required: **true**<br><p>The ID of the document associated with the version being deleted.</p><br>
8    ///   - [`version_id(impl Into<String>)`](crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder::version_id) / [`set_version_id(Option<String>)`](crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder::set_version_id):<br>required: **true**<br><p>The ID of the version being deleted.</p><br>
9    ///   - [`delete_prior_versions(bool)`](crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder::delete_prior_versions) / [`set_delete_prior_versions(Option<bool>)`](crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder::set_delete_prior_versions):<br>required: **true**<br><p>Deletes all versions of a document prior to the current version.</p><br>
10    /// - On success, responds with [`DeleteDocumentVersionOutput`](crate::operation::delete_document_version::DeleteDocumentVersionOutput)
11    /// - On failure, responds with [`SdkError<DeleteDocumentVersionError>`](crate::operation::delete_document_version::DeleteDocumentVersionError)
12    pub fn delete_document_version(&self) -> crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder {
13        crate::operation::delete_document_version::builders::DeleteDocumentVersionFluentBuilder::new(self.handle.clone())
14    }
15}