Network.AWS.WorkDocs.DescribeRootFolders

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.

Creating a Request

describeRootFolders

Arguments

:: Text

drfAuthenticationToken

-> DescribeRootFolders

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

See: describeRootFolders smart constructor.

Instances

Eq DescribeRootFolders

Methods

(==) :: DescribeRootFolders -> DescribeRootFolders -> Bool

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

Data 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

Methods

showsPrec :: Int -> DescribeRootFolders -> ShowS

show :: DescribeRootFolders -> String

showList :: [DescribeRootFolders] -> ShowS

Generic DescribeRootFolders

Associated Types

type Rep DescribeRootFolders :: * -> *

Methods

from :: DescribeRootFolders -> Rep DescribeRootFolders x

to :: Rep DescribeRootFolders x -> DescribeRootFolders

Hashable DescribeRootFolders

Methods

hashWithSalt :: Int -> DescribeRootFolders -> Int

hash :: DescribeRootFolders -> Int

NFData DescribeRootFolders

Methods

rnf :: DescribeRootFolders -> ()

AWSRequest DescribeRootFolders

Associated Types

type Rs DescribeRootFolders :: *

Methods

request :: DescribeRootFolders -> Request DescribeRootFolders

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

ToHeaders DescribeRootFolders

Methods

toHeaders :: DescribeRootFolders -> [Header]

ToPath DescribeRootFolders

Methods

toPath :: DescribeRootFolders -> ByteString

ToQuery DescribeRootFolders

Methods

toQuery :: DescribeRootFolders -> QueryString

type Rep DescribeRootFolders

type Rep DescribeRootFolders = D1 * (MetaData "DescribeRootFolders" "Network.AWS.WorkDocs.DescribeRootFolders" "amazonka-workdocs-1.6.0-1U8VphMWtKAbdAmu8y8qj" False) (C1 * (MetaCons "DescribeRootFolders'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_drfMarker") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_drfLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))) (S1 * (MetaSel (Just Symbol "_drfAuthenticationToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Sensitive Text))))))

type Rs DescribeRootFolders

type Rs DescribeRootFolders = DescribeRootFoldersResponse

Request Lenses

drfMarker :: Lens' DescribeRootFolders (Maybe Text)

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

drfLimit :: Lens' DescribeRootFolders (Maybe Natural)

The maximum number of items to return.

drfAuthenticationToken :: Lens' DescribeRootFolders Text

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

Arguments

:: Int

drfrsResponseStatus

-> DescribeRootFoldersResponse

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:

• drfrsFolders - The user's special folders.
• drfrsMarker - The marker for the next set of results.
• drfrsResponseStatus - -- | The response status code.

data DescribeRootFoldersResponse

See: describeRootFoldersResponse smart constructor.

Instances

Eq DescribeRootFoldersResponse

Methods

(==) :: DescribeRootFoldersResponse -> DescribeRootFoldersResponse -> Bool

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

Data DescribeRootFoldersResponse

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

Methods

readsPrec :: Int -> ReadS DescribeRootFoldersResponse

readList :: ReadS [DescribeRootFoldersResponse]

readPrec :: ReadPrec DescribeRootFoldersResponse

readListPrec :: ReadPrec [DescribeRootFoldersResponse]

Show DescribeRootFoldersResponse

Methods

showsPrec :: Int -> DescribeRootFoldersResponse -> ShowS

show :: DescribeRootFoldersResponse -> String

showList :: [DescribeRootFoldersResponse] -> ShowS

Generic DescribeRootFoldersResponse

Associated Types

type Rep DescribeRootFoldersResponse :: * -> *

Methods

from :: DescribeRootFoldersResponse -> Rep DescribeRootFoldersResponse x

to :: Rep DescribeRootFoldersResponse x -> DescribeRootFoldersResponse

NFData DescribeRootFoldersResponse

Methods

rnf :: DescribeRootFoldersResponse -> ()

type Rep DescribeRootFoldersResponse

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

Response Lenses

drfrsFolders :: Lens' DescribeRootFoldersResponse [FolderMetadata]

The user's special folders.

drfrsMarker :: Lens' DescribeRootFoldersResponse (Maybe Text)

The marker for the next set of results.

drfrsResponseStatus :: Lens' DescribeRootFoldersResponse Int

• - | The response status code.