Copyright | (c) 2013-2018 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 |
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
- describeRootFolders :: Text -> DescribeRootFolders
- data DescribeRootFolders
- drfMarker :: Lens' DescribeRootFolders (Maybe Text)
- drfLimit :: Lens' DescribeRootFolders (Maybe Natural)
- drfAuthenticationToken :: Lens' DescribeRootFolders Text
- describeRootFoldersResponse :: Int -> DescribeRootFoldersResponse
- data DescribeRootFoldersResponse
- drfrsFolders :: Lens' DescribeRootFoldersResponse [FolderMetadata]
- drfrsMarker :: Lens' DescribeRootFoldersResponse (Maybe Text)
- drfrsResponseStatus :: Lens' DescribeRootFoldersResponse Int
Creating a Request
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
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:
drfrsFolders
- The user's special folders.drfrsMarker
- The marker for the next set of results.drfrsResponseStatus
- -- | The response status code.
data DescribeRootFoldersResponse Source #
See: describeRootFoldersResponse
smart constructor.
Instances
Response Lenses
drfrsFolders :: Lens' DescribeRootFoldersResponse [FolderMetadata] Source #
The user's special folders.
drfrsMarker :: Lens' DescribeRootFoldersResponse (Maybe Text) Source #
The marker for the next set of results.
drfrsResponseStatus :: Lens' DescribeRootFoldersResponse Int Source #
- - | The response status code.