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 |
Retrieves the path information (the hierarchy from the root folder) for the specified folder.
By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the parent folder names.
- getFolderPath :: Text -> GetFolderPath
- data GetFolderPath
- gfpAuthenticationToken :: Lens' GetFolderPath (Maybe Text)
- gfpMarker :: Lens' GetFolderPath (Maybe Text)
- gfpLimit :: Lens' GetFolderPath (Maybe Natural)
- gfpFields :: Lens' GetFolderPath (Maybe Text)
- gfpFolderId :: Lens' GetFolderPath Text
- getFolderPathResponse :: Int -> GetFolderPathResponse
- data GetFolderPathResponse
- gfprsPath :: Lens' GetFolderPathResponse (Maybe ResourcePath)
- gfprsResponseStatus :: Lens' GetFolderPathResponse Int
Creating a Request
Creates a value of GetFolderPath
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfpAuthenticationToken
- Amazon WorkDocs authentication token. This field should not be set when using administrative API actions, as in accessing the API using AWS credentials.gfpMarker
- This value is not supported.gfpLimit
- The maximum number of levels in the hierarchy to return.gfpFields
- A comma-separated list of values. Specify NAME to include the names of the parent folders.gfpFolderId
- The ID of the folder.
data GetFolderPath Source #
See: getFolderPath
smart constructor.
Request Lenses
gfpAuthenticationToken :: Lens' GetFolderPath (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.
gfpLimit :: Lens' GetFolderPath (Maybe Natural) Source #
The maximum number of levels in the hierarchy to return.
gfpFields :: Lens' GetFolderPath (Maybe Text) Source #
A comma-separated list of values. Specify NAME to include the names of the parent folders.
gfpFolderId :: Lens' GetFolderPath Text Source #
The ID of the folder.
Destructuring the Response
getFolderPathResponse Source #
Creates a value of GetFolderPathResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gfprsPath
- The path information.gfprsResponseStatus
- -- | The response status code.
data GetFolderPathResponse Source #
See: getFolderPathResponse
smart constructor.
Response Lenses
gfprsPath :: Lens' GetFolderPathResponse (Maybe ResourcePath) Source #
The path information.
gfprsResponseStatus :: Lens' GetFolderPathResponse Int Source #
- - | The response status code.