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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates the specified attributes of the specified folder. The user must have access to both the folder and its parent folder, if applicable.

Creating a Request

data UpdateFolder Source #

See: newUpdateFolder smart constructor.

Constructors

UpdateFolder'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
name :: Maybe Text
The name of the folder.
parentFolderId :: Maybe Text
The ID of the parent folder.
resourceState :: Maybe ResourceStateType
The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.
folderId :: Text
The ID of the folder.

Instances

Instances details

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

newUpdateFolder Source #

Arguments

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

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

UpdateFolder, updateFolder_name - The name of the folder.

UpdateFolder, updateFolder_parentFolderId - The ID of the parent folder.

UpdateFolder, updateFolder_resourceState - The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

$sel:folderId:UpdateFolder', updateFolder_folderId - The ID of the folder.

Request Lenses

updateFolder_authenticationToken :: Lens' UpdateFolder (Maybe Text) Source #

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

updateFolder_name :: Lens' UpdateFolder (Maybe Text) Source #

The name of the folder.

updateFolder_parentFolderId :: Lens' UpdateFolder (Maybe Text) Source #

The ID of the parent folder.

updateFolder_resourceState :: Lens' UpdateFolder (Maybe ResourceStateType) Source #

The resource state of the folder. Only ACTIVE and RECYCLED are accepted values from the API.

updateFolder_folderId :: Lens' UpdateFolder Text Source #

The ID of the folder.

Destructuring the Response

data UpdateFolderResponse Source #

See: newUpdateFolderResponse smart constructor.

Constructors

UpdateFolderResponse'

Instances

Instances details

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

newUpdateFolderResponse :: UpdateFolderResponse Source #

Create a value of UpdateFolderResponse with all optional fields omitted.

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