Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkDocs.DeleteDocumentVersion

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Deletes a version of an Amazon WorkDocs document. Use the DeletePriorVersions parameter to delete prior versions.

Creating a Request

data DeleteDocumentVersion Source #

See: newDeleteDocumentVersion smart constructor.

Constructors

DeleteDocumentVersion'
Fields authenticationToken :: Maybe (Sensitive Text) Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. documentId :: Text The ID of a document. versionId :: Text The version ID of a document. deletePriorVersions :: Bool When set to `TRUE`, deletes the specified version and /all prior versions/ of a document.

Instances

Instances details

ToHeaders DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods toHeaders :: DeleteDocumentVersion -> [Header] #
ToPath DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods toPath :: DeleteDocumentVersion -> ByteString #
ToQuery DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods toQuery :: DeleteDocumentVersion -> QueryString #
AWSRequest DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Associated Types type AWSResponse DeleteDocumentVersion # Methods request :: (Service -> Service) -> DeleteDocumentVersion -> Request DeleteDocumentVersion # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteDocumentVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDocumentVersion))) #
Generic DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Associated Types type Rep DeleteDocumentVersion :: Type -> Type # Methods from :: DeleteDocumentVersion -> Rep DeleteDocumentVersion x # to :: Rep DeleteDocumentVersion x -> DeleteDocumentVersion #
Show DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods showsPrec :: Int -> DeleteDocumentVersion -> ShowS # show :: DeleteDocumentVersion -> String # showList :: [DeleteDocumentVersion] -> ShowS #
NFData DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods rnf :: DeleteDocumentVersion -> () #
Eq DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods (==) :: DeleteDocumentVersion -> DeleteDocumentVersion -> Bool # (/=) :: DeleteDocumentVersion -> DeleteDocumentVersion -> Bool #
Hashable DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods hashWithSalt :: Int -> DeleteDocumentVersion -> Int # hash :: DeleteDocumentVersion -> Int #
type AWSResponse DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion type AWSResponse DeleteDocumentVersion = DeleteDocumentVersionResponse
type Rep DeleteDocumentVersion Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion type Rep DeleteDocumentVersion = D1 ('MetaData "DeleteDocumentVersion" "Amazonka.WorkDocs.DeleteDocumentVersion" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeleteDocumentVersion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "documentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "versionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deletePriorVersions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newDeleteDocumentVersion Source #

Arguments

:: Text	`$sel:documentId:DeleteDocumentVersion'`
-> Text	`DeleteDocumentVersion`
-> Bool	`$sel:deletePriorVersions:DeleteDocumentVersion'`
-> DeleteDocumentVersion

Create a value of DeleteDocumentVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authenticationToken:DeleteDocumentVersion', deleteDocumentVersion_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:documentId:DeleteDocumentVersion', deleteDocumentVersion_documentId - The ID of a document.

DeleteDocumentVersion, deleteDocumentVersion_versionId - The version ID of a document.

$sel:deletePriorVersions:DeleteDocumentVersion', deleteDocumentVersion_deletePriorVersions - When set to TRUE, deletes the specified version and /all prior versions/ of a document.

Request Lenses

deleteDocumentVersion_authenticationToken :: Lens' DeleteDocumentVersion (Maybe Text) Source #

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

deleteDocumentVersion_documentId :: Lens' DeleteDocumentVersion Text Source #

The ID of a document.

deleteDocumentVersion_versionId :: Lens' DeleteDocumentVersion Text Source #

The version ID of a document.

deleteDocumentVersion_deletePriorVersions :: Lens' DeleteDocumentVersion Bool Source #

When set to TRUE, deletes the specified version and /all prior versions/ of a document.

Destructuring the Response

data DeleteDocumentVersionResponse Source #

See: newDeleteDocumentVersionResponse smart constructor.

Constructors

DeleteDocumentVersionResponse'

Instances

Instances details

Generic DeleteDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Associated Types type Rep DeleteDocumentVersionResponse :: Type -> Type # Methods from :: DeleteDocumentVersionResponse -> Rep DeleteDocumentVersionResponse x # to :: Rep DeleteDocumentVersionResponse x -> DeleteDocumentVersionResponse #
Read DeleteDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods readsPrec :: Int -> ReadS DeleteDocumentVersionResponse # readList :: ReadS [DeleteDocumentVersionResponse] # readPrec :: ReadPrec DeleteDocumentVersionResponse # readListPrec :: ReadPrec [DeleteDocumentVersionResponse] #
Show DeleteDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods showsPrec :: Int -> DeleteDocumentVersionResponse -> ShowS # show :: DeleteDocumentVersionResponse -> String # showList :: [DeleteDocumentVersionResponse] -> ShowS #
NFData DeleteDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods rnf :: DeleteDocumentVersionResponse -> () #
Eq DeleteDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion Methods (==) :: DeleteDocumentVersionResponse -> DeleteDocumentVersionResponse -> Bool # (/=) :: DeleteDocumentVersionResponse -> DeleteDocumentVersionResponse -> Bool #
type Rep DeleteDocumentVersionResponse Source #
Instance details Defined in Amazonka.WorkDocs.DeleteDocumentVersion type Rep DeleteDocumentVersionResponse = D1 ('MetaData "DeleteDocumentVersionResponse" "Amazonka.WorkDocs.DeleteDocumentVersion" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeleteDocumentVersionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDocumentVersionResponse :: DeleteDocumentVersionResponse Source #

Create a value of DeleteDocumentVersionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.