amazonka-workdocs-1.6.1: Amazon WorkDocs SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.WorkDocs.DescribeRootFolders

Contents

Description

Describes the current user's special folders; the RootFolder and the RecycleBin . RootFolder is the root of user's files and folders and RecycleBin is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

Synopsis

Creating a Request

describeRootFolders Source #

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

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

  • drfMarker - The marker for the next set of results. (You received this marker from a previous call.)
  • drfLimit - The maximum number of items to return.
  • drfAuthenticationToken - Amazon WorkDocs authentication token. Do not set this field when using administrative API actions, as in accessing the API using AWS credentials.

data DescribeRootFolders Source #

See: describeRootFolders smart constructor.

Instances
Eq DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Data DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Methods

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

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

toConstr :: DescribeRootFolders -> Constr #

dataTypeOf :: DescribeRootFolders -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeRootFolders -> DescribeRootFolders #

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

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

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

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

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

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

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

Show DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Generic DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Associated Types

type Rep DescribeRootFolders :: Type -> Type #

Hashable DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

AWSRequest DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Associated Types

type Rs DescribeRootFolders :: Type #

ToHeaders DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

ToPath DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

ToQuery DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

NFData DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Methods

rnf :: DescribeRootFolders -> () #

type Rep DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

type Rep DescribeRootFolders = D1 (MetaData "DescribeRootFolders" "Network.AWS.WorkDocs.DescribeRootFolders" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DescribeRootFolders'" PrefixI True) (S1 (MetaSel (Just "_drfMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_drfLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat)) :*: S1 (MetaSel (Just "_drfAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Sensitive Text)))))
type Rs DescribeRootFolders Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Request Lenses

drfMarker :: Lens' DescribeRootFolders (Maybe Text) Source #

The marker for the next set of results. (You received this marker from a previous call.)

drfLimit :: Lens' DescribeRootFolders (Maybe Natural) Source #

The maximum number of items to return.

drfAuthenticationToken :: Lens' DescribeRootFolders Text Source #

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

Destructuring the Response

describeRootFoldersResponse Source #

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

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

data DescribeRootFoldersResponse Source #

See: describeRootFoldersResponse smart constructor.

Instances
Eq DescribeRootFoldersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Data DescribeRootFoldersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Methods

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

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

toConstr :: DescribeRootFoldersResponse -> Constr #

dataTypeOf :: DescribeRootFoldersResponse -> DataType #

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

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

gmapT :: (forall b. Data b => b -> b) -> DescribeRootFoldersResponse -> DescribeRootFoldersResponse #

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

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

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

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

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

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

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

Read DescribeRootFoldersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Show DescribeRootFoldersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Generic DescribeRootFoldersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

Associated Types

type Rep DescribeRootFoldersResponse :: Type -> Type #

NFData DescribeRootFoldersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

type Rep DescribeRootFoldersResponse Source # 
Instance details

Defined in Network.AWS.WorkDocs.DescribeRootFolders

type Rep DescribeRootFoldersResponse = D1 (MetaData "DescribeRootFoldersResponse" "Network.AWS.WorkDocs.DescribeRootFolders" "amazonka-workdocs-1.6.1-7lORy3cdAvvAKwhZON5nxY" False) (C1 (MetaCons "DescribeRootFoldersResponse'" PrefixI True) (S1 (MetaSel (Just "_drfrsFolders") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [FolderMetadata])) :*: (S1 (MetaSel (Just "_drfrsMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_drfrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

drfrsMarker :: Lens' DescribeRootFoldersResponse (Maybe Text) Source #

The marker for the next set of results.