Copyright	(c) 2013-2017 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
Language	Haskell2010

Network.AWS.WorkDocs.GetFolder

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves the metadata of the specified folder.

Synopsis

Creating a Request

getFolder Source #

Arguments

:: Text	`gfFolderId`
-> GetFolder

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

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

gfAuthenticationToken - Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.
gfIncludeCustomMetadata - Set to TRUE to include custom metadata in the response.
gfFolderId - The ID of the folder.

data GetFolder Source #

See: getFolder smart constructor.

Instances

Eq GetFolder Source #
Methods (==) :: GetFolder -> GetFolder -> Bool # (/=) :: GetFolder -> GetFolder -> Bool #
Data GetFolder Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetFolder -> c GetFolder # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetFolder # toConstr :: GetFolder -> Constr # dataTypeOf :: GetFolder -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetFolder) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetFolder) # gmapT :: (forall b. Data b => b -> b) -> GetFolder -> GetFolder # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetFolder -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetFolder -> r # gmapQ :: (forall d. Data d => d -> u) -> GetFolder -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetFolder -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetFolder -> m GetFolder # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetFolder -> m GetFolder # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetFolder -> m GetFolder #
Show GetFolder Source #
Methods showsPrec :: Int -> GetFolder -> ShowS # show :: GetFolder -> String # showList :: [GetFolder] -> ShowS #
Generic GetFolder Source #
Associated Types type Rep GetFolder :: * -> * # Methods from :: GetFolder -> Rep GetFolder x # to :: Rep GetFolder x -> GetFolder #
Hashable GetFolder Source #
Methods hashWithSalt :: Int -> GetFolder -> Int # hash :: GetFolder -> Int #
NFData GetFolder Source #
Methods rnf :: GetFolder -> () #
AWSRequest GetFolder Source #
Associated Types type Rs GetFolder :: * # Methods request :: GetFolder -> Request GetFolder # response :: MonadResource m => Logger -> Service -> Proxy * GetFolder -> ClientResponse -> m (Response GetFolder) #
ToQuery GetFolder Source #
Methods toQuery :: GetFolder -> QueryString #
ToPath GetFolder Source #
Methods toPath :: GetFolder -> ByteString #
ToHeaders GetFolder Source #
Methods toHeaders :: GetFolder -> [Header] #
type Rep GetFolder Source #
type Rep GetFolder = D1 (MetaData "GetFolder" "Network.AWS.WorkDocs.GetFolder" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "GetFolder'" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_gfAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) ((::) (S1 (MetaSel (Just Symbol "_gfIncludeCustomMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gfFolderId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs GetFolder Source #
type Rs GetFolder = GetFolderResponse

Request Lenses

gfAuthenticationToken :: Lens' GetFolder (Maybe Text) Source #

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

gfIncludeCustomMetadata :: Lens' GetFolder (Maybe Bool) Source #

Set to TRUE to include custom metadata in the response.

gfFolderId :: Lens' GetFolder Text Source #

The ID of the folder.

Destructuring the Response

getFolderResponse Source #

Arguments

:: Int	`gfrsResponseStatus`
-> GetFolderResponse

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

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

gfrsCustomMetadata - The custom metadata on the folder.
gfrsMetadata - The metadata of the folder.
gfrsResponseStatus - -- | The response status code.

data GetFolderResponse Source #

See: getFolderResponse smart constructor.

Instances

Eq GetFolderResponse Source #
Methods (==) :: GetFolderResponse -> GetFolderResponse -> Bool # (/=) :: GetFolderResponse -> GetFolderResponse -> Bool #
Data GetFolderResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetFolderResponse -> c GetFolderResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetFolderResponse # toConstr :: GetFolderResponse -> Constr # dataTypeOf :: GetFolderResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetFolderResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetFolderResponse) # gmapT :: (forall b. Data b => b -> b) -> GetFolderResponse -> GetFolderResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetFolderResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetFolderResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetFolderResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetFolderResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetFolderResponse -> m GetFolderResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetFolderResponse -> m GetFolderResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetFolderResponse -> m GetFolderResponse #
Read GetFolderResponse Source #
Methods readsPrec :: Int -> ReadS GetFolderResponse # readList :: ReadS [GetFolderResponse] # readPrec :: ReadPrec GetFolderResponse # readListPrec :: ReadPrec [GetFolderResponse] #
Show GetFolderResponse Source #
Methods showsPrec :: Int -> GetFolderResponse -> ShowS # show :: GetFolderResponse -> String # showList :: [GetFolderResponse] -> ShowS #
Generic GetFolderResponse Source #
Associated Types type Rep GetFolderResponse :: * -> * # Methods from :: GetFolderResponse -> Rep GetFolderResponse x # to :: Rep GetFolderResponse x -> GetFolderResponse #
NFData GetFolderResponse Source #
Methods rnf :: GetFolderResponse -> () #
type Rep GetFolderResponse Source #
type Rep GetFolderResponse = D1 (MetaData "GetFolderResponse" "Network.AWS.WorkDocs.GetFolder" "amazonka-workdocs-1.5.0-BQCQjzmZAyNCgdficzQnx9" False) (C1 (MetaCons "GetFolderResponse'" PrefixI True) ((::) (S1 (MetaSel (Just Symbol "_gfrsCustomMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) ((::) (S1 (MetaSel (Just Symbol "_gfrsMetadata") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FolderMetadata))) (S1 (MetaSel (Just Symbol "_gfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))))

Response Lenses

gfrsCustomMetadata :: Lens' GetFolderResponse (HashMap Text Text) Source #

The custom metadata on the folder.

gfrsMetadata :: Lens' GetFolderResponse (Maybe FolderMetadata) Source #

The metadata of the folder.

gfrsResponseStatus :: Lens' GetFolderResponse Int Source #

- | The response status code.