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.DeleteFolder

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Permanently deletes the specified folder and its contents.

Synopsis

Creating a Request

data DeleteFolder Source #

See: newDeleteFolder smart constructor.

Constructors

DeleteFolder'
Fields authenticationToken :: Maybe (Sensitive Text) Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API. folderId :: Text The ID of the folder.

Instances

Instances details

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

newDeleteFolder Source #

Arguments

:: Text	`$sel:folderId:DeleteFolder'`
-> DeleteFolder

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

$sel:folderId:DeleteFolder', deleteFolder_folderId - The ID of the folder.

Request Lenses

deleteFolder_authenticationToken :: Lens' DeleteFolder (Maybe Text) Source #

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

deleteFolder_folderId :: Lens' DeleteFolder Text Source #

The ID of the folder.

Destructuring the Response

data DeleteFolderResponse Source #

See: newDeleteFolderResponse smart constructor.

Constructors

DeleteFolderResponse'

Instances

Instances details

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

newDeleteFolderResponse :: DeleteFolderResponse Source #

Create a value of DeleteFolderResponse with all optional fields omitted.

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