Network.AWS.WorkDocs.DeleteDocument

Permanently deletes the specified document and its associated metadata.

Creating a Request

deleteDocument

Arguments

:: Text

ddDocumentId

-> DeleteDocument

Creates a value of DeleteDocument with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ddAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.
• ddDocumentId - The ID of the document.

data DeleteDocument

See: deleteDocument smart constructor.

Instances

Eq DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

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

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

Data DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteDocument -> c DeleteDocument

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteDocument

toConstr :: DeleteDocument -> Constr

dataTypeOf :: DeleteDocument -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteDocument)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteDocument)

gmapT :: (forall b. Data b => b -> b) -> DeleteDocument -> DeleteDocument

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDocument -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDocument -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteDocument -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteDocument -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteDocument -> m DeleteDocument

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDocument -> m DeleteDocument

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDocument -> m DeleteDocument

Show DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

showsPrec :: Int -> DeleteDocument -> ShowS

show :: DeleteDocument -> String

showList :: [DeleteDocument] -> ShowS

Generic DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Associated Types

type Rep DeleteDocument :: Type -> Type

Methods

from :: DeleteDocument -> Rep DeleteDocument x

to :: Rep DeleteDocument x -> DeleteDocument

Hashable DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

hashWithSalt :: Int -> DeleteDocument -> Int

hash :: DeleteDocument -> Int

AWSRequest DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Associated Types

type Rs DeleteDocument :: Type

Methods

request :: DeleteDocument -> Request DeleteDocument

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy DeleteDocument -> ClientResponse -> m (Response DeleteDocument)

ToHeaders DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

toHeaders :: DeleteDocument -> [Header]

ToPath DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

toPath :: DeleteDocument -> ByteString

ToQuery DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

toQuery :: DeleteDocument -> QueryString

NFData DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

rnf :: DeleteDocument -> ()

type Rep DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

type Rep DeleteDocument = D1 (MetaData "DeleteDocument" "Network.AWS.WorkDocs.DeleteDocument" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DeleteDocument'" PrefixI True) (S1 (MetaSel (Just "_ddAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 (MetaSel (Just "_ddDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))

type Rs DeleteDocument

Defined in Network.AWS.WorkDocs.DeleteDocument

type Rs DeleteDocument = DeleteDocumentResponse

Request Lenses

ddAuthenticationToken :: Lens' DeleteDocument (Maybe Text)

Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

ddDocumentId :: Lens' DeleteDocument Text

The ID of the document.

Destructuring the Response

deleteDocumentResponse :: DeleteDocumentResponse

Creates a value of DeleteDocumentResponse with the minimum fields required to make a request.

data DeleteDocumentResponse

See: deleteDocumentResponse smart constructor.

Instances

Eq DeleteDocumentResponse

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

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

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

Data DeleteDocumentResponse

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteDocumentResponse -> c DeleteDocumentResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteDocumentResponse

toConstr :: DeleteDocumentResponse -> Constr

dataTypeOf :: DeleteDocumentResponse -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteDocumentResponse)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteDocumentResponse)

gmapT :: (forall b. Data b => b -> b) -> DeleteDocumentResponse -> DeleteDocumentResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDocumentResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDocumentResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> DeleteDocumentResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteDocumentResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteDocumentResponse -> m DeleteDocumentResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDocumentResponse -> m DeleteDocumentResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDocumentResponse -> m DeleteDocumentResponse

Read DeleteDocumentResponse

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

readsPrec :: Int -> ReadS DeleteDocumentResponse

readList :: ReadS [DeleteDocumentResponse]

readPrec :: ReadPrec DeleteDocumentResponse

readListPrec :: ReadPrec [DeleteDocumentResponse]

Show DeleteDocumentResponse

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

showsPrec :: Int -> DeleteDocumentResponse -> ShowS

show :: DeleteDocumentResponse -> String

showList :: [DeleteDocumentResponse] -> ShowS

Generic DeleteDocumentResponse

Defined in Network.AWS.WorkDocs.DeleteDocument

Associated Types

type Rep DeleteDocumentResponse :: Type -> Type

Methods

from :: DeleteDocumentResponse -> Rep DeleteDocumentResponse x

to :: Rep DeleteDocumentResponse x -> DeleteDocumentResponse

NFData DeleteDocumentResponse

Defined in Network.AWS.WorkDocs.DeleteDocument

Methods

rnf :: DeleteDocumentResponse -> ()

type Rep DeleteDocumentResponse

Defined in Network.AWS.WorkDocs.DeleteDocument

type Rep DeleteDocumentResponse = D1 (MetaData "DeleteDocumentResponse" "Network.AWS.WorkDocs.DeleteDocument" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DeleteDocumentResponse'" PrefixI False) (U1 :: Type -> Type))