Amazonka.WorkDocs.DeleteDocument

Permanently deletes the specified document and its associated metadata.

Creating a Request

data DeleteDocument

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

ToHeaders DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

toHeaders :: DeleteDocument -> [Header]

ToPath DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

toPath :: DeleteDocument -> ByteString

ToQuery DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

toQuery :: DeleteDocument -> QueryString

AWSRequest DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

Associated Types

type AWSResponse DeleteDocument

Methods

request :: (Service -> Service) -> DeleteDocument -> Request DeleteDocument

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteDocument -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDocument)))

Generic DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

Associated Types

type Rep DeleteDocument :: Type -> Type

Methods

from :: DeleteDocument -> Rep DeleteDocument x

to :: Rep DeleteDocument x -> DeleteDocument

Show DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

showsPrec :: Int -> DeleteDocument -> ShowS

show :: DeleteDocument -> String

showList :: [DeleteDocument] -> ShowS

NFData DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

rnf :: DeleteDocument -> ()

Eq DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

(==) :: DeleteDocument -> DeleteDocument -> Bool

(/=) :: DeleteDocument -> DeleteDocument -> Bool

Hashable DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

hashWithSalt :: Int -> DeleteDocument -> Int

hash :: DeleteDocument -> Int

type AWSResponse DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

type AWSResponse DeleteDocument = DeleteDocumentResponse

type Rep DeleteDocument

Defined in Amazonka.WorkDocs.DeleteDocument

type Rep DeleteDocument = D1 ('MetaData "DeleteDocument" "Amazonka.WorkDocs.DeleteDocument" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" '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)))

newDeleteDocument

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)

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

deleteDocument_documentId :: Lens' DeleteDocument Text

The ID of the document.

Destructuring the Response

data DeleteDocumentResponse

See: newDeleteDocumentResponse smart constructor.

Constructors

DeleteDocumentResponse'

Instances

Generic DeleteDocumentResponse

Defined in Amazonka.WorkDocs.DeleteDocument

Associated Types

type Rep DeleteDocumentResponse :: Type -> Type

Methods

from :: DeleteDocumentResponse -> Rep DeleteDocumentResponse x

to :: Rep DeleteDocumentResponse x -> DeleteDocumentResponse

Read DeleteDocumentResponse

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

readsPrec :: Int -> ReadS DeleteDocumentResponse

readList :: ReadS [DeleteDocumentResponse]

readPrec :: ReadPrec DeleteDocumentResponse

readListPrec :: ReadPrec [DeleteDocumentResponse]

Show DeleteDocumentResponse

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

showsPrec :: Int -> DeleteDocumentResponse -> ShowS

show :: DeleteDocumentResponse -> String

showList :: [DeleteDocumentResponse] -> ShowS

NFData DeleteDocumentResponse

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

rnf :: DeleteDocumentResponse -> ()

Eq DeleteDocumentResponse

Defined in Amazonka.WorkDocs.DeleteDocument

Methods

(==) :: DeleteDocumentResponse -> DeleteDocumentResponse -> Bool

(/=) :: DeleteDocumentResponse -> DeleteDocumentResponse -> Bool

type Rep DeleteDocumentResponse

Defined in Amazonka.WorkDocs.DeleteDocument

type Rep DeleteDocumentResponse = D1 ('MetaData "DeleteDocumentResponse" "Amazonka.WorkDocs.DeleteDocument" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "DeleteDocumentResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDocumentResponse :: DeleteDocumentResponse

Create a value of DeleteDocumentResponse with all optional fields omitted.

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