Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.WorkDocs.DeleteDocument

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Permanently deletes the specified document and its associated metadata.

Creating a Request

data DeleteDocument Source #

See: newDeleteDocument smart constructor.

Constructors

DeleteDocument'
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 the document.

Instances

Instances details

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

newDeleteDocument Source #

Arguments

:: Text	`$sel:documentId:DeleteDocument'`
-> DeleteDocument

Create a value of DeleteDocument 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:DeleteDocument', deleteDocument_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:documentId:DeleteDocument', deleteDocument_documentId - The ID of the document.

Request Lenses

deleteDocument_authenticationToken :: Lens' DeleteDocument (Maybe Text) Source #

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

deleteDocument_documentId :: Lens' DeleteDocument Text Source #

The ID of the document.

Destructuring the Response

data DeleteDocumentResponse Source #

See: newDeleteDocumentResponse smart constructor.

Constructors

DeleteDocumentResponse'

Instances

Instances details

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

newDeleteDocumentResponse :: DeleteDocumentResponse Source #

Create a value of DeleteDocumentResponse with all optional fields omitted.

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